From 6b07f229e01a18a05783534655635ae09284ad1d Mon Sep 17 00:00:00 2001 From: Ed Paulosky Date: Tue, 20 Dec 2022 16:17:27 -0500 Subject: [PATCH] chore: bump models --- .../aws-models/accessanalyzer.2019-11-01.json | 2 +- .../aws-models/appflow.2020-08-23.json | 306 +- .../arc-zonal-shift.2022-10-30.json | 2 +- .../aws-models/athena.2017-05-18.json | 97 +- .../aws-models/auto-scaling.2011-01-01.json | 1040 ++-- .../aws-models/backup-gateway.2021-01-01.json | 1176 +++-- .../aws-models/batch.2016-08-10.json | 471 +- .../billingconductor.2021-07-30.json | 155 +- .../aws-models/cloudfront.2020-05-31.json | 1861 ++++--- .../aws-models/cloudtrail.2013-11-01.json | 648 +-- .../cloudwatch-logs.2014-03-28.json | 561 ++- .../aws-models/cloudwatch.2010-08-01.json | 264 +- .../aws-models/codecatalyst.2022-09-28.json | 2 +- .../aws-models/connect.2017-08-08.json | 1298 ++++- .../aws-models/connectcases.2022-10-03.json | 2 +- .../aws-models/cost-explorer.2017-10-25.json | 109 +- .../customer-profiles.2020-08-15.json | 207 +- .../aws-models/dataexchange.2017-07-25.json | 2 +- .../aws-models/datasync.2018-11-09.json | 685 +-- .../aws-models/docdb-elastic.2022-11-28.json | 2 +- .../aws-models/drs.2020-02-26.json | 2 +- .../dynamodb-streams.2012-08-10.json | 291 +- .../aws-models/dynamodb.2012-08-10.json | 569 ++- .../aws-models/ec2.2016-11-15.json | 1309 ++--- .../aws-models/ecs.2014-11-13.json | 1130 +++-- .../aws-models/efs.2015-02-01.json | 277 +- .../aws-models/eks.2017-11-01.json | 760 +-- .../aws-models/emr-serverless.2021-07-13.json | 2 +- .../aws-models/gamesparks.2021-08-17.json | 2 +- .../aws-models/glue.2017-03-31.json | 755 ++- .../aws-models/grafana.2020-08-18.json | 2 +- .../aws-models/groundstation.2019-05-23.json | 2 +- .../aws-models/guardduty.2017-11-28.json | 549 ++- .../aws-models/inspector2.2020-06-08.json | 2 +- .../aws-models/iot-roborunner.2018-05-10.json | 2 +- .../aws-models/iotfleetwise.2021-06-17.json | 29 +- .../aws-models/iottwinmaker.2021-11-29.json | 963 +++- .../aws-models/ivschat.2020-07-14.json | 2 +- .../aws-models/kendra.2019-02-03.json | 2 +- ...nesis-video-webrtc-storage.2018-05-10.json | 804 +++ .../aws-models/kinesis-video.2017-09-30.json | 1688 +++++-- .../aws-models/kinesis.2013-12-02.json | 3798 +++++++++++--- .../aws-models/kms.2014-11-01.json | 293 +- ...manager-user-subscriptions.2018-05-10.json | 2 +- .../aws-models/location.2020-11-19.json | 156 +- .../lookoutequipment.2020-12-15.json | 553 ++- .../aws-models/lookoutvision.2020-11-20.json | 553 ++- .../sdk-codegen/aws-models/m2.2021-04-28.json | 543 +- ...tplace-entitlement-service.2017-01-11.json | 2 +- .../aws-models/medialive.2017-10-14.json | 363 +- .../mediapackage-vod.2018-11-07.json | 26 +- .../aws-models/mediatailor.2018-04-23.json | 2 +- .../aws-models/mgn.2020-02-26.json | 2 +- ...ration-hub-refactor-spaces.2021-10-26.json | 40 +- .../migrationhubstrategy.2020-02-19.json | 1255 ++++- .../aws-models/networkmanager.2019-07-05.json | 1419 +++--- .../aws-models/nimble.2020-08-01.json | 2775 +++++++---- .../aws-models/oam.2022-06-10.json | 2 +- .../aws-models/omics.2022-11-28.json | 2 +- .../opensearchserverless.2021-11-01.json | 2 +- .../aws-models/pipes.2015-10-07.json | 2 +- .../privatenetworks.2021-12-03.json | 2 +- .../aws-models/proton.2020-07-20.json | 2 +- .../aws-models/rds.2014-10-31.json | 2212 +++++---- .../aws-models/redshift-data.2019-12-20.json | 132 +- .../redshift-serverless.2021-04-21.json | 2 +- .../aws-models/rekognition.2016-06-27.json | 324 +- .../aws-models/resiliencehub.2020-04-30.json | 2 +- .../resource-explorer-2.2022-07-28.json | 1057 +++- .../route-53-domains.2014-05-15.json | 4361 +++++++++++------ .../aws-models/rum.2018-05-10.json | 2 +- ...maker-featurestore-runtime.2020-07-01.json | 64 +- .../sagemaker-geospatial.2020-05-27.json | 2 +- .../sagemaker-metrics.2022-09-30.json | 852 ++++ .../aws-models/sagemaker.2017-07-24.json | 1633 +++--- .../aws-models/scheduler.2021-06-30.json | 2 +- .../aws-models/securityhub.2018-10-26.json | 2708 ++++++++-- .../aws-models/securitylake.2018-05-10.json | 2 +- .../aws-models/simspaceweaver.2022-10-28.json | 2 +- .../aws-models/ssm-incidents.2018-05-10.json | 2 +- .../aws-models/ssm-sap.2018-05-10.json | 2 +- .../aws-models/support-app.2021-08-20.json | 2 +- .../aws-models/transcribe.2017-10-26.json | 795 +-- .../aws-models/translate.2017-07-01.json | 357 +- .../aws-models/wafv2.2019-07-29.json | 635 +-- 85 files changed, 30058 insertions(+), 14918 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/kinesis-video-webrtc-storage.2018-05-10.json create mode 100644 codegen/sdk-codegen/aws-models/sagemaker-metrics.2022-09-30.json diff --git a/codegen/sdk-codegen/aws-models/accessanalyzer.2019-11-01.json b/codegen/sdk-codegen/aws-models/accessanalyzer.2019-11-01.json index 4628e7d3cf0..4c4c4c24535 100644 --- a/codegen/sdk-codegen/aws-models/accessanalyzer.2019-11-01.json +++ b/codegen/sdk-codegen/aws-models/accessanalyzer.2019-11-01.json @@ -7198,4 +7198,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json b/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json index 0335ccd2146..b4bcc0d2fd7 100644 --- a/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json +++ b/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json @@ -3650,7 +3650,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^[\\s\\w/!@#+=.-]*$" + "smithy.api#pattern": "^[\\s\\w/!@#+=,.-]*$" } }, "com.amazonaws.appflow#EntityName": { @@ -4746,6 +4746,18 @@ "traits": { "smithy.api#documentation": "

The version of the API that's used by the connector.

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

The maximum number of items that the operation returns in the response.

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

A token that was provided by your prior ListConnectorEntities operation if\n the response was too big for the page size. You specify this token to get the next page of\n results in paginated response.

" + } } } }, @@ -4758,6 +4770,12 @@ "smithy.api#documentation": "

The response of ListConnectorEntities lists entities grouped by category.\n This map's key represents the group name, and its value contains the list of entities\n belonging to that group.

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

A token that you specify in your next ListConnectorEntities operation to get\n the next page of results in paginated response. The ListConnectorEntities\n operation provides this token if the response is too big for the page size.

" + } } } }, @@ -4825,6 +4843,15 @@ } } }, + "com.amazonaws.appflow#ListEntitiesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, "com.amazonaws.appflow#ListFlows": { "type": "operation", "input": { @@ -7477,15 +7504,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -7748,9 +7766,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-south-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -7761,9 +7779,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-south-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -7774,9 +7792,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-south-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -7787,9 +7805,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-south-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -7800,9 +7818,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ca-central-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -7813,9 +7831,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ca-central-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -7826,9 +7844,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ca-central-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -7839,9 +7857,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ca-central-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -7852,9 +7870,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-central-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -7865,9 +7883,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-central-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -7878,9 +7896,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-central-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -7891,9 +7909,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-central-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -7904,9 +7922,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-west-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -7917,9 +7935,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-west-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -7930,9 +7948,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-west-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -7943,9 +7961,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-west-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -7956,9 +7974,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-west-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -7969,9 +7987,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-west-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -7982,9 +8000,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-west-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -7995,9 +8013,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-west-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8008,9 +8026,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "af-south-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8021,9 +8039,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "af-south-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8034,9 +8052,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "af-south-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8047,9 +8065,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "af-south-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8060,9 +8078,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-west-3", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8073,9 +8091,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-west-3", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8086,9 +8104,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-west-3", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8099,9 +8117,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-3", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8112,9 +8130,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-west-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8125,9 +8143,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-west-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8138,9 +8156,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-west-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8151,9 +8169,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8164,9 +8182,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-west-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8177,9 +8195,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-west-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8190,9 +8208,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-west-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8203,9 +8221,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8216,9 +8234,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-northeast-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8229,9 +8247,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-northeast-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8242,9 +8260,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-northeast-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8255,9 +8273,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-northeast-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8268,9 +8286,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-northeast-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8281,9 +8299,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-northeast-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8294,9 +8312,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-northeast-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8307,9 +8325,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-northeast-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8320,9 +8338,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "sa-east-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8333,9 +8351,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "sa-east-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8346,9 +8364,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "sa-east-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8359,9 +8377,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "sa-east-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8372,9 +8390,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-southeast-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8385,9 +8403,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-southeast-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8398,9 +8416,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-southeast-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8411,9 +8429,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-southeast-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8424,9 +8442,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-southeast-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8437,9 +8455,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-southeast-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8450,9 +8468,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-southeast-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8463,9 +8481,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-southeast-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8476,9 +8494,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-east-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8489,9 +8507,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8502,9 +8520,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-east-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8515,9 +8533,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-east-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8528,9 +8546,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-east-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -8541,9 +8559,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -8554,9 +8572,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-east-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -8567,9 +8585,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-east-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -8580,9 +8598,9 @@ } }, "params": { - "UseDualStack": false, - "Region": "us-east-1", "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -8592,9 +8610,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, - "Region": "us-east-1", "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -8604,9 +8622,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, - "Region": "us-east-1", "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/codegen/sdk-codegen/aws-models/arc-zonal-shift.2022-10-30.json b/codegen/sdk-codegen/aws-models/arc-zonal-shift.2022-10-30.json index 295cd1b01c1..0a5537ff533 100644 --- a/codegen/sdk-codegen/aws-models/arc-zonal-shift.2022-10-30.json +++ b/codegen/sdk-codegen/aws-models/arc-zonal-shift.2022-10-30.json @@ -1682,4 +1682,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/athena.2017-05-18.json b/codegen/sdk-codegen/aws-models/athena.2017-05-18.json index afc87996797..9bf148699f6 100644 --- a/codegen/sdk-codegen/aws-models/athena.2017-05-18.json +++ b/codegen/sdk-codegen/aws-models/athena.2017-05-18.json @@ -250,14 +250,14 @@ "name": "athena" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Athena is an interactive query service that lets you use standard SQL\n to analyze data directly in Amazon S3. You can point Athena at your\n data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay\n only for the queries you run. Athena scales automatically—executing queries\n in parallel—so results are fast, even with large datasets and complex queries. For more\n information, see What is Amazon Athena in the Amazon Athena User\n Guide.

\n

If you connect to Athena using the JDBC driver, use version 1.1.0 of the\n driver or later with the Amazon Athena API. Earlier version drivers do not\n support the API. For more information and to download the driver, see Accessing\n Amazon Athena with JDBC.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Amazon Athena is an interactive query service that lets you use standard SQL\n to analyze data directly in Amazon S3. You can point Athena at your\n data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay\n only for the queries you run. Athena scales automatically—executing queries\n in parallel—so results are fast, even with large datasets and complex queries. For more\n information, see What is Amazon Athena in the Amazon Athena User\n Guide.

\n

If you connect to Athena using the JDBC driver, use version 1.1.0 of the\n driver or later with the Amazon Athena API. Earlier version drivers do not\n support the API. For more information and to download the driver, see Accessing\n Amazon Athena with JDBC.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#title": "Amazon Athena", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -306,15 +306,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -2101,7 +2092,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 - Other

" + "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": { @@ -2480,7 +2471,7 @@ "State": { "target": "com.amazonaws.athena#CalculationExecutionState", "traits": { - "smithy.api#documentation": "

The state of the calculation execution. A description of each state follows.

\n

\n CREATING - The calculation is in the process of being created.

\n

\n CREATED - The calculation has been created and is ready to run.

\n

\n QUEUED - The calculation has been queued for processing.

\n

\n RUNNING - The calculation is running.

\n

\n CANCELING - A request to cancel the calculation has been received and the\n system is working to stop it.

\n

\n CANCELED - The calculation is no longer running as the result of a cancel\n request.

\n

\n COMPLETED - The calculation has completed without error.

\n

\n FAILED - The calculation failed and is no longer running.

" + "smithy.api#documentation": "

The state of the calculation execution. A description of each state follows.

\n

\n CREATING - The calculation is in the process of being created.

\n

\n CREATED - The calculation has been created and is ready to run.

\n

\n QUEUED - The calculation has been queued for processing.

\n

\n RUNNING - The calculation is running.

\n

\n CANCELING - A request to cancel the calculation has been received and the\n system is working to stop it.

\n

\n CANCELED - The calculation is no longer running as the result of a cancel\n request.

\n

\n COMPLETED - The calculation has completed without error.

\n

\n FAILED - The calculation failed and is no longer running.

" } }, "StateChangeReason": { @@ -2762,7 +2753,7 @@ "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type.

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

Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type.

\n " } }, "Tags": { @@ -2794,7 +2785,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -2831,7 +2822,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another CreateNamedQuery request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another CreateNamedQuery request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

\n ", "smithy.api#idempotencyToken": {} } }, @@ -2897,7 +2888,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the notebook is\n idempotent (executes only once).

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not\n using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to create the notebook is\n idempotent (executes only once).

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not\n using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

\n " } } } @@ -3125,7 +3116,7 @@ "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.

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

Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.

\n " } } }, @@ -3304,7 +3295,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the named query if you have access to the workgroup in which the query was\n saved.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Deletes the named query if you have access to the workgroup in which the query was\n saved.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -3468,7 +3459,7 @@ "EncryptionOption": { "target": "com.amazonaws.athena#EncryptionOption", "traits": { - "smithy.api#documentation": "

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys\n (SSE_KMS), or client-side encryption with KMS-managed keys\n (CSE_KMS) is used.

\n

If a query runs in a workgroup and the workgroup overrides client-side settings, then\n the workgroup's setting for encryption is used. It specifies whether query results must\n be encrypted, for all queries that run in this workgroup.

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

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side encryption with KMS-managed keys\n (SSE_KMS), or client-side encryption with KMS-managed keys\n (CSE_KMS) is used.

\n

If a query runs in a workgroup and the workgroup overrides client-side settings, then\n the workgroup's setting for encryption is used. It specifies whether query results must\n be encrypted, for all queries that run in this workgroup.

", "smithy.api#required": {} } }, @@ -3730,7 +3721,7 @@ "ExecutorState": { "target": "com.amazonaws.athena#ExecutorState", "traits": { - "smithy.api#documentation": "

The processing state of the executor. A description of each state follows.

\n

\n CREATING - The executor is being started, including acquiring\n resources.

\n

\n CREATED - The executor has been started.

\n

\n REGISTERED - The executor has been registered.

\n

\n TERMINATING - The executor is in the process of shutting down.

\n

\n TERMINATED - The executor is no longer running.

\n

\n FAILED - Due to a failure, the executor is no longer running.

" + "smithy.api#documentation": "

The processing state of the executor. A description of each state follows.

\n

\n CREATING - The executor is being started, including acquiring\n resources.

\n

\n CREATED - The executor has been started.

\n

\n REGISTERED - The executor has been registered.

\n

\n TERMINATING - The executor is in the process of shutting down.

\n

\n TERMINATED - The executor is no longer running.

\n

\n FAILED - Due to a failure, the executor is no longer running.

" } }, "ExecutorSize": { @@ -3860,6 +3851,9 @@ { "target": "com.amazonaws.athena#InternalServerException" }, + { + "target": "com.amazonaws.athena#InvalidRequestException" + }, { "target": "com.amazonaws.athena#ResourceNotFoundException" } @@ -4303,7 +4297,7 @@ } ], "traits": { - "smithy.api#documentation": "

Streams the results of a single query execution specified by\n QueryExecutionId from the Athena query results location in\n Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query\n but returns results. Use StartQueryExecution to run a query.

\n

To stream query results successfully, the IAM principal with permission to call\n GetQueryResults also must have permissions to the Amazon S3\n GetObject action for the Athena query results location.

\n \n

IAM principals with permission to the Amazon S3\n GetObject action for the query results location are able to retrieve\n query results from Amazon S3 even if permission to the\n GetQueryResults action is denied. To restrict user or role access,\n ensure that Amazon S3 permissions to the Athena query location\n are denied.

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

Streams the results of a single query execution specified by\n QueryExecutionId from the Athena query results location in\n Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query\n but returns results. Use StartQueryExecution to run a query.

\n

To stream query results successfully, the IAM principal with permission to call\n GetQueryResults also must have permissions to the Amazon S3\n GetObject action for the Athena query results location.

\n \n

IAM principals with permission to the Amazon S3\n GetObject action for the query results location are able to retrieve\n query results from Amazon S3 even if permission to the\n GetQueryResults action is denied. To restrict user or role access,\n ensure that Amazon S3 permissions to the Athena query location\n are denied.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4375,7 +4369,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns query execution runtime statistics related to a single execution of a query if\n you have access to the workgroup in which the query ran. The query execution runtime\n statistics is returned only when QueryExecutionStatus$State is in a\n SUCCEEDED or FAILED state.

" + "smithy.api#documentation": "

Returns query execution runtime statistics related to a single execution of a query if\n you have access to the workgroup in which the query ran. Query execution runtime\n statistics are returned only when QueryExecutionStatus$State is in a\n SUCCEEDED or FAILED state. Stage-level input and output row count and data size\n statistics are not shown when a query has row-level filters defined in Lake\n Formation.

" } }, "com.amazonaws.athena#GetQueryRuntimeStatisticsInput": { @@ -4716,7 +4710,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to import the notebook is\n idempotent (executes only once).

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not\n using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to import the notebook is\n idempotent (executes only once).

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not\n using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

\n " } } } @@ -4888,7 +4882,7 @@ "StateFilter": { "target": "com.amazonaws.athena#CalculationExecutionState", "traits": { - "smithy.api#documentation": "

A filter for a specific calculation execution state. A description of each state\n follows.

\n

\n CREATING - The calculation is in the process of being created.

\n

\n CREATED - The calculation has been created and is ready to run.

\n

\n QUEUED - The calculation has been queued for processing.

\n

\n RUNNING - The calculation is running.

\n

\n CANCELING - A request to cancel the calculation has been received and the\n system is working to stop it.

\n

\n CANCELED - The calculation is no longer running as the result of a cancel\n request.

\n

\n COMPLETED - The calculation has completed without error.

\n

\n FAILED - The calculation failed and is no longer running.

" + "smithy.api#documentation": "

A filter for a specific calculation execution state. A description of each state\n follows.

\n

\n CREATING - The calculation is in the process of being created.

\n

\n CREATED - The calculation has been created and is ready to run.

\n

\n QUEUED - The calculation has been queued for processing.

\n

\n RUNNING - The calculation is running.

\n

\n CANCELING - A request to cancel the calculation has been received and the\n system is working to stop it.

\n

\n CANCELED - The calculation is no longer running as the result of a cancel\n request.

\n

\n COMPLETED - The calculation has completed without error.

\n

\n FAILED - The calculation failed and is no longer running.

" } }, "MaxResults": { @@ -5152,7 +5146,7 @@ "ExecutorStateFilter": { "target": "com.amazonaws.athena#ExecutorState", "traits": { - "smithy.api#documentation": "

A filter for a specific executor state. A description of each state follows.

\n

\n CREATING - The executor is being started, including acquiring\n resources.

\n

\n CREATED - The executor has been started.

\n

\n REGISTERED - The executor has been registered.

\n

\n TERMINATING - The executor is in the process of shutting down.

\n

\n TERMINATED - The executor is no longer running.

\n

\n FAILED - Due to a failure, the executor is no longer running.

" + "smithy.api#documentation": "

A filter for a specific executor state. A description of each state follows.

\n

\n CREATING - The executor is being started, including acquiring\n resources.

\n

\n CREATED - The executor has been started.

\n

\n REGISTERED - The executor has been registered.

\n

\n TERMINATING - The executor is in the process of shutting down.

\n

\n TERMINATED - The executor is no longer running.

\n

\n FAILED - Due to a failure, the executor is no longer running.

" } }, "MaxResults": { @@ -5210,7 +5204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of available query IDs only for queries saved in the specified\n workgroup. Requires that you have access to the specified workgroup. If a workgroup is\n not specified, lists the saved queries for the primary workgroup.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Provides a list of available query IDs only for queries saved in the specified\n workgroup. Requires that you have access to the specified workgroup. If a workgroup is\n not specified, lists the saved queries for the primary workgroup.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5476,7 +5470,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of available query execution IDs for the queries in the specified\n workgroup. If a workgroup is not specified, returns a list of query execution IDs for\n the primary workgroup. Requires you to have access to the workgroup in which the queries\n ran.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Provides a list of available query execution IDs for the queries in the specified\n workgroup. If a workgroup is not specified, returns a list of query execution IDs for\n the primary workgroup. Requires you to have access to the workgroup in which the queries\n ran.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5565,7 +5559,7 @@ "StateFilter": { "target": "com.amazonaws.athena#SessionState", "traits": { - "smithy.api#documentation": "

A filter for a specific session state. A description of each state follows.

\n

\n CREATING - The session is being started, including acquiring\n resources.

\n

\n CREATED - The session has been started.

\n

\n IDLE - The session is able to accept a calculation.

\n

\n BUSY - The session is processing another task and is unable to accept a\n calculation.

\n

\n TERMINATING - The session is in the process of shutting down.

\n

\n TERMINATED - The session and its resources are no longer running.

\n

\n DEGRADED - The session has no healthy coordinators.

\n

\n FAILED - Due to a failure, the session and its resources are no longer\n running.

" + "smithy.api#documentation": "

A filter for a specific session state. A description of each state follows.

\n

\n CREATING - The session is being started, including acquiring\n resources.

\n

\n CREATED - The session has been started.

\n

\n IDLE - The session is able to accept a calculation.

\n

\n BUSY - The session is processing another task and is unable to accept a\n calculation.

\n

\n TERMINATING - The session is in the process of shutting down.

\n

\n TERMINATED - The session and its resources are no longer running.

\n

\n DEGRADED - The session has no healthy coordinators.

\n

\n FAILED - Due to a failure, the session and its resources are no longer\n running.

" } }, "MaxResults": { @@ -6200,7 +6194,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 15728640 + "max": 10485760 } } }, @@ -6505,7 +6499,7 @@ "State": { "target": "com.amazonaws.athena#QueryExecutionState", "traits": { - "smithy.api#documentation": "

The state of query execution. QUEUED indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as\n resources are available. RUNNING indicates that the query is in execution\n phase. SUCCEEDED indicates that the query completed without errors.\n FAILED indicates that the query experienced an error and did not\n complete processing. CANCELLED indicates that a user input interrupted\n query execution.

\n \n

Athena automatically retries your queries in cases of certain\n transient errors. As a result, you may see the query state transition from\n RUNNING or FAILED to QUEUED.

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

The state of query execution. QUEUED indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as\n resources are available. RUNNING indicates that the query is in execution\n phase. SUCCEEDED indicates that the query completed without errors.\n FAILED indicates that the query experienced an error and did not\n complete processing. CANCELLED indicates that a user input interrupted\n query execution.

\n \n

Athena automatically retries your queries in cases of certain\n transient errors. As a result, you may see the query state transition from\n RUNNING or FAILED to QUEUED.

\n " } }, "StateChangeReason": { @@ -6778,7 +6772,7 @@ "ExpectedBucketOwner": { "target": "com.amazonaws.athena#AwsAccountId", "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.

" + "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": { @@ -6822,7 +6816,7 @@ "ExpectedBucketOwner": { "target": "com.amazonaws.athena#AwsAccountId", "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

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

" + "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

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

" } }, "RemoveExpectedBucketOwner": { @@ -7153,7 +7147,7 @@ "State": { "target": "com.amazonaws.athena#SessionState", "traits": { - "smithy.api#documentation": "

The state of the session. A description of each state follows.

\n

\n CREATING - The session is being started, including acquiring\n resources.

\n

\n CREATED - The session has been started.

\n

\n IDLE - The session is able to accept a calculation.

\n

\n BUSY - The session is processing another task and is unable to accept a\n calculation.

\n

\n TERMINATING - The session is in the process of shutting down.

\n

\n TERMINATED - The session and its resources are no longer running.

\n

\n DEGRADED - The session has no healthy coordinators.

\n

\n FAILED - Due to a failure, the session and its resources are no longer\n running.

" + "smithy.api#documentation": "

The state of the session. A description of each state follows.

\n

\n CREATING - The session is being started, including acquiring\n resources.

\n

\n CREATED - The session has been started.

\n

\n IDLE - The session is able to accept a calculation.

\n

\n BUSY - The session is processing another task and is unable to accept a\n calculation.

\n

\n TERMINATING - The session is in the process of shutting down.

\n

\n TERMINATED - The session and its resources are no longer running.

\n

\n DEGRADED - The session has no healthy coordinators.

\n

\n FAILED - Due to a failure, the session and its resources are no longer\n running.

" } }, "StateChangeReason": { @@ -7274,7 +7268,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the calculation is\n idempotent (executes only once). If another\n StartCalculationExecutionRequest is received, the same response is\n returned and another calculation is not created. If a parameter has changed, an error is\n returned.

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to create the calculation is\n idempotent (executes only once). If another\n StartCalculationExecutionRequest is received, the same response is\n returned and another calculation is not created. If a parameter has changed, an error is\n returned.

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

\n " } } } @@ -7291,7 +7285,7 @@ "State": { "target": "com.amazonaws.athena#CalculationExecutionState", "traits": { - "smithy.api#documentation": "

\n CREATING - The calculation is in the process of being created.

\n

\n CREATED - The calculation has been created and is ready to run.

\n

\n QUEUED - The calculation has been queued for processing.

\n

\n RUNNING - The calculation is running.

\n

\n CANCELING - A request to cancel the calculation has been received and the\n system is working to stop it.

\n

\n CANCELED - The calculation is no longer running as the result of a cancel\n request.

\n

\n COMPLETED - The calculation has completed without error.

\n

\n FAILED - The calculation failed and is no longer running.

" + "smithy.api#documentation": "

\n CREATING - The calculation is in the process of being created.

\n

\n CREATED - The calculation has been created and is ready to run.

\n

\n QUEUED - The calculation has been queued for processing.

\n

\n RUNNING - The calculation is running.

\n

\n CANCELING - A request to cancel the calculation has been received and the\n system is working to stop it.

\n

\n CANCELED - The calculation is no longer running as the result of a cancel\n request.

\n

\n COMPLETED - The calculation has completed without error.

\n

\n FAILED - The calculation failed and is no longer running.

" } } } @@ -7333,7 +7327,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another StartQueryExecution request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another StartQueryExecution request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

\n ", "smithy.api#idempotencyToken": {} } }, @@ -7447,7 +7441,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the session is\n idempotent (executes only once). If another StartSessionRequest is\n received, the same response is returned and another session is not created. If a\n parameter has changed, an error is returned.

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to create the session is\n idempotent (executes only once). If another StartSessionRequest is\n received, the same response is returned and another session is not created. If a\n parameter has changed, an error is returned.

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

\n " } } } @@ -7464,7 +7458,7 @@ "State": { "target": "com.amazonaws.athena#SessionState", "traits": { - "smithy.api#documentation": "

The state of the session. A description of each state follows.

\n

\n CREATING - The session is being started, including acquiring\n resources.

\n

\n CREATED - The session has been started.

\n

\n IDLE - The session is able to accept a calculation.

\n

\n BUSY - The session is processing another task and is unable to accept a\n calculation.

\n

\n TERMINATING - The session is in the process of shutting down.

\n

\n TERMINATED - The session and its resources are no longer running.

\n

\n DEGRADED - The session has no healthy coordinators.

\n

\n FAILED - Due to a failure, the session and its resources are no longer\n running.

" + "smithy.api#documentation": "

The state of the session. A description of each state follows.

\n

\n CREATING - The session is being started, including acquiring\n resources.

\n

\n CREATED - The session has been started.

\n

\n IDLE - The session is able to accept a calculation.

\n

\n BUSY - The session is processing another task and is unable to accept a\n calculation.

\n

\n TERMINATING - The session is in the process of shutting down.

\n

\n TERMINATED - The session and its resources are no longer running.

\n

\n DEGRADED - The session has no healthy coordinators.

\n

\n FAILED - Due to a failure, the session and its resources are no longer\n running.

" } } } @@ -7514,12 +7508,15 @@ { "target": "com.amazonaws.athena#InternalServerException" }, + { + "target": "com.amazonaws.athena#InvalidRequestException" + }, { "target": "com.amazonaws.athena#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "

Requests the cancellation of a calculation. A StopCalculationExecution\n call on a calculation that is already in a terminal state (for example,\n STOPPED, FAILED, or COMPLETED) succeeds but\n has no effect.

\n \n

Cancelling a calculation is done on a best effort basis. If a calculation cannot\n be cancelled, you can be charged for its completion. If you are concerned about\n being charged for a calculation that cannot be cancelled, consider terminating the\n session in which the calculation is running.

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

Requests the cancellation of a calculation. A StopCalculationExecution\n call on a calculation that is already in a terminal state (for example,\n STOPPED, FAILED, or COMPLETED) succeeds but\n has no effect.

\n \n

Cancelling a calculation is done on a best effort basis. If a calculation cannot\n be cancelled, you can be charged for its completion. If you are concerned about\n being charged for a calculation that cannot be cancelled, consider terminating the\n session in which the calculation is running.

\n " } }, "com.amazonaws.athena#StopCalculationExecutionRequest": { @@ -7540,7 +7537,7 @@ "State": { "target": "com.amazonaws.athena#CalculationExecutionState", "traits": { - "smithy.api#documentation": "

\n CREATING - The calculation is in the process of being created.

\n

\n CREATED - The calculation has been created and is ready to run.

\n

\n QUEUED - The calculation has been queued for processing.

\n

\n RUNNING - The calculation is running.

\n

\n CANCELING - A request to cancel the calculation has been received and the\n system is working to stop it.

\n

\n CANCELED - The calculation is no longer running as the result of a cancel\n request.

\n

\n COMPLETED - The calculation has completed without error.

\n

\n FAILED - The calculation failed and is no longer running.

" + "smithy.api#documentation": "

\n CREATING - The calculation is in the process of being created.

\n

\n CREATED - The calculation has been created and is ready to run.

\n

\n QUEUED - The calculation has been queued for processing.

\n

\n RUNNING - The calculation is running.

\n

\n CANCELING - A request to cancel the calculation has been received and the\n system is working to stop it.

\n

\n CANCELED - The calculation is no longer running as the result of a cancel\n request.

\n

\n COMPLETED - The calculation has completed without error.

\n

\n FAILED - The calculation failed and is no longer running.

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

Stops a query execution. Requires you to have access to the workgroup in which the\n query ran.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Stops a query execution. Requires you to have access to the workgroup in which the\n query ran.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -7801,7 +7798,7 @@ "State": { "target": "com.amazonaws.athena#SessionState", "traits": { - "smithy.api#documentation": "

The state of the session. A description of each state follows.

\n

\n CREATING - The session is being started, including acquiring\n resources.

\n

\n CREATED - The session has been started.

\n

\n IDLE - The session is able to accept a calculation.

\n

\n BUSY - The session is processing another task and is unable to accept a\n calculation.

\n

\n TERMINATING - The session is in the process of shutting down.

\n

\n TERMINATED - The session and its resources are no longer running.

\n

\n DEGRADED - The session has no healthy coordinators.

\n

\n FAILED - Due to a failure, the session and its resources are no longer\n running.

" + "smithy.api#documentation": "

The state of the session. A description of each state follows.

\n

\n CREATING - The session is being started, including acquiring\n resources.

\n

\n CREATED - The session has been started.

\n

\n IDLE - The session is able to accept a calculation.

\n

\n BUSY - The session is processing another task and is unable to accept a\n calculation.

\n

\n TERMINATING - The session is in the process of shutting down.

\n

\n TERMINATED - The session and its resources are no longer running.

\n

\n DEGRADED - The session has no healthy coordinators.

\n

\n FAILED - Due to a failure, the session and its resources are no longer\n running.

" } } } @@ -7907,7 +7904,7 @@ "ErrorMessage": { "target": "com.amazonaws.athena#ErrorMessage", "traits": { - "smithy.api#documentation": "

The error message containing the reason why the prepared statement could not be\n returned. The following error messages are possible:

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

The error message containing the reason why the prepared statement could not be\n returned. The following error messages are possible:

\n " } } }, @@ -8045,7 +8042,7 @@ "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

Specifies the Lambda function or functions to use for updating the data\n catalog. This is a mapping whose values depend on the catalog type.

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

Specifies the Lambda function or functions to use for updating the data\n catalog. This is a mapping whose values depend on the catalog type.

\n " } } } @@ -8147,13 +8144,15 @@ "Payload": { "target": "com.amazonaws.athena#Payload", "traits": { - "smithy.api#documentation": "

The updated content for the notebook.

" + "smithy.api#documentation": "

The updated content for the notebook.

", + "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.athena#NotebookType", "traits": { - "smithy.api#documentation": "

The notebook content type. Currently, the only valid type is\n IPYNB.

" + "smithy.api#documentation": "

The notebook content type. Currently, the only valid type is\n IPYNB.

", + "smithy.api#required": {} } }, "SessionId": { @@ -8165,7 +8164,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the notebook is\n idempotent (executes only once).

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not\n using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to create the notebook is\n idempotent (executes only once).

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not\n using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

\n " } } } @@ -8206,7 +8205,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the notebook is\n idempotent (executes only once).

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not\n using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

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

A unique case-sensitive string used to ensure the request to create the notebook is\n idempotent (executes only once).

\n \n

This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not\n using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.

\n " } }, "Name": { diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json index bffcd7bdfa1..6f64d9caec9 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json @@ -448,7 +448,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches one or more EC2 instances to the specified Auto Scaling group.

\n

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.

\n

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.

\n

For more information, see Attach EC2 instances to\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Attaches one or more EC2 instances to the specified Auto Scaling group.

\n

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.

\n

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.

\n

For more information, see Attach EC2 instances to\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

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

Attaches one or more target groups to the specified Auto Scaling group.

\n

This operation is used with the following load balancer types:

\n \n

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

\n

This operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Attaches one or more target groups to the specified Auto Scaling group.

\n

This operation is used with the following load balancer types:

\n \n

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

\n

This operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { @@ -506,7 +506,7 @@ "TargetGroupARNs": { "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.

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

The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target\n groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.

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

To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.

\n \n

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.

\n

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.

\n

This operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.

\n \n

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.

\n

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.

\n

This operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { @@ -555,6 +555,49 @@ } } }, + "com.amazonaws.autoscaling#AttachTrafficSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#AttachTrafficSourcesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#AttachTrafficSourcesResultType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

\n Reserved for use with Amazon VPC Lattice, which is in preview and subject to change. \n Do not use this API for production workloads. This API is also subject to change.\n

\n

Attaches one or more traffic sources to the specified Auto Scaling group.

\n

To describe the traffic sources for an Auto Scaling group, call the DescribeTrafficSources API. To detach a traffic source from the Auto Scaling\n group, call the DetachTrafficSources API.

\n

This operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.

" + } + }, + "com.amazonaws.autoscaling#AttachTrafficSourcesResultType": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#AttachTrafficSourcesType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

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

The unique identifiers of one or more traffic sources. You can specify up to 10\n traffic sources.

\n

Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice\n target group. Amazon EC2 Auto Scaling registers the running instances with the attached target groups.\n The target groups receive incoming traffic and route requests to one or more registered\n targets.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.autoscaling#AutoScalingGroup": { "type": "structure", "members": { @@ -645,7 +688,7 @@ "HealthCheckType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The service to use for the health checks. The valid values are EC2 and\n ELB. If you configure an Auto Scaling group to use ELB health\n checks, it considers the instance unhealthy if it fails either the EC2 status checks or\n the load balancer health checks.

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

Determines whether any additional health checks are performed on the instances in this\n group. Amazon EC2 health checks are always on.

\n

The valid values are EC2 (default), ELB, and\n VPC_LATTICE. The VPC_LATTICE health check type is reserved\n for use with VPC Lattice, which is in preview release and is subject to change.

", "smithy.api#required": {} } }, @@ -725,7 +768,7 @@ "MaxInstanceLifetime": { "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service.

\n

Valid Range: Minimum value of 0.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service.

\n

Valid Range: Minimum value of 0.

" } }, "CapacityRebalance": { @@ -763,6 +806,12 @@ "traits": { "smithy.api#documentation": "

The duration of the default instance warmup, in seconds.

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

The unique identifiers of the traffic sources.

" + } } }, "traits": { @@ -790,7 +839,7 @@ "AutoScalingGroupNames": { "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", "traits": { - "smithy.api#documentation": "

The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the MaxRecords property.

\n

If you omit this property, all Auto Scaling groups are described.

" + "smithy.api#documentation": "

The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the MaxRecords property.

\n

If you omit this property, all Auto Scaling groups are described.

" } }, "NextToken": { @@ -882,7 +931,7 @@ "LifecycleState": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The lifecycle state for the instance. The Quarantined state is not used.\n For information about lifecycle states, see Instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminated | Detaching\n | Detached | EnteringStandby | Standby |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running\n

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

The lifecycle state for the instance. The Quarantined state is not used.\n For information about lifecycle states, see Instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminated | Detaching\n | Detached | EnteringStandby | Standby |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running\n

", "smithy.api#required": {} } }, @@ -915,7 +964,7 @@ "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" + "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" } } }, @@ -965,6 +1014,9 @@ { "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroups" }, + { + "target": "com.amazonaws.autoscaling#AttachTrafficSources" + }, { "target": "com.amazonaws.autoscaling#BatchDeleteScheduledAction" }, @@ -1067,6 +1119,9 @@ { "target": "com.amazonaws.autoscaling#DescribeTerminationPolicyTypes" }, + { + "target": "com.amazonaws.autoscaling#DescribeTrafficSources" + }, { "target": "com.amazonaws.autoscaling#DescribeWarmPool" }, @@ -1079,6 +1134,9 @@ { "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroups" }, + { + "target": "com.amazonaws.autoscaling#DetachTrafficSources" + }, { "target": "com.amazonaws.autoscaling#DisableMetricsCollection" }, @@ -1152,7 +1210,7 @@ "name": "autoscaling" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon EC2 Auto Scaling\n\n \n \n \n \n \n \n \n \n \n \n\n \n

Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.

\n

For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.

", + "smithy.api#documentation": "Amazon EC2 Auto Scaling\n

Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.

\n

For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.

", "smithy.api#title": "Auto Scaling", "smithy.api#xmlNamespace": { "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/" @@ -1162,7 +1220,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -1211,15 +1269,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -1507,8 +1556,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-2" } }, @@ -1520,8 +1569,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-2" } }, @@ -1533,8 +1582,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-2" } }, @@ -1546,8 +1595,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-2" } }, @@ -1559,8 +1608,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -1572,8 +1621,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -1585,8 +1634,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -1598,8 +1647,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -1611,8 +1660,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-south-1" } }, @@ -1624,8 +1673,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-south-1" } }, @@ -1637,8 +1686,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-south-1" } }, @@ -1650,8 +1699,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-1" } }, @@ -1663,8 +1712,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-south-2" } }, @@ -1676,8 +1725,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-south-2" } }, @@ -1689,8 +1738,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-south-2" } }, @@ -1702,8 +1751,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-2" } }, @@ -1715,8 +1764,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-east-1" } }, @@ -1728,8 +1777,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-east-1" } }, @@ -1741,8 +1790,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-east-1" } }, @@ -1754,8 +1803,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-east-1" } }, @@ -1767,8 +1816,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "me-central-1" } }, @@ -1780,8 +1829,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "me-central-1" } }, @@ -1793,8 +1842,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "me-central-1" } }, @@ -1806,8 +1855,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "me-central-1" } }, @@ -1819,8 +1868,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -1832,8 +1881,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -1845,8 +1894,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -1858,8 +1907,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -1871,8 +1920,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -1884,8 +1933,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -1897,8 +1946,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -1910,8 +1959,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -1921,8 +1970,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-west-1" } }, @@ -1934,8 +1983,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-west-1" } }, @@ -1945,8 +1994,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-west-1" } }, @@ -1958,8 +2007,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-west-1" } }, @@ -1971,8 +2020,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-2" } }, @@ -1984,8 +2033,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-2" } }, @@ -1997,8 +2046,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-2" } }, @@ -2010,8 +2059,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-2" } }, @@ -2023,8 +2072,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-1" } }, @@ -2036,8 +2085,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -2049,8 +2098,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-1" } }, @@ -2062,8 +2111,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -2075,8 +2124,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -2088,8 +2137,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -2101,8 +2150,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -2114,8 +2163,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -2127,8 +2176,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "af-south-1" } }, @@ -2140,8 +2189,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -2153,8 +2202,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "af-south-1" } }, @@ -2166,8 +2215,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -2179,8 +2228,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-north-1" } }, @@ -2192,8 +2241,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-north-1" } }, @@ -2205,8 +2254,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-north-1" } }, @@ -2218,8 +2267,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-north-1" } }, @@ -2231,8 +2280,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-3" } }, @@ -2244,8 +2293,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-3" } }, @@ -2257,8 +2306,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-3" } }, @@ -2270,8 +2319,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-3" } }, @@ -2283,8 +2332,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -2296,8 +2345,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -2309,8 +2358,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -2322,8 +2371,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -2335,8 +2384,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-1" } }, @@ -2348,8 +2397,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -2361,8 +2410,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-1" } }, @@ -2374,8 +2423,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -2387,8 +2436,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-3" } }, @@ -2400,8 +2449,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-3" } }, @@ -2413,8 +2462,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-3" } }, @@ -2426,8 +2475,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-3" } }, @@ -2439,8 +2488,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -2452,8 +2501,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -2465,8 +2514,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -2478,8 +2527,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -2491,8 +2540,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -2504,8 +2553,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -2517,8 +2566,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -2530,8 +2579,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -2543,8 +2592,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "me-south-1" } }, @@ -2556,8 +2605,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "me-south-1" } }, @@ -2569,8 +2618,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "me-south-1" } }, @@ -2582,8 +2631,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "me-south-1" } }, @@ -2595,8 +2644,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "sa-east-1" } }, @@ -2608,8 +2657,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "sa-east-1" } }, @@ -2621,8 +2670,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "sa-east-1" } }, @@ -2634,8 +2683,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "sa-east-1" } }, @@ -2647,8 +2696,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-east-1" } }, @@ -2660,8 +2709,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-east-1" } }, @@ -2673,8 +2722,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-east-1" } }, @@ -2686,8 +2735,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-east-1" } }, @@ -2699,8 +2748,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "cn-north-1" } }, @@ -2712,8 +2761,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "cn-north-1" } }, @@ -2725,8 +2774,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "cn-north-1" } }, @@ -2738,8 +2787,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "cn-north-1" } }, @@ -2751,8 +2800,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -2764,8 +2813,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -2777,8 +2826,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -2790,8 +2839,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -2803,8 +2852,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -2816,8 +2865,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -2829,8 +2878,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -2842,8 +2891,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -2855,8 +2904,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -2868,8 +2917,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -2881,8 +2930,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -2894,8 +2943,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -2905,8 +2954,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-east-1" } }, @@ -2918,8 +2967,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-east-1" } }, @@ -2929,8 +2978,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-east-1" } }, @@ -2942,8 +2991,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-east-1" } }, @@ -2955,8 +3004,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-3" } }, @@ -2968,8 +3017,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-3" } }, @@ -2981,8 +3030,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-3" } }, @@ -2994,8 +3043,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-3" } }, @@ -3007,8 +3056,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-4" } }, @@ -3020,8 +3069,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-4" } }, @@ -3033,8 +3082,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-4" } }, @@ -3046,8 +3095,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-4" } }, @@ -3059,8 +3108,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -3072,8 +3121,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -3085,8 +3134,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -3098,8 +3147,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -3111,8 +3160,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-2" } }, @@ -3124,8 +3173,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -3137,8 +3186,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-2" } }, @@ -3150,8 +3199,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -3163,8 +3212,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "cn-northwest-1" } }, @@ -3176,8 +3225,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "cn-northwest-1" } }, @@ -3189,8 +3238,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "cn-northwest-1" } }, @@ -3202,8 +3251,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "cn-northwest-1" } }, @@ -3213,8 +3262,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-isob-east-1" } }, @@ -3226,8 +3275,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-isob-east-1" } }, @@ -3237,8 +3286,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-isob-east-1" } }, @@ -3250,8 +3299,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-isob-east-1" } }, @@ -3263,8 +3312,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -3275,8 +3324,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -3287,8 +3336,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -3501,7 +3550,7 @@ "DeviceName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n instances in the Amazon EC2 User Guide for Linux Instances.

\n \n

To define a block device mapping, set the device name and exactly one of the\n following properties: Ebs, NoDevice, or\n VirtualName.

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

The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n instances in the Amazon EC2 User Guide for Linux Instances.

\n \n

To define a block device mapping, set the device name and exactly one of the\n following properties: Ebs, NoDevice, or\n VirtualName.

\n ", "smithy.api#required": {} } }, @@ -3514,7 +3563,7 @@ "NoDevice": { "target": "com.amazonaws.autoscaling#NoDevice", "traits": { - "smithy.api#documentation": "

Setting this value to true prevents a volume that is included in the\n block device mapping of the AMI from being mapped to the specified device name at\n launch.

\n

If NoDevice is true for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

" + "smithy.api#documentation": "

Setting this value to true prevents a volume that is included in the\n block device mapping of the AMI from being mapped to the specified device name at\n launch.

\n

If NoDevice is true for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

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

Cancels an instance refresh operation in progress. Cancellation does not roll back any\n replacements that have already been completed, but it prevents new replacements from\n being started.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

" + "smithy.api#documentation": "

Cancels an instance refresh operation in progress. Cancellation does not roll back any\n replacements that have already been completed, but it prevents new replacements from\n being started.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

" } }, "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer": { @@ -3657,7 +3706,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 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.

" + "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": { @@ -3760,7 +3809,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 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 Quotas for\n Amazon EC2 Auto Scaling 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 properties (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 Quotas for\n Amazon EC2 Auto Scaling 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 properties (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": { @@ -3769,20 +3818,20 @@ "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group. This name must be unique per Region per account.

\n

The name can contain any ASCII character 33 to 126 including most punctuation\n characters, digits, and upper and lowercased letters.

\n \n

You cannot use a colon (:) in the name.

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

The name of the Auto Scaling group. This name must be unique per Region per account.

\n

The name can contain any ASCII character 33 to 126 including most punctuation\n characters, digits, and upper and lowercased letters.

\n \n

You cannot use a colon (:) in the name.

\n ", "smithy.api#required": {} } }, "LaunchConfigurationName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the launch configuration to use to launch instances.

\n

Conditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).

" + "smithy.api#documentation": "

The name of the launch configuration to use to launch instances.

\n

Conditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).

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

Information used to specify the launch template and version to use to launch\n instances.

\n

Conditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).

\n \n

The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Creating a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

Information used to specify the launch template and version to use to launch\n instances.

\n

Conditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).

\n \n

The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Creating a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n " } }, "MixedInstancesPolicy": { @@ -3807,7 +3856,7 @@ "MaxSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "

The maximum size of the group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

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

The maximum size of the group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n ", "smithy.api#required": {} } }, @@ -3820,7 +3869,7 @@ "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: 300 seconds

" + "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: 300 seconds

" } }, "AvailabilityZones": { @@ -3838,25 +3887,25 @@ "TargetGroupARNs": { "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group.\n Instances are registered as targets with the target groups. The target groups receive\n incoming traffic and route requests to one or more registered targets. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling\n group. Instances are registered as targets with the target groups. The target groups\n receive incoming traffic and route requests to one or more registered targets. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

The service to use for the health checks. The valid values are EC2\n (default) and ELB. If you configure an Auto Scaling group to use load balancer\n (ELB) health checks, it considers the instance unhealthy if it fails either the EC2\n status checks or the load balancer health checks. For more information, see Health checks\n for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Determines whether any additional health checks are performed on the instances in this\n group. Amazon EC2 health checks are always on. For more information, see Health checks\n for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

\n

The valid values are EC2 (default), ELB, and\n VPC_LATTICE. The VPC_LATTICE health check type is reserved\n for use with VPC Lattice, which is in preview release and is subject to change.

" } }, "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 Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the InService state. For more\n information, see Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Default: 0 seconds

" + "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. This is useful if your instances do not immediately pass their health\n checks after they enter the InService state. For more information, see\n Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Default: 0 seconds

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

The name of the placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

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

The name of the placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " } }, "VPCZoneIdentifier": { @@ -3868,7 +3917,7 @@ "TerminationPolicies": { "target": "com.amazonaws.autoscaling#TerminationPolicies", "traits": { - "smithy.api#documentation": "

A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n

" + "smithy.api#documentation": "

A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n

" } }, "NewInstancesProtectedFromScaleIn": { @@ -3916,13 +3965,19 @@ "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. 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.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n \n

Valid values: units | vcpu | memory-mib\n

" + "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. 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.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

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

The amount of time, in seconds, until a newly launched instance can contribute to the\n Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling\n aggregates instance metrics, resulting in more reliable usage data. Set this value equal\n to the amount of time that it takes for resource consumption to become stable after an\n instance reaches the InService state. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage your warm-up settings at the group level, we recommend that you set the\n default instance warmup, even if its value is set to 0 seconds.\n This also optimizes the performance of scaling policies that scale continuously,\n such as target tracking and step scaling policies.

\n

If you need to remove a value that you previously set, include the property but\n specify -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a minimum value of\n 0.

\n \n

Default: None

" + "smithy.api#documentation": "

The amount of time, in seconds, until a newly launched instance can contribute to the\n Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling\n aggregates instance metrics, resulting in more reliable usage data. Set this value equal\n to the amount of time that it takes for resource consumption to become stable after an\n instance reaches the InService state. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage your warm-up settings at the group level, we recommend that you set the\n default instance warmup, even if its value is set to 0 seconds.\n This also optimizes the performance of scaling policies that scale continuously,\n such as target tracking and step scaling policies.

\n

If you need to remove a value that you previously set, include the property but\n specify -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a minimum value of\n 0.

\n \n

Default: None

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

\n Reserved for use with Amazon VPC Lattice, which is in preview release and is subject to\n change. Do not use this parameter for production workloads. It is also subject to change.\n

\n

The unique identifiers of one or more traffic sources.

\n

Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice\n target group. Amazon EC2 Auto Scaling registers the running instances with the attached target groups.\n The target groups receive incoming traffic and route requests to one or more registered\n targets.

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

Creates a launch configuration.

\n

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

\n

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

\n \n

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

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

Creates a launch configuration.

\n

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

\n

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

\n \n

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

\n " } }, "com.amazonaws.autoscaling#CreateLaunchConfigurationType": { @@ -3963,7 +4018,7 @@ "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.

\n

If you specify InstanceId, an ImageId is not\n required.

" + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.

\n

If you specify InstanceId, an ImageId is not\n required.

" } }, "KeyName": { @@ -3999,25 +4054,25 @@ "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "

The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.

\n

To create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.

\n

For more information, see Creating a launch\n configuration using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.

\n

To create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.

\n

For more information, see Creating a launch\n configuration using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.

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

Specifies the instance type of the EC2 instance. For information about available\n instance types, see Available\n instance types in the Amazon EC2 User Guide for Linux Instances.

\n

If you specify InstanceId, an InstanceType is not\n required.

" + "smithy.api#documentation": "

Specifies the instance type of the EC2 instance. For information about available\n instance types, see Available\n instance types in the Amazon EC2 User Guide for Linux Instances.

\n

If you specify InstanceId, an InstanceType is not\n required.

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

The ID of the kernel associated with the AMI.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.

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

The ID of the kernel associated with the AMI.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.

\n " } }, "RamdiskId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of the RAM disk to select.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.

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

The ID of the RAM disk to select.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.

\n " } }, "BlockDeviceMappings": { @@ -4029,13 +4084,13 @@ "InstanceMonitoring": { "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { - "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

The default value is true (enabled).

\n \n

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.

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

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

The default value is true (enabled).

\n \n

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.

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

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid Range: Minimum value of 0.001

\n \n

When you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.

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

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid Range: Minimum value of 0.001

\n \n

When you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.

\n " } }, "IamInstanceProfile": { @@ -4047,19 +4102,19 @@ "EbsOptimized": { "target": "com.amazonaws.autoscaling#EbsOptimized", "traits": { - "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-optimized instances in\n the Amazon EC2 User Guide for Linux Instances.

\n

The default value is false.

" + "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-optimized instances in\n the Amazon EC2 User Guide for Linux Instances.

\n

The default value is false.

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

Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.

\n

If you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.

\n

If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

" + "smithy.api#documentation": "

Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.

\n

If you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.

\n

If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

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

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated. For more information,\n see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

\n

Valid values: default | dedicated\n

" + "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated. For more information,\n see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

\n

Valid values: default | dedicated\n

" } }, "MetadataOptions": { @@ -4093,7 +4148,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates tags for the specified Auto Scaling group.

\n

When you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Creates or updates tags for the specified Auto Scaling group.

\n

When you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#CreateOrUpdateTagsType": { @@ -4114,28 +4169,25 @@ "MetricName": { "target": "com.amazonaws.autoscaling#MetricName", "traits": { - "smithy.api#documentation": "

The name of the metric. To get the exact metric name, namespace, and dimensions,\n inspect the Metric object\n that is returned by a call to ListMetrics.

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

The name of the metric. To get the exact metric name, namespace, and dimensions,\n inspect the Metric object\n that is returned by a call to ListMetrics.

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

The namespace of the metric.

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

The namespace of the metric.

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

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" + "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

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

The statistic of the metric.

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

The statistic of the metric.

" } }, "Unit": { @@ -4143,10 +4195,16 @@ "traits": { "smithy.api#documentation": "

The unit of the metric. For a complete list of the units that CloudWatch supports, see the\n MetricDatum\n data type in the Amazon CloudWatch API Reference.

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

The metrics to include in the target tracking scaling policy, as a metric data query.\n This can include both raw metric and metric math expressions.

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

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.

\n

To create your customized metric specification:

\n \n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.

\n \n

Each individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

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

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.

\n

To create your customized metric specification:

\n \n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.

\n \n

Each individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n " } }, "com.amazonaws.autoscaling#DefaultInstanceWarmup": { @@ -4172,7 +4230,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified Auto Scaling group.

\n

If the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.

\n

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.

\n

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.

\n

If the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.

\n

For more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Deletes the specified Auto Scaling group.

\n

If the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.

\n

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.

\n

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.

\n

If the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.

\n

For more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#DeleteAutoScalingGroupType": { @@ -4210,7 +4268,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified launch configuration.

\n

The launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.

" + "smithy.api#documentation": "

Deletes the specified launch configuration.

\n

The launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.

" } }, "com.amazonaws.autoscaling#DeleteLifecycleHook": { @@ -4227,7 +4285,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified lifecycle hook.

\n

If there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).

" + "smithy.api#documentation": "

Deletes the specified lifecycle hook.

\n

If there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).

" } }, "com.amazonaws.autoscaling#DeleteLifecycleHookAnswer": { @@ -4306,7 +4364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified scaling policy.

\n

Deleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.

\n

For more information, see Deleting a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Deletes the specified scaling policy.

\n

Deleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.

\n

For more information, see Deleting a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#DeletePolicyType": { @@ -4418,7 +4476,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the warm pool for the specified Auto Scaling group.

\n

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

" + "smithy.api#documentation": "

Deletes the warm pool for the specified Auto Scaling group.

\n

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

" } }, "com.amazonaws.autoscaling#DeleteWarmPoolAnswer": { @@ -4457,7 +4515,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

\n

When you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

\n

When you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { @@ -4503,7 +4561,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the available adjustment types for step scaling and simple scaling\n policies.

\n

The following adjustment types are supported:

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

Describes the available adjustment types for step scaling and simple scaling\n policies.

\n

The following adjustment types are supported:

\n " } }, "com.amazonaws.autoscaling#DescribeAdjustmentTypesAnswer": { @@ -4534,7 +4592,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the Auto Scaling groups in the account and Region.

\n

If you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.

\n

This operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.

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

Gets information about the Auto Scaling groups in the account and Region.

\n

If you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.

\n

This operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4652,7 +4710,7 @@ "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { - "smithy.api#documentation": "

The IDs of the instances. If you omit this property, all Auto Scaling instances are described.\n If you specify an ID that does not exist, it is ignored with no error.

\n

Array Members: Maximum number of 50 items.

" + "smithy.api#documentation": "

The IDs of the instances. If you omit this property, all Auto Scaling instances are described.\n If you specify an ID that does not exist, it is ignored with no error.

\n

Array Members: Maximum number of 50 items.

" } }, "MaxRecords": { @@ -4714,7 +4772,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the instance refreshes for the specified Auto Scaling group.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

To help you determine the status of an instance refresh, this operation returns\n information about the instance refreshes you previously initiated, including their\n status, end time, the percentage of the instance refresh that is complete, and the\n number of instances remaining to update before the instance refresh is complete.

\n

The following are the possible statuses:

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

Gets information about the instance refreshes for the specified Auto Scaling group.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

To help you determine the status of an instance refresh, this operation returns\n information about the instance refreshes you previously initiated, including their\n status, end time, the percentage of the instance refresh that is complete, and the\n number of instances remaining to update before the instance refresh is complete.

\n

The following are the possible statuses:

\n " } }, "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer": { @@ -4804,7 +4862,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the available types of lifecycle hooks.

\n

The following hook types are supported:

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

Describes the available types of lifecycle hooks.

\n

The following hook types are supported:

\n " } }, "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer": { @@ -4881,7 +4939,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

\n

To determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.

\n

Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

\n

To determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.

\n

Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

You can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n " } }, "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest": { @@ -4942,7 +5000,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancer, use the\n DescribeLoadBalancerTargetGroups API instead.

\n

To determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.

\n

Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Gets information about the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancer, use the\n DescribeLoadBalancerTargetGroups API instead.

\n

To determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.

\n

Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { @@ -5128,7 +5186,7 @@ "PolicyNames": { "target": "com.amazonaws.autoscaling#PolicyNames", "traits": { - "smithy.api#documentation": "

The names of one or more policies. If you omit this property, all policies are\n described. If a group name is provided, the results are limited to that group. If you\n specify an unknown policy name, it is ignored with no error.

\n

Array Members: Maximum number of 50 items.

" + "smithy.api#documentation": "

The names of one or more policies. If you omit this property, all policies are\n described. If a group name is provided, the results are limited to that group. If you\n specify an unknown policy name, it is ignored with no error.

\n

Array Members: Maximum number of 50 items.

" } }, "PolicyTypes": { @@ -5168,7 +5226,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the scaling activities in the account and Region.

\n

When scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verifying a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

\n

If the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

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

Gets information about the scaling activities in the account and Region.

\n

When scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verifying a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

\n

If the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5183,7 +5241,7 @@ "ActivityIds": { "target": "com.amazonaws.autoscaling#ActivityIds", "traits": { - "smithy.api#documentation": "

The activity IDs of the desired scaling activities. If you omit this property, all\n activities for the past six weeks are described. If unknown activities are requested,\n they are ignored with no error. If you specify an Auto Scaling group, the results are limited to\n that group.

\n

Array Members: Maximum number of 50 IDs.

" + "smithy.api#documentation": "

The activity IDs of the desired scaling activities. If you omit this property, all\n activities for the past six weeks are described. If unknown activities are requested,\n they are ignored with no error. If you specify an Auto Scaling group, the results are limited to\n that group.

\n

Array Members: Maximum number of 50 IDs.

" } }, "AutoScalingGroupName": { @@ -5246,7 +5304,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the scheduled actions that haven't run or that have not reached\n their end time.

\n

To describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.

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

Gets information about the scheduled actions that haven't run or that have not reached\n their end time.

\n

To describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5267,7 +5325,7 @@ "ScheduledActionNames": { "target": "com.amazonaws.autoscaling#ScheduledActionNames", "traits": { - "smithy.api#documentation": "

The names of one or more scheduled actions. If you omit this property, all scheduled\n actions are described. If you specify an unknown scheduled action, it is ignored with no\n error.

\n

Array Members: Maximum number of 50 actions.

" + "smithy.api#documentation": "

The names of one or more scheduled actions. If you omit this property, all scheduled\n actions are described. If you specify an unknown scheduled action, it is ignored with no\n error.

\n

Array Members: Maximum number of 50 actions.

" } }, "StartTime": { @@ -5313,7 +5371,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified tags.

\n

You can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.

\n

You can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

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

Describes the specified tags.

\n

You can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.

\n

You can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5359,7 +5417,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the termination policies supported by Amazon EC2 Auto Scaling.

\n

For more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Describes the termination policies supported by Amazon EC2 Auto Scaling.

\n

For more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer": { @@ -5373,6 +5431,74 @@ } } }, + "com.amazonaws.autoscaling#DescribeTrafficSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeTrafficSourcesRequest" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeTrafficSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

\n Reserved for use with Amazon VPC Lattice, which is in preview and subject to change. \n Do not use this API for production workloads. This API is also subject to change.\n

\n

Gets information about the traffic sources for the specified Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#DescribeTrafficSourcesRequest": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

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

The type of traffic source you are describing. Currently, the only valid value is\n vpc-lattice.

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

The token for the next set of items to return. (You received this token from a\n previous call.)

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

The maximum number of items to return with this call. The maximum value is\n 50.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeTrafficSourcesResponse": { + "type": "structure", + "members": { + "TrafficSources": { + "target": "com.amazonaws.autoscaling#TrafficSourceStates", + "traits": { + "smithy.api#documentation": "

Information about the traffic sources.

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

This string indicates that the response contains more items than can be returned in a\n single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } + }, "com.amazonaws.autoscaling#DescribeWarmPool": { "type": "operation", "input": { @@ -5393,7 +5519,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": { @@ -5414,7 +5540,7 @@ "NextToken": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + "smithy.api#documentation": "

This string indicates that the response contains more items than can be returned in a\n single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" } } } @@ -5454,7 +5580,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the desired configuration for an instance refresh.

\n

If you specify a desired configuration, you must specify either a\n LaunchTemplate or a MixedInstancesPolicy.

" + "smithy.api#documentation": "

Describes the desired configuration for an instance refresh.

\n

If you specify a desired configuration, you must specify either a\n LaunchTemplate or a MixedInstancesPolicy.

" } }, "com.amazonaws.autoscaling#DetachInstances": { @@ -5471,7 +5597,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more instances from the specified Auto Scaling group.

\n

After the instances are detached, you can manage them independent of the Auto Scaling\n group.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.

\n

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.

\n

For more information, see Detach EC2 instances from\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Removes one or more instances from the specified Auto Scaling group.

\n

After the instances are detached, you can manage them independent of the Auto Scaling\n group.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.

\n

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.

\n

For more information, see Detach EC2 instances from\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#DetachInstancesAnswer": { @@ -5524,7 +5650,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detaches one or more target groups from the specified Auto Scaling group.

\n

When you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.

" + "smithy.api#documentation": "

Detaches one or more target groups from the specified Auto Scaling group.

\n

When you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.

\n \n

You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n " } }, "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsResultType": { @@ -5564,7 +5690,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

\n

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancer, use the DetachLoadBalancerTargetGroups API instead.

\n

When you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

" + "smithy.api#documentation": "

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

\n

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancer, use the DetachLoadBalancerTargetGroups API instead.

\n

When you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

" } }, "com.amazonaws.autoscaling#DetachLoadBalancersResultType": { @@ -5590,6 +5716,46 @@ } } }, + "com.amazonaws.autoscaling#DetachTrafficSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DetachTrafficSourcesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DetachTrafficSourcesResultType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

\n Reserved for use with Amazon VPC Lattice, which is in preview and subject to change. \n Do not use this API for production workloads. This API is also subject to change.\n

\n

Detaches one or more traffic sources from the specified Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#DetachTrafficSourcesResultType": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#DetachTrafficSourcesType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

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

The unique identifiers of one or more traffic sources you are detaching. You can\n specify up to 10 traffic sources.

\n

Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice\n target group. When you detach a target group, it enters the Removing state\n while deregistering the instances in the group. When all instances are deregistered,\n then you can no longer describe the target group using the DescribeTrafficSources API call. The instances continue to run.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.autoscaling#DisableMetricsCollection": { "type": "operation", "input": { @@ -5620,7 +5786,7 @@ "Metrics": { "target": "com.amazonaws.autoscaling#Metrics", "traits": { - "smithy.api#documentation": "

Identifies the metrics to disable.

\n

You can specify one or more of the following metrics:

\n \n

If you omit this property, all metrics are disabled.

\n

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Identifies the metrics to disable.

\n

You can specify one or more of the following metrics:

\n \n

If you omit this property, all metrics are disabled.

\n

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

" } } } @@ -5634,19 +5800,19 @@ "SnapshotId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The snapshot ID of the volume to use.

\n

You must specify either a VolumeSize or a SnapshotId.

" + "smithy.api#documentation": "

The snapshot ID of the volume to use.

\n

You must specify either a VolumeSize or a SnapshotId.

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

The volume size, in GiBs. The following are the supported volumes sizes for each\n volume type:

\n \n

You must specify either a SnapshotId or a VolumeSize. If you\n specify both SnapshotId and VolumeSize, the volume size must\n be equal or greater than the size of the snapshot.

" + "smithy.api#documentation": "

The volume size, in GiBs. The following are the supported volumes sizes for each\n volume type:

\n \n

You must specify either a SnapshotId or a VolumeSize. If you\n specify both SnapshotId and VolumeSize, the volume size must\n be equal or greater than the size of the snapshot.

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

The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide for Linux Instances.

\n

Valid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n

" + "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide for Linux Instances.

\n

Valid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n

" } }, "DeleteOnTermination": { @@ -5658,13 +5824,13 @@ "Iops": { "target": "com.amazonaws.autoscaling#BlockDeviceEbsIops", "traits": { - "smithy.api#documentation": "

The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.

\n

\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)

" + "smithy.api#documentation": "

The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.

\n

\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)

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

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.

\n \n

If you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.

\n

If you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.

\n

For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.

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

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.

\n \n

If you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.

\n

If you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.

\n

For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.

\n " } }, "Throughput": { @@ -5695,7 +5861,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables group metrics collection for the specified Auto Scaling group.

\n

You can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Enables group metrics collection for the specified Auto Scaling group.

\n

You can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#EnableMetricsCollectionQuery": { @@ -5711,7 +5877,7 @@ "Metrics": { "target": "com.amazonaws.autoscaling#Metrics", "traits": { - "smithy.api#documentation": "

Identifies the metrics to enable.

\n

You can specify one or more of the following metrics:

\n \n

If you specify Granularity and don't specify any metrics, all metrics are\n enabled.

\n

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Identifies the metrics to enable.

\n

You can specify one or more of the following metrics:

\n \n

If you specify Granularity and don't specify any metrics, all metrics are\n enabled.

\n

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

" } }, "Granularity": { @@ -5729,7 +5895,7 @@ "Metric": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

One of the following metrics:

\n \n

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

One of the following metrics:

\n \n

For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.

" } }, "Granularity": { @@ -5763,7 +5929,7 @@ } ], "traits": { - "smithy.api#documentation": "

Moves the specified instances into the standby state.

\n

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.

\n

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Moves the specified instances into the standby state.

\n

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.

\n

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#EnterStandbyAnswer": { @@ -5866,19 +6032,19 @@ "HonorCooldown": { "target": "com.amazonaws.autoscaling#HonorCooldown", "traits": { - "smithy.api#documentation": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

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

The metric value to compare to BreachThreshold. This enables you to\n execute a policy of type StepScaling and determine which step adjustment to\n use. For example, if the breach threshold is 50 and you want to use a step adjustment\n with a lower bound of 0 and an upper bound of 10, you can set the metric value to\n 59.

\n

If you specify a metric value that doesn't correspond to a step adjustment for the\n policy, the call returns an error.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" + "smithy.api#documentation": "

The metric value to compare to BreachThreshold. This enables you to\n execute a policy of type StepScaling and determine which step adjustment to\n use. For example, if the breach threshold is 50 and you want to use a step adjustment\n with a lower bound of 0 and an upper bound of 10, you can set the metric value to\n 59.

\n

If you specify a metric value that doesn't correspond to a step adjustment for the\n policy, the call returns an error.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

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

The breach threshold for the alarm.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" + "smithy.api#documentation": "

The breach threshold for the alarm.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

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

Moves the specified instances out of the standby state.

\n

After you put the instances back in service, the desired capacity is\n incremented.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Moves the specified instances out of the standby state.

\n

After you put the instances back in service, the desired capacity is\n incremented.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#ExitStandbyAnswer": { @@ -5968,18 +6134,18 @@ "Name": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n

The valid values for Name depend on which API operation you're using with\n the filter (DescribeAutoScalingGroups or DescribeTags).

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n \n

\n DescribeTags\n

\n

Valid values for Name include the following:

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

The name of the filter.

\n

The valid values for Name depend on which API operation you're using with\n the filter (DescribeAutoScalingGroups or DescribeTags).

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n \n

\n DescribeTags\n

\n

Valid values for Name include the following:

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

One or more filter values. Filter values are case-sensitive.

\n

If you specify multiple values for a filter, the values are automatically logically\n joined with an OR, and the request returns all results that match any of\n the specified values. For example, specify \"tag:environment\" for the filter name and\n \"production,development\" for the filter values to find Auto Scaling groups with the tag\n \"environment=production\" or \"environment=development\".

" + "smithy.api#documentation": "

One or more filter values. Filter values are case-sensitive.

\n

If you specify multiple values for a filter, the values are automatically logically\n joined with an OR, and the request returns all results that match any of\n the specified values. For example, specify \"tag:environment\" for the filter name and\n \"production,development\" for the filter values to find Auto Scaling groups with the tag\n \"environment=production\" or \"environment=development\".

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

Describes a filter that is used to return a more specific list of results from a\n describe operation.

\n

If you specify multiple filters, the filters are automatically logically joined with\n an AND, and the request returns only the results that match all of the\n specified filters.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Describes a filter that is used to return a more specific list of results from a\n describe operation.

\n

If you specify multiple filters, the filters are automatically logically joined with\n an AND, and the request returns only the results that match all of the\n specified filters.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#Filters": { @@ -6005,7 +6171,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the forecast data for a predictive scaling policy.

\n

Load forecasts are predictions of the hourly load values using historical load data\n from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as\n predicted values for the minimum capacity that is needed on an hourly basis, based on\n the hourly load forecast.

\n

A minimum of 24 hours of data is required to create the initial forecasts. However,\n having a full 14 days of historical data results in more accurate forecasts.

\n

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

" + "smithy.api#documentation": "

Retrieves the forecast data for a predictive scaling policy.

\n

Load forecasts are predictions of the hourly load values using historical load data\n from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as\n predicted values for the minimum capacity that is needed on an hourly basis, based on\n the hourly load forecast.

\n

A minimum of 24 hours of data is required to create the initial forecasts. However,\n having a full 14 days of historical data results in more accurate forecasts.

\n

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

" } }, "com.amazonaws.autoscaling#GetPredictiveScalingForecastAnswer": { @@ -6061,7 +6227,7 @@ "EndTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The exclusive end time of the time range for the forecast data to get. The maximum\n time duration between the start and end time is 30 days.

\n

Although this parameter can accept a date and time that is more than two days in the\n future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for\n periods of two days in advance.

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

The exclusive end time of the time range for the forecast data to get. The maximum\n time duration between the start and end time is 30 days.

\n

Although this parameter can accept a date and time that is more than two days in the\n future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for\n periods of two days in advance.

", "smithy.api#required": {} } } @@ -6141,7 +6307,7 @@ "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" + "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" } } }, @@ -6227,19 +6393,19 @@ "HttpTokens": { "target": "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState", "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

" + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

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

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

" + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

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

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

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

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " } } }, @@ -6282,7 +6448,7 @@ "Status": { "target": "com.amazonaws.autoscaling#InstanceRefreshStatus", "traits": { - "smithy.api#documentation": "

The current status for the instance refresh operation:

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

The current status for the instance refresh operation:

\n " } }, "StatusReason": { @@ -6485,132 +6651,132 @@ "CpuManufacturers": { "target": "com.amazonaws.autoscaling#CpuManufacturers", "traits": { - "smithy.api#documentation": "

Lists which specific CPU manufacturers to include.

\n \n \n

Don't confuse the CPU hardware manufacturer with the CPU hardware architecture.\n Instances will be launched with a compatible CPU architecture based on the Amazon\n Machine Image (AMI) that you specify in your launch template.

\n \n

Default: Any manufacturer

" + "smithy.api#documentation": "

Lists which specific CPU manufacturers to include.

\n \n \n

Don't confuse the CPU hardware manufacturer with the CPU hardware architecture.\n Instances will be launched with a compatible CPU architecture based on the Amazon\n Machine Image (AMI) that you specify in your launch template.

\n \n

Default: Any manufacturer

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

The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

\n

Default: No minimum or maximum limits

" + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

\n

Default: No minimum or maximum limits

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

The instance types to exclude. You can use strings with one or more wild cards,\n represented by an asterisk (*), to exclude an instance family, type, size,\n or generation. The following are examples: m5.8xlarge, c5*.*,\n m5a.*, r*, *3*.

\n

For example, if you specify c5*, you are excluding the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify\n AllowedInstanceTypes.

\n \n

Default: No excluded instance types

" + "smithy.api#documentation": "

The instance types to exclude. You can use strings with one or more wild cards,\n represented by an asterisk (*), to exclude an instance family, type, size,\n or generation. The following are examples: m5.8xlarge, c5*.*,\n m5a.*, r*, *3*.

\n

For example, if you specify c5*, you are excluding the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify\n AllowedInstanceTypes.

\n \n

Default: No excluded instance types

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

Indicates whether current or previous generation instance types are included.

\n \n

Default: Any current or previous generation

" + "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included.

\n \n

Default: Any current or previous generation

" } }, "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 least expensive current\n generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling\n selects instance types with your attributes, we will exclude instance types whose price\n is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling\n interprets as a percentage. To turn off price protection, specify a high value, such as\n 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

" + "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 least expensive current\n generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling\n selects instance types with your attributes, we will exclude instance types whose price\n is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling\n interprets as a percentage. To turn off price protection, specify a high value, such as\n 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 least expensive\n current generation M, C, or R instance type with your specified attributes. When\n Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types\n whose price is higher than your threshold. The parameter accepts an integer, which\n Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value,\n 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

" + "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 least expensive\n current generation M, C, or R instance type with your specified attributes. When\n Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types\n whose price is higher than your threshold. The parameter accepts an integer, which\n Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value,\n 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": { "target": "com.amazonaws.autoscaling#BareMetal", "traits": { - "smithy.api#documentation": "

Indicates whether bare metal instance types are included, excluded, or\n required.

\n

Default: excluded\n

" + "smithy.api#documentation": "

Indicates whether bare metal instance types are included, excluded, or\n required.

\n

Default: excluded\n

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

Indicates whether burstable performance instance types are included, excluded, or\n required. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide for Linux Instances.

\n

Default: excluded\n

" + "smithy.api#documentation": "

Indicates whether burstable performance instance types are included, excluded, or\n required. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide for Linux Instances.

\n

Default: excluded\n

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

Indicates whether instance types must provide On-Demand Instance hibernation\n support.

\n

Default: false\n

" + "smithy.api#documentation": "

Indicates whether instance types must provide On-Demand Instance hibernation\n support.

\n

Default: false\n

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

The minimum and maximum number of network interfaces for an instance type.

\n

Default: No minimum or maximum limits

" + "smithy.api#documentation": "

The minimum and maximum number of network interfaces for an instance type.

\n

Default: No minimum or maximum limits

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

Indicates whether instance types with instance store volumes are included, excluded,\n or required. For more information, see Amazon EC2 instance store in\n the Amazon EC2 User Guide for Linux Instances.

\n

Default: included\n

" + "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded,\n or required. For more information, see Amazon EC2 instance store in\n the Amazon EC2 User Guide for Linux Instances.

\n

Default: included\n

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

Indicates the type of local storage that is required.

\n \n

Default: Any local storage type

" + "smithy.api#documentation": "

Indicates the type of local storage that is required.

\n \n

Default: Any local storage type

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

The minimum and maximum total local storage size for an instance type, in GB.

\n

Default: No minimum or maximum limits

" + "smithy.api#documentation": "

The minimum and maximum total local storage size for an instance type, in GB.

\n

Default: No minimum or maximum limits

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

The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.\n For more information, see Amazon EBS–optimized instances\n in the Amazon EC2 User Guide for Linux Instances.

\n

Default: No minimum or maximum limits

" + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.\n For more information, see Amazon EBS–optimized instances\n in the Amazon EC2 User Guide for Linux Instances.

\n

Default: No minimum or maximum limits

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

Lists the accelerator types that must be on an instance type.

\n \n

Default: Any accelerator type

" + "smithy.api#documentation": "

Lists the accelerator types that must be on an instance type.

\n \n

Default: Any accelerator type

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

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia\n chips) for an instance type.

\n

To exclude accelerator-enabled instance types, set Max to\n 0.

\n

Default: No minimum or maximum limits

" + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia\n chips) for an instance type.

\n

To exclude accelerator-enabled instance types, set Max to\n 0.

\n

Default: No minimum or maximum limits

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

Indicates whether instance types must have accelerators by specific\n manufacturers.

\n \n

Default: Any manufacturer

" + "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific\n manufacturers.

\n \n

Default: Any manufacturer

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

Lists the accelerators that must be on an instance type.

\n \n

Default: Any accelerator

" + "smithy.api#documentation": "

Lists the accelerators that must be on an instance type.

\n \n

Default: Any accelerator

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

The minimum and maximum total memory size for the accelerators on an instance type, in\n MiB.

\n

Default: No minimum or maximum limits

" + "smithy.api#documentation": "

The minimum and maximum total memory size for the accelerators on an instance type, in\n MiB.

\n

Default: No minimum or maximum limits

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

The minimum and maximum amount of network bandwidth, in gigabits per second\n (Gbps).

\n

Default: No minimum or maximum limits

" + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second\n (Gbps).

\n

Default: No minimum or maximum limits

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

The instance types to apply your specified attributes against. All other instance\n types are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by an asterisk\n (*), to allow an instance type, size, or generation. The following are\n examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5\n instance family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify\n ExcludedInstanceTypes.

\n \n

Default: All instance types

" + "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance\n types are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by an asterisk\n (*), to allow an instance type, size, or generation. The following are\n examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5\n instance family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify\n ExcludedInstanceTypes.

\n \n

Default: All instance types

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

The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your\n specified requirements to identify instance types. Then, it uses your On-Demand and Spot\n allocation strategies to launch instances from these instance types.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance\n types, you can use one of the following parameters, but not both in the same\n request:

\n \n \n

You must specify VCpuCount and MemoryMiB. All other\n attributes are optional. Any unspecified optional attribute is set to its\n default.

\n \n

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. For help determining which instance types match\n your attributes before you apply them to your Auto Scaling group, see Preview instance types with specified attributes in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your\n specified requirements to identify instance types. Then, it uses your On-Demand and Spot\n allocation strategies to launch instances from these instance types.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance\n types, you can use one of the following parameters, but not both in the same\n request:

\n \n \n

You must specify VCpuCount and MemoryMiB. All other\n attributes are optional. Any unspecified optional attribute is set to its\n default.

\n \n

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. For help determining which instance types match\n your attributes before you apply them to your Auto Scaling group, see Preview instance types with specified attributes in the\n Amazon EC2 User Guide for Linux Instances.

" } }, "com.amazonaws.autoscaling#InstanceReusePolicy": { @@ -6624,7 +6790,7 @@ } }, "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.

" + "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": { @@ -6639,37 +6805,37 @@ "OnDemandAllocationStrategy": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The allocation strategy to apply to your On-Demand Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
lowest-price
\n
\n

Uses price to determine which instance types are the highest priority,\n launching the lowest priced instance types within an Availability Zone\n first. This is the default value for Auto Scaling groups that specify InstanceRequirements.

\n
\n
prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling\n launches your highest priority instance types first. If all your On-Demand\n capacity cannot be fulfilled using your highest priority instance type, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance\n type, and so on. This is the default value for Auto Scaling groups that don't\n specify InstanceRequirements and cannot be used for groups\n that do.

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

The allocation strategy to apply to your On-Demand Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
lowest-price
\n
\n

Uses price to determine which instance types are the highest priority,\n launching the lowest priced instance types within an Availability Zone\n first. This is the default value for Auto Scaling groups that specify InstanceRequirements.

\n
\n
prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling\n launches your highest priority instance types first. If all your On-Demand\n capacity cannot be fulfilled using your highest priority instance type, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance\n type, and so on. This is the default value for Auto Scaling groups that don't\n specify InstanceRequirements and cannot be used for groups\n that do.

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

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is launched first as your group scales.

\n

This number has the same unit of measurement as the group's desired capacity. If you\n change the default unit of measurement (number of instances) by specifying weighted\n capacity values in your launch template overrides list, or by changing the default\n desired capacity type setting of the group, you must specify this number using the same\n unit of measurement.

\n

Default: 0

" + "smithy.api#documentation": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is launched first as your group scales.

\n

This number has the same unit of measurement as the group's desired capacity. If you\n change the default unit of measurement (number of instances) by specifying weighted\n capacity values in your launch template overrides list, or by changing the default\n desired capacity type setting of the group, you must specify this number using the same\n unit of measurement.

\n

Default: 0

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

Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity. Expressed as a number (for example,\n 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand\n Instances are used.

\n

Default: 100

" + "smithy.api#documentation": "

Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity. Expressed as a number (for example,\n 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand\n Instances are used.

\n

Default: 100

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

The allocation strategy to apply to your Spot Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
capacity-optimized
\n
\n

Requests Spot Instances using pools that are optimally chosen based on the\n available Spot capacity. This strategy has the lowest risk of interruption.\n To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized.

\n
\n
capacity-optimized-prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors\n the instance type priorities on a best effort basis but optimizes for\n capacity first. Note that if the On-Demand allocation strategy is set to\n prioritized, the same priority is applied when fulfilling\n On-Demand capacity. This is not a valid value for Auto Scaling groups that specify\n InstanceRequirements.

\n
\n
lowest-price
\n
\n

Requests Spot Instances using the lowest priced pools within an\n Availability Zone, across the number of Spot pools that you specify for the\n SpotInstancePools property. To ensure that your desired\n capacity is met, you might receive Spot Instances from several pools. This\n is the default value, but it might lead to high interruption rates because\n this strategy only considers instance price and not available\n capacity.

\n
\n
price-capacity-optimized (recommended)
\n
\n

Amazon EC2 Auto Scaling identifies the pools with the highest capacity availability for\n the number of instances that are launching. This means that we will request\n Spot Instances from the pools that we believe have the lowest chance of\n interruption in the near term. Amazon EC2 Auto Scaling then requests Spot Instances from\n the lowest priced of these pools.

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

The allocation strategy to apply to your Spot Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
capacity-optimized
\n
\n

Requests Spot Instances using pools that are optimally chosen based on the\n available Spot capacity. This strategy has the lowest risk of interruption.\n To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized.

\n
\n
capacity-optimized-prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors\n the instance type priorities on a best effort basis but optimizes for\n capacity first. Note that if the On-Demand allocation strategy is set to\n prioritized, the same priority is applied when fulfilling\n On-Demand capacity. This is not a valid value for Auto Scaling groups that specify\n InstanceRequirements.

\n
\n
lowest-price
\n
\n

Requests Spot Instances using the lowest priced pools within an\n Availability Zone, across the number of Spot pools that you specify for the\n SpotInstancePools property. To ensure that your desired\n capacity is met, you might receive Spot Instances from several pools. This\n is the default value, but it might lead to high interruption rates because\n this strategy only considers instance price and not available\n capacity.

\n
\n
price-capacity-optimized (recommended)
\n
\n

The price and capacity optimized allocation strategy looks at both price\n and capacity to select the Spot Instance pools that are the least likely to\n be interrupted and have the lowest possible price.

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

The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the overrides. Valid only\n when the SpotAllocationStrategy is lowest-price. Value must be\n in the range of 1–20.

\n

Default: 2

" + "smithy.api#documentation": "

The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the overrides. Valid only\n when the SpotAllocationStrategy is lowest-price. Value must be\n in the range of 1–20.

\n

Default: 2

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

The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n your maximum price is lower than the Spot price for the instance types that you\n selected, your Spot Instances are not launched. We do not recommend specifying a maximum\n price because it can lead to increased interruptions. When Spot Instances launch, you\n pay the current Spot price. To remove a maximum price that you previously set, include\n the property but specify an empty string (\"\") for the value.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently\n than if you do not specify one.

\n \n

Valid Range: Minimum value of 0.001

" + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n your maximum price is lower than the Spot price for the instance types that you\n selected, your Spot Instances are not launched. We do not recommend specifying a maximum\n price because it can lead to increased interruptions. When Spot Instances launch, you\n pay the current Spot price. To remove a maximum price that you previously set, include\n the property but specify an empty string (\"\") for the value.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently\n than if you do not specify one.

\n \n

Valid Range: Minimum value of 0.001

" } } }, @@ -6740,7 +6906,7 @@ "KeyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the key pair.

\n

For more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

The name of the key pair.

\n

For more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.

" } }, "SecurityGroups": { @@ -6795,7 +6961,7 @@ "InstanceMonitoring": { "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { - "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "SpotPrice": { @@ -6832,7 +6998,7 @@ "PlacementTenancy": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.

\n

For more information, see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.

\n

For more information, see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "MetadataOptions": { @@ -6870,7 +7036,7 @@ "LaunchConfigurationNames": { "target": "com.amazonaws.autoscaling#LaunchConfigurationNames", "traits": { - "smithy.api#documentation": "

The launch configuration names. If you omit this property, all launch configurations\n are described.

\n

Array Members: Maximum number of 50 items.

" + "smithy.api#documentation": "

The launch configuration names. If you omit this property, all launch configurations\n are described.

\n

Array Members: Maximum number of 50 items.

" } }, "NextToken": { @@ -6947,30 +7113,30 @@ "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The instance type, such as m3.xlarge. You must specify an instance type\n that is supported in your requested Region and Availability Zones. For more information,\n see Instance types in the Amazon Elastic Compute Cloud User\n Guide.

\n

You can specify up to 40 instance types per Auto Scaling group.

" + "smithy.api#documentation": "

The instance type, such as m3.xlarge. You must specify an instance type\n that is supported in your requested Region and Availability Zones. For more information,\n see Instance types in the Amazon Elastic Compute Cloud User\n Guide.

\n

You can specify up to 40 instance types per Auto Scaling group.

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

If you provide a list of instance types to use, you can specify the number of capacity\n units provided by each instance type in terms of virtual CPUs, memory, storage,\n throughput, or other relative performance characteristic. When a Spot or On-Demand\n Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling\n launches instances until the desired capacity is totally fulfilled, even if this results\n in an overage. For example, if there are two units remaining to fulfill capacity, and\n Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units,\n the 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.

\n

If you specify a value for WeightedCapacity for one instance type, you\n must specify a value for WeightedCapacity for all of them.

\n \n

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

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

If you provide a list of instance types to use, you can specify the number of capacity\n units provided by each instance type in terms of virtual CPUs, memory, storage,\n throughput, or other relative performance characteristic. When a Spot or On-Demand\n Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling\n launches instances until the desired capacity is totally fulfilled, even if this results\n in an overage. For example, if there are two units remaining to fulfill capacity, and\n Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units,\n the 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.

\n

If you specify a value for WeightedCapacity for one instance type, you\n must specify a value for WeightedCapacity for all of them.

\n \n

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

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

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

\n

You can specify up to 20 launch templates per Auto Scaling group. The launch templates\n specified in the overrides and in the LaunchTemplate definition count\n towards this limit.

" + "smithy.api#documentation": "

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

\n

You can specify up to 20 launch templates per Auto Scaling group. The launch templates\n specified in the overrides and in the LaunchTemplate definition count\n towards this limit.

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

The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify\n instance types. Then, it uses your On-Demand and Spot allocation strategies to launch\n instances from these instance types.

\n

You can specify up to four separate sets of instance requirements per Auto Scaling group. This\n is useful for provisioning instances from different Amazon Machine Images (AMIs) in the\n same Auto Scaling group. To do this, create the AMIs and create a new launch template for each\n AMI. Then, create a compatible set of instance requirements for each launch template.\n

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

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

The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify\n instance types. Then, it uses your On-Demand and Spot allocation strategies to launch\n instances from these instance types.

\n

You can specify up to four separate sets of instance requirements per Auto Scaling group. This\n is useful for provisioning instances from different Amazon Machine Images (AMIs) in the\n same Auto Scaling group. To do this, create the AMIs and create a new launch template for each\n AMI. Then, create a compatible set of instance requirements for each launch template.\n

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

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

Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed\n instances policy:

\n \n

Specify the instance types that you want, or define your instance requirements instead\n and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements.\n This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when\n fulfilling Spot and On-Demand capacities. You can view which instance types are matched\n before you apply the instance requirements to your Auto Scaling group.

\n

After you define your instance requirements, you don't have to keep updating these\n settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance\n requirements of the Auto Scaling group to determine whether a new EC2 instance type can be\n used.

" + "smithy.api#documentation": "

Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed\n instances policy:

\n \n

Specify the instance types that you want, or define your instance requirements instead\n and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements.\n This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when\n fulfilling Spot and On-Demand capacities. You can view which instance types are matched\n before you apply the instance requirements to your Auto Scaling group.

\n

After you define your instance requirements, you don't have to keep updating these\n settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance\n requirements of the Auto Scaling group to determine whether a new EC2 instance type can be\n used.

" } }, "com.amazonaws.autoscaling#LaunchTemplateSpecification": { @@ -6979,13 +7145,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.

\n

Conditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.

" + "smithy.api#documentation": "

The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.

\n

Conditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.

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

The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.

\n

Conditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.

" + "smithy.api#documentation": "

The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.

\n

Conditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.

" } }, "Version": { @@ -7029,7 +7195,7 @@ "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { - "smithy.api#documentation": "

The lifecycle transition.

\n

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING |\n autoscaling:EC2_INSTANCE_TERMINATING\n

" + "smithy.api#documentation": "

The lifecycle transition.

\n

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING |\n autoscaling:EC2_INSTANCE_TERMINATING\n

" } }, "NotificationTargetARN": { @@ -7065,7 +7231,7 @@ "DefaultResult": { "target": "com.amazonaws.autoscaling#LifecycleActionResult", "traits": { - "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs.

\n

Valid values: CONTINUE | ABANDON\n

" + "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs.

\n

Valid values: CONTINUE | ABANDON\n

" } } }, @@ -7098,7 +7264,7 @@ "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { - "smithy.api#documentation": "

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.

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

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.

\n ", "smithy.api#required": {} } }, @@ -7117,7 +7283,7 @@ "DefaultResult": { "target": "com.amazonaws.autoscaling#LifecycleActionResult", "traits": { - "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.

\n

Valid values: CONTINUE | ABANDON\n

" + "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.

\n

Valid values: CONTINUE | ABANDON\n

" } }, "NotificationTargetARN": { @@ -7129,12 +7295,12 @@ "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 information about creating this role, see Configure a notification target for a lifecycle hook in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid only if the notification target is 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. For information about creating this role, see Configure a notification target for a lifecycle hook in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

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

Describes information used to specify a lifecycle hook for an Auto Scaling\n group.

\n \n \n \n

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

" + "smithy.api#documentation": "

Describes information used to specify a lifecycle hook for an Auto Scaling\n group.

\n

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

" } }, "com.amazonaws.autoscaling#LifecycleHookSpecifications": { @@ -7333,7 +7499,7 @@ "State": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

One of the following load balancer states:

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

One of the following load balancer states:

\n " } } }, @@ -7359,7 +7525,7 @@ "State": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The state of the target group.

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

The state of the target group.

\n " } } }, @@ -7535,7 +7701,7 @@ "Dimensions": { "target": "com.amazonaws.autoscaling#MetricDimensions", "traits": { - "smithy.api#documentation": "

The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services\n documentation available from the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" + "smithy.api#documentation": "

The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services\n documentation available from the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" } } }, @@ -7549,7 +7715,7 @@ "Metric": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

One of the following metrics:

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

One of the following metrics:

\n " } } }, @@ -7582,13 +7748,13 @@ "Expression": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" + "smithy.api#documentation": "

The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

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

Information about the metric data to return.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" + "smithy.api#documentation": "

Information about the metric data to return.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" } }, "Label": { @@ -7600,12 +7766,12 @@ "ReturnData": { "target": "com.amazonaws.autoscaling#ReturnData", "traits": { - "smithy.api#documentation": "

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" + "smithy.api#documentation": "

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

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

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.

\n \n \n

For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.

\n

For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#MetricDimension": { @@ -7684,7 +7850,7 @@ "Stat": { "target": "com.amazonaws.autoscaling#XmlStringMetricStat", "traits": { - "smithy.api#documentation": "

The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metrics for predictive scaling are Average and\n Sum.

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

The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metrics for predictive scaling are Average and\n Sum.

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

This structure defines the CloudWatch metric to return, along with the statistic, period,\n and unit.

\n \n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" + "smithy.api#documentation": "

This structure defines the CloudWatch metric to return, along with the statistic, period,\n and unit.

\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" } }, "com.amazonaws.autoscaling#MetricStatistic": { @@ -7807,7 +7973,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use this structure to launch multiple instance types and On-Demand Instances and Spot\n Instances within a single Auto Scaling group.

\n

A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch\n instances and help optimize your costs. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Use this structure to launch multiple instance types and On-Demand Instances and Spot\n Instances within a single Auto Scaling group.

\n

A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch\n instances and help optimize your costs. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#MonitoringEnabled": { @@ -7830,7 +7996,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the NetworkBandwidthGbps object\n when you specify InstanceRequirements for an Auto Scaling group.

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve\n the minimum bandwidth. Amazon EC2 will identify instance types that support the specified\n minimum bandwidth, but the actual bandwidth of your instance might go below the\n specified minimum at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide for Linux Instances.

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

Specifies the minimum and maximum for the NetworkBandwidthGbps object\n when you specify InstanceRequirements for an Auto Scaling group.

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve\n the minimum bandwidth. Amazon EC2 will identify instance types that support the specified\n minimum bandwidth, but the actual bandwidth of your instance might go below the\n specified minimum at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide for Linux Instances.

\n " } }, "com.amazonaws.autoscaling#NetworkInterfaceCountRequest": { @@ -7883,7 +8049,7 @@ "NotificationType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

One of the following event notification types:

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

One of the following event notification types:

\n " } } }, @@ -8060,14 +8226,14 @@ "PredefinedMetricType": { "target": "com.amazonaws.autoscaling#MetricType", "traits": { - "smithy.api#documentation": "

The metric type. The following predefined metrics are available:

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

The metric type. The following predefined metrics are available:

\n ", "smithy.api#required": {} } }, "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group\n from which to determine the average request count served by your Auto Scaling group. You can't\n specify a resource label unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group\n from which to determine the average request count served by your Auto Scaling group. You can't\n specify a resource label unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" } } }, @@ -8110,7 +8276,7 @@ "MetricSpecifications": { "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications", "traits": { - "smithy.api#documentation": "

This structure includes the metrics and target utilization to use for predictive\n scaling.

\n

This is an array, but we currently only support a single metric specification. That\n is, you can specify a target value and a single metric pair, or a target value and one\n scaling metric and one load metric.

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

This structure includes the metrics and target utilization to use for predictive\n scaling.

\n

This is an array, but we currently only support a single metric specification. That\n is, you can specify a target value and a single metric pair, or a target value and one\n scaling metric and one load metric.

", "smithy.api#required": {} } }, @@ -8123,19 +8289,19 @@ "SchedulingBufferTime": { "target": "com.amazonaws.autoscaling#PredictiveScalingSchedulingBufferTime", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, by which the instance launch time can be advanced. For\n example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch\n instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The\n intention is to give resources time to be provisioned. It can take a few minutes to\n launch an EC2 instance. The actual amount of time required depends on several factors,\n such as the size of the instance and whether there are startup scripts to complete.

\n

The value must be less than the forecast interval duration of 3600 seconds (60\n minutes). Defaults to 300 seconds if not specified.

" + "smithy.api#documentation": "

The amount of time, in seconds, by which the instance launch time can be advanced. For\n example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch\n instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The\n intention is to give resources time to be provisioned. It can take a few minutes to\n launch an EC2 instance. The actual amount of time required depends on several factors,\n such as the size of the instance and whether there are startup scripts to complete.

\n

The value must be less than the forecast interval duration of 3600 seconds (60\n minutes). Defaults to 300 seconds if not specified.

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

Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity of the Auto Scaling group. Defaults to\n HonorMaxCapacity if not specified.

\n

The following are possible values:

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

Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity of the Auto Scaling group. Defaults to\n HonorMaxCapacity if not specified.

\n

The following are possible values:

\n " } }, "MaxCapacityBuffer": { "target": "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBuffer", "traits": { - "smithy.api#documentation": "

The size of the capacity buffer to use when the forecast capacity is close to or\n exceeds the maximum capacity. The value is specified as a percentage relative to the\n forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\n such that if the forecast capacity is 50, and the maximum capacity is 40, then the\n effective maximum capacity is 55.

\n

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but\n not exceed forecast capacity.

\n

Required if the MaxCapacityBreachBehavior property is set to\n IncreaseMaxCapacity, and cannot be used otherwise.

" + "smithy.api#documentation": "

The size of the capacity buffer to use when the forecast capacity is close to or\n exceeds the maximum capacity. The value is specified as a percentage relative to the\n forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\n such that if the forecast capacity is 50, and the maximum capacity is 40, then the\n effective maximum capacity is 55.

\n

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but\n not exceed forecast capacity.

\n

Required if the MaxCapacityBreachBehavior property is set to\n IncreaseMaxCapacity, and cannot be used otherwise.

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

Specifies the target utilization.

\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#documentation": "

Specifies the target utilization.

\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": {} } }, @@ -8274,7 +8440,7 @@ } }, "traits": { - "smithy.api#documentation": "

This structure specifies the metrics and target utilization settings for a predictive\n scaling policy.

\n

You must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.

\n

Example

\n \n

For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

This structure specifies the metrics and target utilization settings for a predictive\n scaling policy.

\n

You must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.

\n

Example

\n \n

For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications": { @@ -8313,12 +8479,12 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the request count served by your Auto Scaling group. You can't specify a resource label unless\n the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the request count served by your Auto Scaling group. You can't specify a resource label unless\n the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

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

Describes a load metric for a predictive scaling policy.

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" + "smithy.api#documentation": "

Describes a load metric for a predictive scaling policy.

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" } }, "com.amazonaws.autoscaling#PredictiveScalingPredefinedMetricPair": { @@ -8334,7 +8500,7 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the total and average request count served by your Auto Scaling group. You can't specify a\n resource label unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the total and average request count served by your Auto Scaling group. You can't specify a\n resource label unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" } } }, @@ -8355,12 +8521,12 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the average request count served by your Auto Scaling group. You can't specify a resource label\n unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the average request count served by your Auto Scaling group. You can't specify a resource label\n unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

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

Describes a scaling metric for a predictive scaling policy.

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" + "smithy.api#documentation": "

Describes a scaling metric for a predictive scaling policy.

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" } }, "com.amazonaws.autoscaling#PredictiveScalingSchedulingBufferTime": { @@ -8383,13 +8549,13 @@ "ProcessName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

One of the following processes:

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

One of the following processes:

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

Describes a process type.

\n

For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Describes a process type.

\n

For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#Processes": { @@ -8438,7 +8604,7 @@ } ], "traits": { - "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.

" + "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": { @@ -8465,19 +8631,19 @@ "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { - "smithy.api#documentation": "

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.

\n \n

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

" + "smithy.api#documentation": "

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.

\n \n

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

" } }, "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.

\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.

" + "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": { "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify\n you when an instance is in a wait state for the lifecycle hook. You can specify either\n an Amazon SNS topic or an Amazon SQS queue.

\n

If you specify an empty string, this overrides the current ARN.

\n

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and\n an email key-value pair format when sending notifications to an Amazon SNS topic.

\n

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify\n you when an instance is in a wait state for the lifecycle hook. You can specify either\n an Amazon SNS topic or an Amazon SQS queue.

\n

If you specify an empty string, this overrides the current ARN.

\n

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and\n an email key-value pair format when sending notifications to an Amazon SNS topic.

\n

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".

" } }, "NotificationMetadata": { @@ -8495,7 +8661,7 @@ "DefaultResult": { "target": "com.amazonaws.autoscaling#LifecycleActionResult", "traits": { - "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.

\n

Valid values: CONTINUE | ABANDON\n

" + "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.

\n

Valid values: CONTINUE | ABANDON\n

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

Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.

\n

This configuration overwrites any existing configuration.

\n

For more information, see Getting Amazon SNS\n notifications when your Auto Scaling group scales in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.

" + "smithy.api#documentation": "

Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.

\n

This configuration overwrites any existing configuration.

\n

For more information, see Getting Amazon SNS\n notifications when your Auto Scaling group scales in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.

" } }, "com.amazonaws.autoscaling#PutNotificationConfigurationType": { @@ -8569,7 +8735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.

\n

For more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

\n

For more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.

" + "smithy.api#documentation": "

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.

\n

For more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

\n

For more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.

" } }, "com.amazonaws.autoscaling#PutScalingPolicyType": { @@ -8592,13 +8758,13 @@ "PolicyType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "

One of the following policy types:

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

One of the following policy types:

\n " } }, "AdjustmentType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

Required if the policy type is StepScaling or SimpleScaling.\n For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

Required if the policy type is StepScaling or SimpleScaling.\n For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

" } }, "MinAdjustmentStep": { @@ -8610,43 +8776,43 @@ "MinAdjustmentMagnitude": { "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", "traits": { - "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.

\n

Valid only if the policy type is StepScaling or\n SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User\n Guide.

\n \n

Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude to a value that is at least as large as your\n largest instance weight.

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

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.

\n

Valid only if the policy type is StepScaling or\n SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User\n Guide.

\n \n

Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude to a value that is at least as large as your\n largest instance weight.

\n " } }, "ScalingAdjustment": { "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a positive value.

\n

Required if the policy type is SimpleScaling. (Not used with any other\n policy type.)

" + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a positive value.

\n

Required if the policy type is SimpleScaling. (Not used with any other\n policy type.)

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

A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: None

" + "smithy.api#documentation": "

A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: None

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

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

\n

Valid only if the policy type is StepScaling.

" + "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

\n

Valid only if the policy type is StepScaling.

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

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

Required if the policy type is StepScaling. (Not used with any other\n policy type.)

" + "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

Required if the policy type is StepScaling. (Not used with any other\n policy type.)

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

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This warm-up period applies to instances launched due to a specific target\n tracking or step scaling policy. When a warm-up period is specified here, it overrides\n the default instance warmup.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then EstimatedInstanceWarmup\n falls back to the value of default cooldown.

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

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This warm-up period applies to instances launched due to a specific target\n tracking or step scaling policy. When a warm-up period is specified here, it overrides\n the default instance warmup.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then EstimatedInstanceWarmup\n falls back to the value of default cooldown.

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

A target tracking scaling policy. Provides support for predefined or custom\n metrics.

\n

The following predefined metrics are available:

\n \n

If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel property with the\n PredefinedMetricSpecification.

\n

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is TargetTrackingScaling.

" + "smithy.api#documentation": "

A target tracking scaling policy. Provides support for predefined or custom\n metrics.

\n

The following predefined metrics are available:

\n \n

If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel property with the\n PredefinedMetricSpecification.

\n

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is TargetTrackingScaling.

" } }, "Enabled": { @@ -8658,7 +8824,7 @@ "PredictiveScalingConfiguration": { "target": "com.amazonaws.autoscaling#PredictiveScalingConfiguration", "traits": { - "smithy.api#documentation": "

A predictive scaling policy. Provides support for predefined and custom\n metrics.

\n

Predefined metrics include CPU utilization, network in/out, and the Application Load\n Balancer request count.

\n

For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is PredictiveScaling.

" + "smithy.api#documentation": "

A predictive scaling policy. Provides support for predefined and custom\n metrics.

\n

Predefined metrics include CPU utilization, network in/out, and the Application Load\n Balancer request count.

\n

For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is PredictiveScaling.

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

Creates or updates a scheduled scaling action for an Auto Scaling group.

\n

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

\n

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" + "smithy.api#documentation": "

Creates or updates a scheduled scaling action for an Auto Scaling group.

\n

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

\n

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" } }, "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { @@ -8712,7 +8878,7 @@ "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2021-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

" + "smithy.api#documentation": "

The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2021-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

" } }, "EndTime": { @@ -8724,7 +8890,7 @@ "Recurrence": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The recurring schedule for this action. This format consists of five fields separated\n by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value\n must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information\n about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

\n

Cron expressions use Universal Coordinated Time (UTC) by default.

" + "smithy.api#documentation": "

The recurring schedule for this action. This format consists of five fields separated\n by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value\n must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information\n about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

\n

Cron expressions use Universal Coordinated Time (UTC) by default.

" } }, "MinSize": { @@ -8742,13 +8908,13 @@ "DesiredCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.

\n \n

You must specify at least one of the following properties: MaxSize,\n MinSize, or DesiredCapacity.

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

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.

\n \n

You must specify at least one of the following properties: MaxSize,\n MinSize, or DesiredCapacity.

\n " } }, "TimeZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.

\n

Valid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

" + "smithy.api#documentation": "

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.

\n

Valid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

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

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity. For more information and example configurations, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

This operation must be called from the Region in which the Auto Scaling group was created.\n This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a\n launch template or launch configuration that requests Spot Instances.

\n

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.

" + "smithy.api#documentation": "

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity. For more information and example configurations, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

This operation must be called from the Region in which the Auto Scaling group was created.\n This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a\n launch template or launch configuration that requests Spot Instances.

\n

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.

" } }, "com.amazonaws.autoscaling#PutWarmPoolAnswer": { @@ -8790,7 +8956,7 @@ "MaxGroupPreparedCapacity": { "target": "com.amazonaws.autoscaling#MaxGroupPreparedCapacity", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of instances that are allowed to be in the warm pool or\n in any state except Terminated for the Auto Scaling group. This is an optional\n property. Specify it only if you do not want the warm pool size to be determined by the\n difference between the group's maximum capacity and its desired capacity.

\n \n

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling\n launches and maintains the difference between the group's maximum capacity and its\n desired capacity. If you specify a value for MaxGroupPreparedCapacity,\n Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and\n the desired capacity instead.

\n

The size of the warm pool is dynamic. Only when\n MaxGroupPreparedCapacity and MinSize are set to the\n same value does the warm pool have an absolute size.

\n \n

If the desired capacity of the Auto Scaling group is higher than the\n MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless\n you specify a value for MinSize. To remove a value that you previously set,\n include the property but specify -1 for the value.

" + "smithy.api#documentation": "

Specifies the maximum number of instances that are allowed to be in the warm pool or\n in any state except Terminated for the Auto Scaling group. This is an optional\n property. Specify it only if you do not want the warm pool size to be determined by the\n difference between the group's maximum capacity and its desired capacity.

\n \n

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling\n launches and maintains the difference between the group's maximum capacity and its\n desired capacity. If you specify a value for MaxGroupPreparedCapacity,\n Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and\n the desired capacity instead.

\n

The size of the warm pool is dynamic. Only when\n MaxGroupPreparedCapacity and MinSize are set to the\n same value does the warm pool have an absolute size.

\n \n

If the desired capacity of the Auto Scaling group is higher than the\n MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless\n you specify a value for MinSize. To remove a value that you previously set,\n include the property but specify -1 for the value.

" } }, "MinSize": { @@ -8827,7 +8993,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 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.

" + "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": { @@ -8879,19 +9045,19 @@ "MinHealthyPercentage": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { - "smithy.api#documentation": "

The amount of capacity in the Auto Scaling group that must pass your group's health checks to\n allow the operation to continue. The value is expressed as a percentage of the desired\n capacity of the Auto Scaling group (rounded up to the nearest integer). The default is\n 90.

\n

Setting the minimum healthy percentage to 100 percent limits the rate of replacement\n to one instance at a time. In contrast, setting it to 0 percent has the effect of\n replacing all instances at the same time.

" + "smithy.api#documentation": "

The amount of capacity in the Auto Scaling group that must pass your group's health checks to\n allow the operation to continue. The value is expressed as a percentage of the desired\n capacity of the Auto Scaling group (rounded up to the nearest integer). The default is\n 90.

\n

Setting the minimum healthy percentage to 100 percent limits the rate of replacement\n to one instance at a time. In contrast, setting it to 0 percent has the effect of\n replacing all instances at the same time.

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

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The duration of the instance warmup, in seconds.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then InstanceWarmup falls\n back to the value of the health check grace period.

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

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The duration of the instance warmup, in seconds.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then InstanceWarmup falls\n back to the value of the health check grace period.

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

Threshold values for each checkpoint in ascending order. Each number must be unique.\n To replace all instances in the Auto Scaling group, the last number in the array must be\n 100.

\n

For usage examples, see Adding\n checkpoints to an instance refresh in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Threshold values for each checkpoint in ascending order. Each number must be unique.\n To replace all instances in the Auto Scaling group, the last number in the array must be\n 100.

\n

For usage examples, see Adding\n checkpoints to an instance refresh in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "CheckpointDelay": { @@ -8989,7 +9155,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.

\n

For more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.

\n

For more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#ReturnData": { @@ -9125,7 +9291,7 @@ "PolicyType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "

One of the following policy types:

\n \n

For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

One of the following policy types:

\n \n

For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

" } }, "AdjustmentType": { @@ -9221,7 +9387,7 @@ "ScalingProcesses": { "target": "com.amazonaws.autoscaling#ProcessNames", "traits": { - "smithy.api#documentation": "

One or more of the following processes:

\n \n

If you omit this property, all processes are specified.

" + "smithy.api#documentation": "

One or more of the following processes:

\n \n

If you omit this property, all processes are specified.

" } } } @@ -9291,7 +9457,7 @@ "Recurrence": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" + "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" } }, "MinSize": { @@ -9336,7 +9502,7 @@ "StartTime": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "

The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

\n

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" + "smithy.api#documentation": "

The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

\n

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" } }, "EndTime": { @@ -9348,7 +9514,7 @@ "Recurrence": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

\n

Cron expressions use Universal Coordinated Time (UTC) by default.

" + "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

\n

Cron expressions use Universal Coordinated Time (UTC) by default.

" } }, "MinSize": { @@ -9372,7 +9538,7 @@ "TimeZone": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.

\n

Valid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

" + "smithy.api#documentation": "

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.

\n

Valid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

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

Sets the size of the specified Auto Scaling group.

\n

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

\n

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

" + "smithy.api#documentation": "

Sets the size of the specified Auto Scaling group.

\n

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

\n

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

" } }, "com.amazonaws.autoscaling#SetDesiredCapacityType": { @@ -9474,7 +9640,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the health status of the specified instance.

\n

For more information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Sets the health status of the specified instance.

\n

For more information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#SetInstanceHealthQuery": { @@ -9497,7 +9663,7 @@ "ShouldRespectGracePeriod": { "target": "com.amazonaws.autoscaling#ShouldRespectGracePeriod", "traits": { - "smithy.api#documentation": "

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.

\n \n

For more information about the health check grace\n period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API\n Reference.

" + "smithy.api#documentation": "

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.

\n

For more information about the health check grace\n period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API\n Reference.

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

Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.

\n

For more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.

" + "smithy.api#documentation": "

Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.

\n

For more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.

" } }, "com.amazonaws.autoscaling#SetInstanceProtectionAnswer": { @@ -9593,7 +9759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new instance refresh operation. An instance refresh performs a rolling\n replacement of all or some instances in an Auto Scaling group. Each instance is terminated first\n and then replaced, which temporarily reduces the capacity available within your Auto Scaling\n group.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.

\n

If the call succeeds, it creates a new instance refresh request with a unique ID that\n you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh operation in progress, use the CancelInstanceRefresh\n API.

" + "smithy.api#documentation": "

Starts a new instance refresh operation. An instance refresh performs a rolling\n replacement of all or some instances in an Auto Scaling group. Each instance is terminated first\n and then replaced, which temporarily reduces the capacity available within your Auto Scaling\n group.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.

\n

If the call succeeds, it creates a new instance refresh request with a unique ID that\n you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh operation in progress, use the CancelInstanceRefresh\n API.

" } }, "com.amazonaws.autoscaling#StartInstanceRefreshAnswer": { @@ -9620,13 +9786,13 @@ "Strategy": { "target": "com.amazonaws.autoscaling#RefreshStrategy", "traits": { - "smithy.api#documentation": "

The strategy to use for the instance refresh. The only valid value is\n Rolling.

\n

A rolling update helps you update your instances gradually. A rolling update can fail\n due to failed health checks or if instances are on standby or are protected from scale\n in. If the rolling update process fails, any instances that are replaced are not rolled\n back to their previous configuration.

" + "smithy.api#documentation": "

The strategy to use for the instance refresh. The only valid value is\n Rolling.

\n

A rolling update helps you update your instances gradually. A rolling update can fail\n due to failed health checks or if instances are on standby or are protected from scale\n in. If the rolling update process fails, any instances that are replaced are not rolled\n back to their previous configuration.

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

The desired configuration. For example, the desired configuration can specify a new\n launch template or a new version of the current launch template.

\n

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to\n reflect the new desired configuration.

\n \n

When you specify a new launch template or a new version of the current launch\n template for your desired configuration, consider enabling the\n SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling\n skips replacing instances that already use the specified launch template and\n version. This can help you reduce the number of replacements that are required to\n apply updates.

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

The desired configuration. For example, the desired configuration can specify a new\n launch template or a new version of the current launch template.

\n

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to\n reflect the new desired configuration.

\n \n

When you specify a new launch template or a new version of the current launch\n template for your desired configuration, consider enabling the\n SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling\n skips replacing instances that already use the specified launch template and\n version. This can help you reduce the number of replacements that are required to\n apply updates.

\n " } }, "Preferences": { @@ -9649,19 +9815,19 @@ "MetricIntervalUpperBound": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { - "smithy.api#documentation": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.

\n

The upper bound must be greater than the lower bound.

" + "smithy.api#documentation": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.

\n

The upper bound must be greater than the lower bound.

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

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

\n

The amount by which to scale. The adjustment is based on the value that you specified\n in the AdjustmentType property (either an absolute number or a percentage).\n A positive value adds to the current capacity and a negative number subtracts from the\n current capacity.

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

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

\n

The amount by which to scale. The adjustment is based on the value that you specified\n in the AdjustmentType property (either an absolute number or a percentage).\n A positive value adds to the current capacity and a negative number subtracts from the\n current capacity.

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

Describes information used to create a step adjustment for a step scaling\n policy.

\n

For the following examples, suppose that you have an alarm with a breach threshold of\n 50:

\n \n

There are a few rules for the step adjustments for your step policy:

\n \n

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

" + "smithy.api#documentation": "

Describes information used to create a step adjustment for a step scaling\n policy.

\n

For the following examples, suppose that you have an alarm with a breach threshold of\n 50:

\n \n

There are a few rules for the step adjustments for your step policy:

\n \n

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

" } }, "com.amazonaws.autoscaling#StepAdjustments": { @@ -9687,7 +9853,7 @@ } ], "traits": { - "smithy.api#documentation": "

Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.

\n

If you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

\n

To resume processes that have been suspended, call the ResumeProcesses API.

" + "smithy.api#documentation": "

Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.

\n

If you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

\n

To resume processes that have been suspended, call the ResumeProcesses API.

" } }, "com.amazonaws.autoscaling#SuspendedProcess": { @@ -9707,7 +9873,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an auto scaling process that has been suspended.

\n

For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Describes an auto scaling process that has been suspended.

\n

For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#SuspendedProcesses": { @@ -9866,7 +10032,7 @@ "TargetValue": { "target": "com.amazonaws.autoscaling#MetricScale", "traits": { - "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#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": {} } }, @@ -9881,6 +10047,78 @@ "smithy.api#documentation": "

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

" } }, + "com.amazonaws.autoscaling#TargetTrackingMetricDataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#TargetTrackingMetricDataQuery" + } + }, + "com.amazonaws.autoscaling#TargetTrackingMetricDataQuery": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

A short name that identifies the object's results in the response. This name must be\n unique among all TargetTrackingMetricDataQuery objects specified for a\n single scaling policy. If you are performing math expressions on this set of data, this\n name represents that data and can serve as a variable in the mathematical expression.\n The valid characters are letters, numbers, and underscores. The first character must be\n a lowercase letter.

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

The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.

\n

Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.

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

Information about the metric data to return.

\n

Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.

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

A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.

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

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

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

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.

" + } + }, + "com.amazonaws.autoscaling#TargetTrackingMetricStat": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.autoscaling#Metric", + "traits": { + "smithy.api#required": {} + } + }, + "Stat": { + "target": "com.amazonaws.autoscaling#XmlStringMetricStat", + "traits": { + "smithy.api#documentation": "

The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metrics for scaling is Average\n

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

The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum\n data type in the Amazon CloudWatch API Reference.

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

This structure defines the CloudWatch metric to return, along with the statistic, period,\n and unit.

\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" + } + }, "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroup": { "type": "operation", "input": { @@ -9898,7 +10136,7 @@ } ], "traits": { - "smithy.api#documentation": "

Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.

\n

This call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.

\n

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.

\n

This call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.

\n

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType": { @@ -9949,6 +10187,52 @@ "smithy.api#documentation": "

Specifies the minimum and maximum for the TotalLocalStorageGB object when\n you specify InstanceRequirements for an Auto Scaling group.

" } }, + "com.amazonaws.autoscaling#TrafficSourceIdentifier": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", + "traits": { + "smithy.api#documentation": "

The unique identifier of the traffic source.

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

Describes the identifier of a traffic source.

\n

Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice\n target group.

" + } + }, + "com.amazonaws.autoscaling#TrafficSourceState": { + "type": "structure", + "members": { + "TrafficSource": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", + "traits": { + "smithy.api#documentation": "

The unique identifier of the traffic source. Currently, this is the Amazon Resource\n Name (ARN) for a VPC Lattice target group.

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

The following are the possible states for a VPC Lattice target group:

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

Describes the state of a traffic source.

" + } + }, + "com.amazonaws.autoscaling#TrafficSourceStates": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#TrafficSourceState" + } + }, + "com.amazonaws.autoscaling#TrafficSources": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#TrafficSourceIdentifier" + } + }, "com.amazonaws.autoscaling#UpdateAutoScalingGroup": { "type": "operation", "input": { @@ -9969,7 +10253,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 the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties 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

To see which properties 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 property that you want\n to change. Any properties 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

To see which properties 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": { @@ -10009,7 +10293,7 @@ "MaxSize": { "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

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

The maximum size of the Auto Scaling group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n " } }, "DesiredCapacity": { @@ -10021,7 +10305,7 @@ "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" } }, "AvailabilityZones": { @@ -10033,19 +10317,19 @@ "HealthCheckType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "

The service to use for the health checks. The valid values are EC2 and\n ELB. If you configure an Auto Scaling group to use ELB health\n checks, it considers the instance unhealthy if it fails either the EC2 status checks or\n the load balancer health checks.

" + "smithy.api#documentation": "

Determines whether any additional health checks are performed on the instances in this\n group. Amazon EC2 health checks are always on.

\n

The valid values are EC2 (default), ELB, and\n VPC_LATTICE. The VPC_LATTICE health check type is reserved\n for use with VPC Lattice, which is in preview release and is subject to change.

" } }, "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 Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the InService state. For more\n information, see Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "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. This is useful if your instances do not immediately pass their health\n checks after they enter the InService state. For more information, see\n Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

The name of an existing placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

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

The name of an existing placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " } }, "VPCZoneIdentifier": { @@ -10057,7 +10341,7 @@ "TerminationPolicies": { "target": "com.amazonaws.autoscaling#TerminationPolicies", "traits": { - "smithy.api#documentation": "

A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n

" + "smithy.api#documentation": "

A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n

" } }, "NewInstancesProtectedFromScaleIn": { @@ -10093,13 +10377,13 @@ "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. 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.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

" + "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. 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.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

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

The amount of time, in seconds, until a newly launched instance can contribute to the\n Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling\n aggregates instance metrics, resulting in more reliable usage data. Set this value equal\n to the amount of time that it takes for resource consumption to become stable after an\n instance reaches the InService state. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage your warm-up settings at the group level, we recommend that you set the\n default instance warmup, even if its value is set to 0 seconds.\n This also optimizes the performance of scaling policies that scale continuously,\n such as target tracking and step scaling policies.

\n

If you need to remove a value that you previously set, include the property but\n specify -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a minimum value of\n 0.

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

The amount of time, in seconds, until a newly launched instance can contribute to the\n Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling\n aggregates instance metrics, resulting in more reliable usage data. Set this value equal\n to the amount of time that it takes for resource consumption to become stable after an\n instance reaches the InService state. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage your warm-up settings at the group level, we recommend that you set the\n default instance warmup, even if its value is set to 0 seconds.\n This also optimizes the performance of scaling policies that scale continuously,\n such as target tracking and step scaling policies.

\n

If you need to remove a value that you previously set, include the property but\n specify -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a minimum value of\n 0.

\n " } } } diff --git a/codegen/sdk-codegen/aws-models/backup-gateway.2021-01-01.json b/codegen/sdk-codegen/aws-models/backup-gateway.2021-01-01.json index e228eb07479..57df76a292f 100644 --- a/codegen/sdk-codegen/aws-models/backup-gateway.2021-01-01.json +++ b/codegen/sdk-codegen/aws-models/backup-gateway.2021-01-01.json @@ -42,12 +42,6 @@ "errors": [ { "target": "com.amazonaws.backupgateway#ConflictException" - }, - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -84,6 +78,15 @@ } } }, + "com.amazonaws.backupgateway#AverageUploadRateLimit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 51200, + "max": 8000000000000 + } + } + }, "com.amazonaws.backupgateway#BackupOnPremises_v20210101": { "type": "service", "version": "2021-01-01", @@ -110,8 +113,14 @@ } ], "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, { "target": "com.amazonaws.backupgateway#ThrottlingException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -138,7 +147,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -187,15 +196,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -458,9 +458,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-south-1" } }, { @@ -471,9 +471,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-south-1" } }, { @@ -484,9 +484,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-south-1" } }, { @@ -497,9 +497,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-south-1" } }, { @@ -510,9 +510,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-south-1" } }, { @@ -523,9 +523,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-south-1" } }, { @@ -536,9 +536,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-south-1" } }, { @@ -549,9 +549,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-south-1" } }, { @@ -562,9 +562,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-gov-east-1" } }, { @@ -575,9 +575,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-gov-east-1" } }, { @@ -588,9 +588,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-gov-east-1" } }, { @@ -601,9 +601,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-gov-east-1" } }, { @@ -614,9 +614,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -627,9 +627,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -640,9 +640,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -653,9 +653,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -666,9 +666,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -679,9 +679,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -692,9 +692,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -705,9 +705,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -718,9 +718,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-1" } }, { @@ -731,9 +731,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-1" } }, { @@ -744,9 +744,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-1" } }, { @@ -757,9 +757,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-1" } }, { @@ -770,9 +770,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -783,9 +783,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -796,9 +796,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -809,9 +809,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -822,9 +822,9 @@ } }, "params": { - "Region": "af-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "af-south-1" } }, { @@ -835,9 +835,9 @@ } }, "params": { - "Region": "af-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "af-south-1" } }, { @@ -848,9 +848,9 @@ } }, "params": { - "Region": "af-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "af-south-1" } }, { @@ -861,9 +861,9 @@ } }, "params": { - "Region": "af-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "af-south-1" } }, { @@ -874,9 +874,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-north-1" } }, { @@ -887,9 +887,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-north-1" } }, { @@ -900,9 +900,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-north-1" } }, { @@ -913,9 +913,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-north-1" } }, { @@ -926,9 +926,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-3" } }, { @@ -939,9 +939,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-3" } }, { @@ -952,9 +952,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-3" } }, { @@ -965,9 +965,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-3" } }, { @@ -978,9 +978,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -991,9 +991,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -1004,9 +1004,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -1017,9 +1017,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -1030,9 +1030,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -1043,9 +1043,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -1056,9 +1056,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -1069,9 +1069,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -1082,9 +1082,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-3" } }, { @@ -1095,9 +1095,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-3" } }, { @@ -1108,9 +1108,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-3" } }, { @@ -1121,9 +1121,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-3" } }, { @@ -1134,9 +1134,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -1147,9 +1147,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -1160,9 +1160,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -1173,9 +1173,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -1186,9 +1186,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -1199,9 +1199,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -1212,9 +1212,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -1225,9 +1225,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -1238,9 +1238,9 @@ } }, "params": { - "Region": "me-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "me-south-1" } }, { @@ -1251,9 +1251,9 @@ } }, "params": { - "Region": "me-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "me-south-1" } }, { @@ -1264,9 +1264,9 @@ } }, "params": { - "Region": "me-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "me-south-1" } }, { @@ -1277,9 +1277,9 @@ } }, "params": { - "Region": "me-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "me-south-1" } }, { @@ -1290,9 +1290,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "sa-east-1" } }, { @@ -1303,9 +1303,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "sa-east-1" } }, { @@ -1316,9 +1316,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "sa-east-1" } }, { @@ -1329,9 +1329,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "sa-east-1" } }, { @@ -1342,9 +1342,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-east-1" } }, { @@ -1355,9 +1355,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-east-1" } }, { @@ -1368,9 +1368,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-east-1" } }, { @@ -1381,9 +1381,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-east-1" } }, { @@ -1394,9 +1394,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-gov-west-1" } }, { @@ -1407,9 +1407,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-gov-west-1" } }, { @@ -1420,9 +1420,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-gov-west-1" } }, { @@ -1433,9 +1433,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-gov-west-1" } }, { @@ -1446,9 +1446,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-1" } }, { @@ -1459,9 +1459,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-1" } }, { @@ -1472,9 +1472,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-1" } }, { @@ -1485,9 +1485,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-1" } }, { @@ -1498,9 +1498,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -1511,9 +1511,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -1524,9 +1524,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -1537,9 +1537,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -1550,9 +1550,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -1563,9 +1563,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -1576,9 +1576,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -1589,9 +1589,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -1602,9 +1602,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -1615,9 +1615,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -1628,9 +1628,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -1641,9 +1641,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -1654,9 +1654,9 @@ } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1666,9 +1666,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1678,9 +1678,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -1689,6 +1689,81 @@ } } }, + "com.amazonaws.backupgateway#BandwidthRateLimitInterval": { + "type": "structure", + "members": { + "AverageUploadRateLimitInBitsPerSec": { + "target": "com.amazonaws.backupgateway#AverageUploadRateLimit", + "traits": { + "smithy.api#documentation": "

The average upload rate limit component of the bandwidth rate limit \n interval, in bits per second. This field does not appear in the response if \n the upload rate limit is not set.

\n \n

For Backup Gateway, the minimum value is (Value).

\n " + } + }, + "StartHourOfDay": { + "target": "com.amazonaws.backupgateway#HourOfDay", + "traits": { + "smithy.api#documentation": "

The hour of the day to start the bandwidth rate limit interval.

", + "smithy.api#required": {} + } + }, + "EndHourOfDay": { + "target": "com.amazonaws.backupgateway#HourOfDay", + "traits": { + "smithy.api#documentation": "

The hour of the day to end the bandwidth rate limit interval.

", + "smithy.api#required": {} + } + }, + "StartMinuteOfHour": { + "target": "com.amazonaws.backupgateway#MinuteOfHour", + "traits": { + "smithy.api#documentation": "

The minute of the hour to start the bandwidth rate limit interval. The \n interval begins at the start of that minute. To begin an interval exactly at \n the start of the hour, use the value 0.

", + "smithy.api#required": {} + } + }, + "EndMinuteOfHour": { + "target": "com.amazonaws.backupgateway#MinuteOfHour", + "traits": { + "smithy.api#documentation": "

The minute of the hour to end the bandwidth rate limit interval.

\n \n

The bandwidth rate limit interval ends at the end of the minute. \n To end an interval at the end of an hour, use the value 59.

\n ", + "smithy.api#required": {} + } + }, + "DaysOfWeek": { + "target": "com.amazonaws.backupgateway#DaysOfWeek", + "traits": { + "smithy.api#documentation": "

The days of the week component of the bandwidth rate limit interval, \n represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents \n Saturday.

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

Describes a bandwidth rate limit interval for a gateway. A bandwidth \n rate limit schedule consists of one or more bandwidth rate limit intervals. \n A bandwidth rate limit interval defines a period of time on one or more days \n of the week, during which bandwidth rate limits are specified for uploading, \n downloading, or both.

" + } + }, + "com.amazonaws.backupgateway#BandwidthRateLimitIntervals": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#BandwidthRateLimitInterval" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.backupgateway#BandwidthRateLimitScheduleResource": { + "type": "resource", + "identifiers": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn" + } + }, + "put": { + "target": "com.amazonaws.backupgateway#PutBandwidthRateLimitSchedule" + }, + "read": { + "target": "com.amazonaws.backupgateway#GetBandwidthRateLimitSchedule" + } + }, "com.amazonaws.backupgateway#ConflictException": { "type": "structure", "members": { @@ -1717,14 +1792,6 @@ "output": { "target": "com.amazonaws.backupgateway#CreateGatewayOutput" }, - "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" - } - ], "traits": { "smithy.api#documentation": "

Creates a backup gateway. After you create a gateway, you can associate it with a server\n using the AssociateGatewayToServer operation.

" } @@ -1790,6 +1857,18 @@ } } }, + "com.amazonaws.backupgateway#DaysOfWeek": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#DayOfWeek" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7 + } + } + }, "com.amazonaws.backupgateway#DeleteGateway": { "type": "operation", "input": { @@ -1799,14 +1878,8 @@ "target": "com.amazonaws.backupgateway#DeleteGatewayOutput" }, "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -1850,13 +1923,10 @@ "target": "com.amazonaws.backupgateway#AccessDeniedException" }, { - "target": "com.amazonaws.backupgateway#InternalServerException" + "target": "com.amazonaws.backupgateway#ConflictException" }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -1899,14 +1969,8 @@ { "target": "com.amazonaws.backupgateway#ConflictException" }, - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -2079,6 +2143,11 @@ "target": "com.amazonaws.backupgateway#UpdateGatewaySoftwareNow" } ], + "resources": [ + { + "target": "com.amazonaws.backupgateway#BandwidthRateLimitScheduleResource" + } + ], "traits": { "aws.cloudformation#cfnResource": { "name": "Gateway" @@ -2102,70 +2171,199 @@ "target": "com.amazonaws.backupgateway#Gateway" } }, - "com.amazonaws.backupgateway#GetGateway": { + "com.amazonaws.backupgateway#GetBandwidthRateLimitSchedule": { "type": "operation", "input": { - "target": "com.amazonaws.backupgateway#GetGatewayInput" + "target": "com.amazonaws.backupgateway#GetBandwidthRateLimitScheduleInput" }, "output": { - "target": "com.amazonaws.backupgateway#GetGatewayOutput" + "target": "com.amazonaws.backupgateway#GetBandwidthRateLimitScheduleOutput" }, "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { - "smithy.api#documentation": "

By providing the ARN (Amazon Resource Name), this\n API returns the gateway.

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

Retrieves the bandwidth rate limit schedule for a specified gateway. \n By default, gateways do not have bandwidth rate limit schedules, which means \n no bandwidth rate limiting is in effect. Use this to get a gateway's \n bandwidth rate limit schedule.

", "smithy.api#readonly": {} } }, - "com.amazonaws.backupgateway#GetGatewayInput": { + "com.amazonaws.backupgateway#GetBandwidthRateLimitScheduleInput": { "type": "structure", "members": { "GatewayArn": { "target": "com.amazonaws.backupgateway#GatewayArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gateway.

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

The Amazon Resource Name (ARN) of the gateway. Use the \n \n ListGateways\n operation to return a list of gateways \n for your account and Amazon Web Services Region.

", "smithy.api#required": {} } } } }, - "com.amazonaws.backupgateway#GetGatewayOutput": { + "com.amazonaws.backupgateway#GetBandwidthRateLimitScheduleOutput": { "type": "structure", "members": { - "Gateway": { - "target": "com.amazonaws.backupgateway#GatewayDetails", + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", "traits": { - "smithy.api#documentation": "

By providing the ARN (Amazon Resource Name), this\n API returns the gateway.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gateway. Use the \n \n ListGateways\n operation to return a list of gateways \n for your account and Amazon Web Services Region.

" + } + }, + "BandwidthRateLimitIntervals": { + "target": "com.amazonaws.backupgateway#BandwidthRateLimitIntervals", + "traits": { + "smithy.api#documentation": "

An array containing bandwidth rate limit schedule intervals for a gateway. \n When no bandwidth rate limit intervals have been scheduled, the array is empty.

" } } } }, - "com.amazonaws.backupgateway#GetVirtualMachine": { + "com.amazonaws.backupgateway#GetGateway": { "type": "operation", "input": { - "target": "com.amazonaws.backupgateway#GetVirtualMachineInput" + "target": "com.amazonaws.backupgateway#GetGatewayInput" }, "output": { - "target": "com.amazonaws.backupgateway#GetVirtualMachineOutput" + "target": "com.amazonaws.backupgateway#GetGatewayOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

By providing the ARN (Amazon Resource Name), this\n API returns the gateway.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.backupgateway#GetGatewayInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gateway.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#GetGatewayOutput": { + "type": "structure", + "members": { + "Gateway": { + "target": "com.amazonaws.backupgateway#GatewayDetails", + "traits": { + "smithy.api#documentation": "

By providing the ARN (Amazon Resource Name), this\n API returns the gateway.

" + } + } + } + }, + "com.amazonaws.backupgateway#GetHypervisor": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#GetHypervisorInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#GetHypervisorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

This action requests information about the specified hypervisor to which the gateway will connect. \n A hypervisor is hardware, software, or firmware that creates and manages virtual machines, \n and allocates resources to them.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.backupgateway#GetHypervisorInput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hypervisor.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#GetHypervisorOutput": { + "type": "structure", + "members": { + "Hypervisor": { + "target": "com.amazonaws.backupgateway#HypervisorDetails", + "traits": { + "smithy.api#documentation": "

Details about the requested hypervisor.

" + } + } + } + }, + "com.amazonaws.backupgateway#GetHypervisorPropertyMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#GetHypervisorPropertyMappingsInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#GetHypervisorPropertyMappingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

This action retrieves the property mappings for the specified hypervisor. \n A hypervisor property mapping displays the relationship of entity properties \n available from the on-premises hypervisor to the properties available in Amazon Web Services.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.backupgateway#GetHypervisorPropertyMappingsInput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hypervisor.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#GetHypervisorPropertyMappingsOutput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hypervisor.

" + } + }, + "VmwareToAwsTagMappings": { + "target": "com.amazonaws.backupgateway#VmwareToAwsTagMappings", + "traits": { + "smithy.api#documentation": "

This is a display of the mappings of on-premises VMware tags to the \n Amazon Web Services tags.

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

The Amazon Resource Name (ARN) of the IAM role.

" + } + } + } + }, + "com.amazonaws.backupgateway#GetVirtualMachine": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#GetVirtualMachineInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#GetVirtualMachineOutput" }, "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -2253,6 +2451,68 @@ "smithy.api#documentation": "

Represents the hypervisor's permissions to which the gateway will connect.

\n

A hypervisor is hardware, software, or firmware that creates and manages virtual machines,\n and allocates resources to them.

" } }, + "com.amazonaws.backupgateway#HypervisorDetails": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.backupgateway#Host", + "traits": { + "smithy.api#documentation": "

The server host of the hypervisor. This can be either an IP address or \n a fully-qualified domain name (FQDN).

" + } + }, + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hypervisor.

" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.backupgateway#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS \n used to encrypt the hypervisor.

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

This is the name of the specified hypervisor.

" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.backupgateway#LogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the group of gateways within \n the requested log.

" + } + }, + "State": { + "target": "com.amazonaws.backupgateway#HypervisorState", + "traits": { + "smithy.api#documentation": "

This is the current state of the specified hypervisor.

\n

The possible states are PENDING, ONLINE, \n OFFLINE, or ERROR.

" + } + }, + "LastSuccessfulMetadataSyncTime": { + "target": "com.amazonaws.backupgateway#Time", + "traits": { + "smithy.api#documentation": "

This is the time when the most recent successful sync \n of metadata occurred.

" + } + }, + "LatestMetadataSyncStatusMessage": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "

This is the most recent status for the indicated metadata sync.

" + } + }, + "LatestMetadataSyncStatus": { + "target": "com.amazonaws.backupgateway#SyncMetadataStatus", + "traits": { + "smithy.api#documentation": "

This is the most recent status for the indicated metadata sync.

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

These are the details of the specified hypervisor. A hypervisor is hardware, \n software, or firmware that creates and manages virtual machines, and allocates \n resources to them.

" + } + }, "com.amazonaws.backupgateway#HypervisorId": { "type": "string", "traits": { @@ -2262,6 +2522,20 @@ } } }, + "com.amazonaws.backupgateway#HypervisorPropertyMappingResource": { + "type": "resource", + "identifiers": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn" + } + }, + "put": { + "target": "com.amazonaws.backupgateway#PutHypervisorPropertyMappings" + }, + "read": { + "target": "com.amazonaws.backupgateway#GetHypervisorPropertyMappings" + } + }, "com.amazonaws.backupgateway#HypervisorResource": { "type": "resource", "identifiers": { @@ -2272,6 +2546,9 @@ "create": { "target": "com.amazonaws.backupgateway#ImportHypervisorConfiguration" }, + "read": { + "target": "com.amazonaws.backupgateway#GetHypervisor" + }, "update": { "target": "com.amazonaws.backupgateway#UpdateHypervisor" }, @@ -2281,6 +2558,16 @@ "list": { "target": "com.amazonaws.backupgateway#ListHypervisors" }, + "operations": [ + { + "target": "com.amazonaws.backupgateway#StartVirtualMachinesMetadataSync" + } + ], + "resources": [ + { + "target": "com.amazonaws.backupgateway#HypervisorPropertyMappingResource" + } + ], "traits": { "aws.cloudformation#cfnResource": { "name": "Hypervisor" @@ -2316,6 +2603,16 @@ "target": "com.amazonaws.backupgateway#Hypervisor" } }, + "com.amazonaws.backupgateway#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\\S+)$" + } + }, "com.amazonaws.backupgateway#ImportHypervisorConfiguration": { "type": "operation", "input": { @@ -2329,10 +2626,7 @@ "target": "com.amazonaws.backupgateway#AccessDeniedException" }, { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" + "target": "com.amazonaws.backupgateway#ConflictException" } ], "traits": { @@ -2430,14 +2724,6 @@ "output": { "target": "com.amazonaws.backupgateway#ListGatewaysOutput" }, - "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" - } - ], "traits": { "smithy.api#documentation": "

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

", "smithy.api#paginated": { @@ -2488,14 +2774,6 @@ "output": { "target": "com.amazonaws.backupgateway#ListHypervisorsOutput" }, - "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" - } - ], "traits": { "smithy.api#documentation": "

Lists your hypervisors.

", "smithy.api#paginated": { @@ -2547,14 +2825,8 @@ "target": "com.amazonaws.backupgateway#ListTagsForResourceOutput" }, "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -2598,14 +2870,6 @@ "output": { "target": "com.amazonaws.backupgateway#ListVirtualMachinesOutput" }, - "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" - } - ], "traits": { "smithy.api#documentation": "

Lists your virtual machines.

", "smithy.api#paginated": { @@ -2654,6 +2918,16 @@ } } }, + "com.amazonaws.backupgateway#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\\-\\/\\.]+:\\*$" + } + }, "com.amazonaws.backupgateway#MaintenanceStartTime": { "type": "structure", "members": { @@ -2746,26 +3020,129 @@ "smithy.api#pattern": "^[^\\x00]+$" } }, - "com.amazonaws.backupgateway#PutMaintenanceStartTime": { + "com.amazonaws.backupgateway#PutBandwidthRateLimitSchedule": { "type": "operation", "input": { - "target": "com.amazonaws.backupgateway#PutMaintenanceStartTimeInput" + "target": "com.amazonaws.backupgateway#PutBandwidthRateLimitScheduleInput" }, "output": { - "target": "com.amazonaws.backupgateway#PutMaintenanceStartTimeOutput" + "target": "com.amazonaws.backupgateway#PutBandwidthRateLimitScheduleOutput" }, "errors": [ { - "target": "com.amazonaws.backupgateway#ConflictException" + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

This action sets the bandwidth rate limit schedule for a specified gateway. \n By default, gateways do not have a bandwidth rate limit schedule, which means \n no bandwidth rate limiting is in effect. Use this to initiate a \n gateway's bandwidth rate limit schedule.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backupgateway#PutBandwidthRateLimitScheduleInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gateway. Use the \n \n ListGateways\n operation to return a list of gateways \n for your account and Amazon Web Services Region.

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

An array containing bandwidth rate limit schedule intervals for a gateway. \n When no bandwidth rate limit intervals have been scheduled, the array is empty.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#PutBandwidthRateLimitScheduleOutput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gateway. Use the \n \n ListGateways\n operation to return a list of gateways \n for your account and Amazon Web Services Region.

" + } + } + } + }, + "com.amazonaws.backupgateway#PutHypervisorPropertyMappings": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#PutHypervisorPropertyMappingsInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#PutHypervisorPropertyMappingsOutput" + }, + "errors": [ { - "target": "com.amazonaws.backupgateway#InternalServerException" + "target": "com.amazonaws.backupgateway#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupgateway#ConflictException" }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

This action sets the property mappings for the specified hypervisor. \n A hypervisor property mapping displays the relationship of entity properties \n available from the on-premises hypervisor to the properties available in Amazon Web Services.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backupgateway#PutHypervisorPropertyMappingsInput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hypervisor.

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

This action requests the mappings of on-premises VMware tags to the \n Amazon Web Services tags.

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

The Amazon Resource Name (ARN) of the IAM role.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#PutHypervisorPropertyMappingsOutput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hypervisor.

" + } + } + } + }, + "com.amazonaws.backupgateway#PutMaintenanceStartTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#PutMaintenanceStartTimeInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#PutMaintenanceStartTimeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#ConflictException" }, { - "target": "com.amazonaws.backupgateway#ValidationException" + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" } ], "traits": { @@ -2860,6 +3237,76 @@ "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\\/[a-zA-Z-0-9]+$" } }, + "com.amazonaws.backupgateway#StartVirtualMachinesMetadataSync": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#StartVirtualMachinesMetadataSyncInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#StartVirtualMachinesMetadataSyncOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#AccessDeniedException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

This action sends a request to sync metadata across the specified virtual machines.

" + } + }, + "com.amazonaws.backupgateway#StartVirtualMachinesMetadataSyncInput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hypervisor.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#StartVirtualMachinesMetadataSyncOutput": { + "type": "structure", + "members": { + "HypervisorArn": { + "target": "com.amazonaws.backupgateway#ServerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hypervisor.

" + } + } + } + }, + "com.amazonaws.backupgateway#SyncMetadataStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "PARTIALLY_FAILED", + "name": "PARTIALLY_FAILED" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + } + ] + } + }, "com.amazonaws.backupgateway#Tag": { "type": "structure", "members": { @@ -2907,14 +3354,8 @@ "target": "com.amazonaws.backupgateway#TagResourceOutput" }, "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -2979,14 +3420,8 @@ { "target": "com.amazonaws.backupgateway#ConflictException" }, - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -3060,14 +3495,8 @@ "target": "com.amazonaws.backupgateway#UntagResourceOutput" }, "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -3116,14 +3545,8 @@ { "target": "com.amazonaws.backupgateway#ConflictException" }, - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -3168,14 +3591,8 @@ "target": "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowOutput" }, "errors": [ - { - "target": "com.amazonaws.backupgateway#InternalServerException" - }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -3218,13 +3635,10 @@ "target": "com.amazonaws.backupgateway#AccessDeniedException" }, { - "target": "com.amazonaws.backupgateway#InternalServerException" + "target": "com.amazonaws.backupgateway#ConflictException" }, { "target": "com.amazonaws.backupgateway#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.backupgateway#ValidationException" } ], "traits": { @@ -3264,6 +3678,12 @@ "traits": { "smithy.api#documentation": "

The updated name for the hypervisor

" } + }, + "LogGroupArn": { + "target": "com.amazonaws.backupgateway#LogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the group of gateways within the requested log.

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

The most recent date a virtual machine was backed up, in Unix format and UTC time.

" } + }, + "VmwareTags": { + "target": "com.amazonaws.backupgateway#VmwareTags", + "traits": { + "smithy.api#documentation": "

These are the details of the VMware tags associated with the specified \n virtual machine.

" + } } }, "traits": { @@ -3421,6 +3847,98 @@ "target": "com.amazonaws.backupgateway#VirtualMachine" } }, + "com.amazonaws.backupgateway#VmwareCategory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 80 + } + } + }, + "com.amazonaws.backupgateway#VmwareTag": { + "type": "structure", + "members": { + "VmwareCategory": { + "target": "com.amazonaws.backupgateway#VmwareCategory", + "traits": { + "smithy.api#documentation": "

The is the category of VMware.

" + } + }, + "VmwareTagName": { + "target": "com.amazonaws.backupgateway#VmwareTagName", + "traits": { + "smithy.api#documentation": "

This is the user-defined name of a VMware tag.

" + } + }, + "VmwareTagDescription": { + "target": "com.amazonaws.backupgateway#string", + "traits": { + "smithy.api#documentation": "

This is a user-defined description of a VMware tag.

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

A VMware tag is a tag attached to a specific virtual machine.\n A tag \n is a key-value pair you can use to manage, filter, and search for your resources.

\n

The content of VMware tags can be matched to Amazon Web Services tags.

" + } + }, + "com.amazonaws.backupgateway#VmwareTagName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 80 + } + } + }, + "com.amazonaws.backupgateway#VmwareTags": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#VmwareTag" + } + }, + "com.amazonaws.backupgateway#VmwareToAwsTagMapping": { + "type": "structure", + "members": { + "VmwareCategory": { + "target": "com.amazonaws.backupgateway#VmwareCategory", + "traits": { + "smithy.api#documentation": "

The is the category of VMware.

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

This is the user-defined name of a VMware tag.

", + "smithy.api#required": {} + } + }, + "AwsTagKey": { + "target": "com.amazonaws.backupgateway#TagKey", + "traits": { + "smithy.api#documentation": "

The key part of the Amazon Web Services tag's key-value pair.

", + "smithy.api#required": {} + } + }, + "AwsTagValue": { + "target": "com.amazonaws.backupgateway#TagValue", + "traits": { + "smithy.api#documentation": "

The value part of the Amazon Web Services tag's key-value pair.

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

This displays the mapping of on-premises VMware tags to the \n corresponding Amazon Web Services tags.

" + } + }, + "com.amazonaws.backupgateway#VmwareToAwsTagMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.backupgateway#VmwareToAwsTagMapping" + } + }, "com.amazonaws.backupgateway#VpcEndpoint": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/batch.2016-08-10.json b/codegen/sdk-codegen/aws-models/batch.2016-08-10.json index 77050400161..899a886289f 100644 --- a/codegen/sdk-codegen/aws-models/batch.2016-08-10.json +++ b/codegen/sdk-codegen/aws-models/batch.2016-08-10.json @@ -128,7 +128,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -177,15 +177,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -498,9 +489,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -511,9 +502,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -524,9 +515,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -537,9 +528,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -550,9 +541,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -563,9 +554,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -576,9 +567,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -589,9 +580,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -602,9 +593,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -615,9 +606,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -628,9 +619,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -641,9 +632,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -654,9 +645,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -667,9 +658,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -680,9 +671,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -693,9 +684,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -706,9 +697,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -719,9 +710,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -732,9 +723,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -745,9 +736,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -758,9 +749,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -771,9 +762,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -784,9 +775,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -797,9 +788,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -810,9 +801,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -823,9 +814,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -836,9 +827,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -849,9 +840,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -862,9 +853,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -875,9 +866,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -888,9 +879,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -901,9 +892,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -914,9 +905,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -927,9 +918,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -940,9 +931,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -953,9 +944,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -966,9 +957,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -979,9 +970,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -992,9 +983,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1005,9 +996,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1018,9 +1009,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1031,9 +1022,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1044,9 +1035,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1057,9 +1048,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1070,9 +1061,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -1083,9 +1074,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -1096,9 +1087,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -1109,9 +1100,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -1122,9 +1113,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -1135,9 +1126,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -1148,9 +1139,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -1161,9 +1152,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -1174,9 +1165,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -1187,9 +1178,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -1200,9 +1191,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -1213,9 +1204,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -1226,9 +1217,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -1239,9 +1230,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -1252,9 +1243,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -1265,9 +1256,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -1278,9 +1269,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -1291,9 +1282,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -1304,9 +1295,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -1317,9 +1308,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -1330,9 +1321,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -1343,9 +1334,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -1356,9 +1347,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -1369,9 +1360,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -1382,9 +1373,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -1395,9 +1386,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -1408,9 +1399,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -1421,9 +1412,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -1434,9 +1425,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -1447,9 +1438,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -1460,9 +1451,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -1473,9 +1464,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -1486,9 +1477,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -1499,9 +1490,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -1512,9 +1503,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -1525,9 +1516,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -1538,9 +1529,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -1551,9 +1542,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -1564,9 +1555,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -1577,9 +1568,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -1590,9 +1581,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -1603,9 +1594,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -1616,9 +1607,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -1629,9 +1620,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -1642,9 +1633,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -1655,9 +1646,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -1668,9 +1659,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -1681,9 +1672,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -1694,9 +1685,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -1707,9 +1698,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -1720,9 +1711,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -1733,9 +1724,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -1746,9 +1737,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -1759,9 +1750,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -1772,9 +1763,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -1785,9 +1776,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -1798,9 +1789,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -1811,9 +1802,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -1824,9 +1815,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -1837,9 +1828,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -1850,9 +1841,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -1863,9 +1854,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -1876,9 +1867,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -1889,9 +1880,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -1902,9 +1893,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1914,9 +1905,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1926,9 +1917,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -2520,7 +2511,7 @@ "subnets": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User\n Guide.

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

The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User\n Guide.

\n \n

Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see\n Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and \n Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the\n Amazon ECS Developer Guide.

\n

Batch on Fargate doesn't currently support Local Zones.

\n ", "smithy.api#required": {} } }, @@ -2557,7 +2548,7 @@ "bidPercentage": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

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

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price. For most use cases, we recommend\n leaving this field empty.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n " } }, "spotIamFleetRole": { @@ -2607,7 +2598,7 @@ "subnets": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16\n subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't\n specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the\n compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.

\n

When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

" + "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. Fargate compute resources can\n contain up to 16 subnets. For Fargate compute resources, providing an empty list will be\n handled as if this parameter wasn't specified and no change is made. For EC2 compute resources,\n providing an empty list removes the VPC subnets from the compute resource. For more information,\n see VPCs and\n subnets in the Amazon VPC User Guide.

\n

When updating a compute environment, changing the VPC subnets requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see\n Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and \n Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the\n Amazon ECS Developer Guide.

\n

Batch on Fargate doesn't currently support Local Zones.

\n " } }, "securityGroupIds": { @@ -2655,7 +2646,7 @@ "bidPercentage": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be\n less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage.

\n

When updating a compute environment, changing the bid percentage requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

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

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be\n less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. For\n most use cases, we recommend leaving this field empty.

\n

When updating a compute environment, changing the bid percentage requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n " } }, "launchTemplate": { @@ -5186,6 +5177,18 @@ "traits": { "smithy.api#documentation": "

A list of job attempts that are associated with this job.

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

Indicates whether the job is canceled.

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

Indicates whether the job is terminated.

" + } } }, "traits": { @@ -5422,7 +5425,7 @@ "attemptDurationSeconds": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After\n this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60\n seconds.

" + "smithy.api#documentation": "

The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After\n this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60\n seconds.

\n

For array jobs, the timeout applies to the child jobs, not to the parent array job.

\n

For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/billingconductor.2021-07-30.json b/codegen/sdk-codegen/aws-models/billingconductor.2021-07-30.json index 6e1533500c5..c0702341c0d 100644 --- a/codegen/sdk-codegen/aws-models/billingconductor.2021-07-30.json +++ b/codegen/sdk-codegen/aws-models/billingconductor.2021-07-30.json @@ -73,7 +73,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -669,8 +669,8 @@ "authSchemes": [ { "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "billingconductor" + "signingName": "billingconductor", + "signingRegion": "us-east-1" } ] }, @@ -678,9 +678,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "aws-global", - "UseDualStack": false + "Region": "aws-global" } }, { @@ -691,9 +691,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -703,9 +703,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", - "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -715,9 +715,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -1761,6 +1761,21 @@ } } }, + "com.amazonaws.billingconductor#CreateFreeTierConfig": { + "type": "structure", + "members": { + "Activated": { + "target": "com.amazonaws.billingconductor#TieringActivated", + "traits": { + "smithy.api#documentation": "

\n Activate or deactivate Amazon Web Services Free Tier.\n

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

\n The possible Amazon Web Services Free Tier configurations.\n

" + } + }, "com.amazonaws.billingconductor#CreatePricingPlan": { "type": "operation", "input": { @@ -1940,8 +1955,7 @@ "ModifierPercentage": { "target": "com.amazonaws.billingconductor#ModifierPercentage", "traits": { - "smithy.api#documentation": "

A percentage modifier that's applied on the public pricing rates.

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

A percentage modifier that's applied on the public pricing rates.

" } }, "Service": { @@ -1961,6 +1975,12 @@ "traits": { "smithy.api#documentation": "

\n The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.\n

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

\n The set of tiering configurations for the pricing rule.\n

" + } } } }, @@ -1975,6 +1995,21 @@ } } }, + "com.amazonaws.billingconductor#CreateTieringInput": { + "type": "structure", + "members": { + "FreeTier": { + "target": "com.amazonaws.billingconductor#CreateFreeTierConfig", + "traits": { + "smithy.api#documentation": "

\n The possible Amazon Web Services Free Tier configurations.\n

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

\n The set of tiering configurations for the pricing rule.\n

" + } + }, "com.amazonaws.billingconductor#Currency": { "type": "string" }, @@ -2818,6 +2853,21 @@ "target": "com.amazonaws.billingconductor#DisassociateResourceResponseElement" } }, + "com.amazonaws.billingconductor#FreeTierConfig": { + "type": "structure", + "members": { + "Activated": { + "target": "com.amazonaws.billingconductor#TieringActivated", + "traits": { + "smithy.api#documentation": "

\n Activate or deactivate Amazon Web Services Free Tier application.\n

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

\n The possible Amazon Web Services Free Tier configurations.\n

" + } + }, "com.amazonaws.billingconductor#Instant": { "type": "long", "traits": { @@ -4339,7 +4389,6 @@ } ], "traits": { - "aws.cloudformation#cfnResource": {}, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], @@ -4476,6 +4525,12 @@ "traits": { "smithy.api#documentation": "

\n The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.\n

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

\n The set of tiering configurations for the pricing rule.\n

" + } } }, "traits": { @@ -4523,6 +4578,10 @@ { "value": "DISCOUNT", "name": "DISCOUNT" + }, + { + "value": "TIERING", + "name": "TIERING" } ] } @@ -4781,6 +4840,24 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.billingconductor#Tiering": { + "type": "structure", + "members": { + "FreeTier": { + "target": "com.amazonaws.billingconductor#FreeTierConfig", + "traits": { + "smithy.api#documentation": "

\n The possible Amazon Web Services Free Tier configurations.\n

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

\n The set of tiering configurations for the pricing rule.\n

" + } + }, + "com.amazonaws.billingconductor#TieringActivated": { + "type": "boolean" + }, "com.amazonaws.billingconductor#Token": { "type": "string" }, @@ -5178,6 +5255,21 @@ "smithy.api#documentation": "

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

" } }, + "com.amazonaws.billingconductor#UpdateFreeTierConfig": { + "type": "structure", + "members": { + "Activated": { + "target": "com.amazonaws.billingconductor#TieringActivated", + "traits": { + "smithy.api#documentation": "

\n Activate or deactivate application of Amazon Web Services Free Tier.\n

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

\n The possible Amazon Web Services Free Tier configurations.\n

" + } + }, "com.amazonaws.billingconductor#UpdatePricingPlan": { "type": "operation", "input": { @@ -5348,6 +5440,12 @@ "traits": { "smithy.api#documentation": "

\n The new modifier to show pricing plan rates as a percentage.\n

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

\n The set of tiering configurations for the pricing rule.\n

" + } } } }, @@ -5415,9 +5513,30 @@ "traits": { "smithy.api#documentation": "

\n The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.\n

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

\n The set of tiering configurations for the pricing rule.\n

" + } } } }, + "com.amazonaws.billingconductor#UpdateTieringInput": { + "type": "structure", + "members": { + "FreeTier": { + "target": "com.amazonaws.billingconductor#UpdateFreeTierConfig", + "traits": { + "smithy.api#documentation": "

\n The possible Amazon Web Services Free Tier configurations.\n

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

\n The set of tiering configurations for the pricing rule.\n

" + } + }, "com.amazonaws.billingconductor#ValidationException": { "type": "structure", "members": { @@ -5677,9 +5796,21 @@ { "value": "ILLEGAL_MODIFIER_PERCENTAGE", "name": "ILLEGAL_MODIFIER_PERCENTAGE" + }, + { + "value": "ILLEGAL_TYPE", + "name": "ILLEGAL_TYPE" + }, + { + "value": "ILLEGAL_ENDED_BILLINGGROUP", + "name": "ILLEGAL_ENDED_BILLINGGROUP" + }, + { + "value": "ILLEGAL_TIERING_INPUT", + "name": "ILLEGAL_TIERING_INPUT" } ] } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json b/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json index 7178953c753..4bb9af975ee 100644 --- a/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json +++ b/codegen/sdk-codegen/aws-models/cloudfront.2020-05-31.json @@ -84,7 +84,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

This field is true if any of the key groups have public keys that CloudFront can use\n\t\t\tto verify the signatures of signed URLs and signed cookies. If not, this field is\n\t\t\tfalse.

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

This field is true if any of the key groups have public keys that CloudFront\n\t\t\tcan use to verify the signatures of signed URLs and signed cookies. If not, this field\n\t\t\tis false.

", "smithy.api#required": {} } }, @@ -98,12 +98,12 @@ "Items": { "target": "com.amazonaws.cloudfront#KGKeyPairIdsList", "traits": { - "smithy.api#documentation": "

A list of key groups, including the identifiers of the public keys in each key group that\n\t\t\tCloudFront can use to verify the signatures of signed URLs and signed cookies.

" + "smithy.api#documentation": "

A list of key groups, including the identifiers of the public keys in each key group\n\t\t\tthat CloudFront can use to verify the signatures of signed URLs and signed cookies.

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

A list of key groups, and the public keys in each key group,\n\t\t\tthat CloudFront can use to verify the signatures of signed URLs and signed cookies.

" + "smithy.api#documentation": "

A list of key groups, and the public keys in each key group, that CloudFront can use to\n\t\t\tverify the signatures of signed URLs and signed cookies.

" } }, "com.amazonaws.cloudfront#ActiveTrustedSigners": { @@ -112,7 +112,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

This field is true if any of the Amazon Web Services accounts in the list have active CloudFront\n\t\t\tkey pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies.\n\t\t\tIf not, this field is false.

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

This field is true if any of the Amazon Web Services accounts in the list have active\n\t\t\tCloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed\n\t\t\tcookies. If not, this field is false.

", "smithy.api#required": {} } }, @@ -126,12 +126,12 @@ "Items": { "target": "com.amazonaws.cloudfront#SignerList", "traits": { - "smithy.api#documentation": "

A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account that\n\t\t\tCloudFront can use to verify the signatures of signed URLs and signed cookies.

" + "smithy.api#documentation": "

A list of Amazon Web Services accounts and the identifiers of active CloudFront key pairs in each account\n\t\t\tthat CloudFront can use to verify the signatures of signed URLs and signed cookies.

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

A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use\n\t\t\tto verify the signatures of signed URLs and signed cookies.

" + "smithy.api#documentation": "

A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can\n\t\t\tuse to verify the signatures of signed URLs and signed cookies.

" } }, "com.amazonaws.cloudfront#AliasICPRecordal": { @@ -140,18 +140,18 @@ "CNAME": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A domain name associated with a distribution.

" + "smithy.api#documentation": "

A domain name associated with a distribution.

" } }, "ICPRecordalStatus": { "target": "com.amazonaws.cloudfront#ICPRecordalStatus", "traits": { - "smithy.api#documentation": "

The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to \n\t\t\tAPPROVED for all CNAMEs (aliases) in regions outside of China.

\n\t\t

The status values returned are the following:

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

The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus\n\t\t\tis set to APPROVED for all CNAMEs (aliases) in regions outside of China.

\n

The status values returned are the following:

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

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure\n\t\t\tit yourself.

\n\t\t

For more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

" + "smithy.api#documentation": "

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP)\n\t\t\trecordal if they want to serve content publicly on an alternate domain name, also known\n\t\t\tas a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal\n\t\t\tstatus for CNAMEs associated with distributions. The status is returned in the CloudFront\n\t\t\tresponse; you can't configure it yourself.

\n

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services\n\t\t\t\tservices in China.

" } }, "com.amazonaws.cloudfront#AliasICPRecordals": { @@ -178,19 +178,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of CNAME aliases, if any, that you want to associate with this \n\t\t\tdistribution.

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

The number of CNAME aliases, if any, that you want to associate with this\n\t\t\tdistribution.

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#AliasList", "traits": { - "smithy.api#documentation": "

A complex type that contains the CNAME aliases, if any, that you want to associate with \n\t\t\tthis distribution.

" + "smithy.api#documentation": "

A complex type that contains the CNAME aliases, if any, that you want to associate\n\t\t\twith this distribution.

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

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.

" + "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this distribution.

" } }, "com.amazonaws.cloudfront#AllowedMethods": { @@ -199,14 +199,14 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values \n\t\t\tare 2 (for GET and HEAD requests), 3 (for GET, \n\t\t\t\tHEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, \n\t\t\t\tPUT, PATCH, POST, and DELETE requests).

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

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values\n\t\t\tare 2 (for GET and HEAD requests), 3 (for GET,\n\t\t\t\tHEAD, and OPTIONS requests) and 7 (for GET, HEAD,\n\t\t\t\tOPTIONS, PUT, PATCH, POST, and DELETE requests).

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#MethodsList", "traits": { - "smithy.api#documentation": "

A complex type that contains the HTTP methods that you want CloudFront to process and forward \n\t\t\tto your origin.

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

A complex type that contains the HTTP methods that you want CloudFront to process and\n\t\t\tforward to your origin.

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

A complex type that controls which HTTP methods CloudFront processes and forwards to your \n\t\t\tAmazon S3 bucket or your custom origin. There are three choices:

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

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or \n\t\t\tto your custom origin so users can't perform operations that you don't want them to. For \n\t\t\texample, you might not want users to have permissions to delete objects from your \n\t\t\torigin.

" + "smithy.api#documentation": "

A complex type that controls which HTTP methods CloudFront processes and forwards to your\n\t\t\tAmazon S3 bucket or your custom origin. There are three choices:

\n \n

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or\n\t\t\tto your custom origin so users can't perform operations that you don't want them to. For\n\t\t\texample, you might not want users to have permissions to delete objects from your\n\t\t\torigin.

" } }, "com.amazonaws.cloudfront#AssociateAlias": { @@ -244,7 +244,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront\n\t\t\tdistribution.

\n\t\t

With this operation you can move an alias that’s already in use on a CloudFront distribution\n\t\t\tto a different distribution in one step. This prevents the downtime that could occur if\n\t\t\tyou first remove the alias from one distribution and then separately add the alias to\n\t\t\tanother distribution.

\n\t\t

To use this operation to associate an alias with a distribution, you provide the alias\n\t\t\tand the ID of the target distribution for the alias. For more information, including how\n\t\t\tto set up the target distribution, prerequisites that you must complete, and other\n\t\t\trestrictions, see Moving an alternate domain name to a different distribution\n\t\t\tin the Amazon CloudFront Developer Guide.

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

Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront\n\t\t\tdistribution.

\n

With this operation you can move an alias that's already in use on a CloudFront distribution\n\t\t\tto a different distribution in one step. This prevents the downtime that could occur if\n\t\t\tyou first remove the alias from one distribution and then separately add the alias to\n\t\t\tanother distribution.

\n

To use this operation to associate an alias with a distribution, you provide the alias\n\t\t\tand the ID of the target distribution for the alias. For more information, including how\n\t\t\tto set up the target distribution, prerequisites that you must complete, and other\n\t\t\trestrictions, see Moving an alternate domain name to a different\n\t\t\t\tdistribution in the Amazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/distribution/{TargetDistributionId}/associate-alias", @@ -258,7 +258,7 @@ "TargetDistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ID of the distribution that you’re associating the alias with.

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

The ID of the distribution that you're associating the alias with.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -314,7 +314,7 @@ "PathPattern": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The pattern (for example, images/*.jpg) that specifies which requests to \n\t\t\tapply the behavior to. When CloudFront receives a viewer request, the requested path is compared \n\t\t\twith path patterns in the order in which cache behaviors are listed in the \n\t\t\tdistribution.

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

You can optionally include a slash (/) at the beginning of the path \n\t\t\t\tpattern. For example, /images/*.jpg. CloudFront behavior is the same with or without \n\t\t\t\tthe leading /.

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

The path pattern for the default cache behavior is * and cannot be \n\t\t\tchanged. If the request for an object does not match the path pattern for any cache behaviors, \n\t\t\tCloudFront applies the behavior in the default cache behavior.

\n\t\t

For more information, see Path \n\t\t\t\tPattern in the Amazon CloudFront Developer Guide.

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

The pattern (for example, images/*.jpg) that specifies which requests to\n\t\t\tapply the behavior to. When CloudFront receives a viewer request, the requested path is\n\t\t\tcompared with path patterns in the order in which cache behaviors are listed in the\n\t\t\tdistribution.

\n \n

You can optionally include a slash (/) at the beginning of the path\n\t\t\t\tpattern. For example, /images/*.jpg. CloudFront behavior is the same with or\n\t\t\t\twithout the leading /.

\n \n

The path pattern for the default cache behavior is * and cannot be\n\t\t\tchanged. If the request for an object does not match the path pattern for any cache\n\t\t\tbehaviors, CloudFront applies the behavior in the default cache behavior.

\n

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, @@ -328,19 +328,19 @@ "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "\n\t\t\t

We recommend using TrustedKeyGroups instead of\n\t\t\t\tTrustedSigners.

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

A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed\n\t\t\tcookies.

\n\t\t

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies\n\t\t\tfor all requests that match the cache behavior. The URLs or cookies must be signed with\n\t\t\tthe private key of a CloudFront key pair in the trusted signer’s Amazon Web Services account. The signed URL\n\t\t\tor cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

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

We recommend using TrustedKeyGroups instead of\n\t\t\t\t\tTrustedSigners.

\n \n

A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or\n\t\t\tsigned cookies.

\n

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account.\n\t\t\tThe signed URL or cookie contains information about which public key CloudFront should use to\n\t\t\tverify the signature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "TrustedKeyGroups": { "target": "com.amazonaws.cloudfront#TrustedKeyGroups", "traits": { - "smithy.api#documentation": "

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

\n\t\t

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A list of key groups that CloudFront can use to validate signed URLs or signed\n\t\t\tcookies.

\n

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "ViewerProtocolPolicy": { "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", "traits": { - "smithy.api#documentation": "

The protocol that viewers can use to access the files in the origin specified by \n\t\t\t\tTargetOriginId when a request matches the path pattern in \n\t\t\t\tPathPattern. You can specify the following options:

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

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\tAmazon CloudFront Developer Guide.

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

The only way to guarantee that viewers retrieve an object that was fetched from the origin\n\t\t\t\tusing HTTPS is never to use any other protocol to fetch the object. If you have\n\t\t\t\trecently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache\n\t\t\t\tbecause cached objects are protocol agnostic. That means that an edge location will\n\t\t\t\treturn an object from the cache regardless of whether the current request protocol\n\t\t\t\tmatches the protocol used previously. For more information, see Managing Cache Expiration in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

The protocol that viewers can use to access the files in the origin specified by\n\t\t\t\tTargetOriginId when a request matches the path pattern in\n\t\t\t\tPathPattern. You can specify the following options:

\n \n

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n \n

The only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects' cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\t\tManaging Cache\n\t\t\t\t\tExpiration in the Amazon CloudFront Developer Guide.

\n ", "smithy.api#required": {} } }, @@ -350,49 +350,49 @@ "SmoothStreaming": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming \n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify \n\t\t\t\ttrue; if not, specify false. If you specify true for \n\t\t\t\tSmoothStreaming, you can still distribute other content using this cache \n\t\t\tbehavior if the content matches the value of PathPattern.

" + "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming\n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify\n\t\t\t\ttrue; if not, specify false. If you specify\n\t\t\t\ttrue for SmoothStreaming, you can still distribute other\n\t\t\tcontent using this cache behavior if the content matches the value of\n\t\t\t\tPathPattern.

" } }, "Compress": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior. \n\t\t\tIf so, specify true; if not, specify false. For more information, see Serving Compressed Files in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior.\n\t\t\tIf so, specify true; if not, specify false. For more information, see Serving\n\t\t\t\tCompressed Files in the Amazon CloudFront Developer Guide.

" } }, "LambdaFunctionAssociations": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociations", "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more Lambda@Edge function associations for a cache \n\t\t\tbehavior.

" + "smithy.api#documentation": "

A complex type that contains zero or more Lambda@Edge function associations for a\n\t\t\tcache behavior.

" } }, "FunctionAssociations": { "target": "com.amazonaws.cloudfront#FunctionAssociations", "traits": { - "smithy.api#documentation": "

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must\n\t\t\tbe published to the LIVE stage to associate them with a cache\n\t\t\tbehavior.

" + "smithy.api#documentation": "

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions\n\t\t\tmust be published to the LIVE stage to associate them with a cache\n\t\t\tbehavior.

" } }, "FieldLevelEncryptionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of ID for the field-level encryption configuration that you want CloudFront\n\t\t\tto use for encrypting specific fields of data for this cache behavior.

" + "smithy.api#documentation": "

The value of ID for the field-level encryption configuration that you\n\t\t\twant CloudFront to use for encrypting specific fields of data for this cache behavior.

" } }, "RealtimeLogConfigArn": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this\n\t\t\tcache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to\n\t\t\tthis cache behavior. For more information, see Real-time logs in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of the cache policy that is attached to this cache behavior. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n Amazon CloudFront Developer Guide.

\n

A CacheBehavior must include either a\n CachePolicyId or ForwardedValues. We recommend that you\n use a CachePolicyId.

" + "smithy.api#documentation": "

The unique identifier of the cache policy that is attached to this cache behavior. For\n\t\t\tmore information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

A CacheBehavior must include either a CachePolicyId or\n\t\t\t\tForwardedValues. We recommend that you use a\n\t\t\tCachePolicyId.

" } }, "OriginRequestPolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of the origin request policy that is attached to this cache behavior.\n\t\t\tFor more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The unique identifier of the origin request policy that is attached to this cache\n\t\t\tbehavior. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "ResponseHeadersPolicyId": { @@ -405,33 +405,33 @@ "target": "com.amazonaws.cloudfront#ForwardedValues", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field. For more information, see Working with policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n Amazon CloudFront Developer Guide.

\n

A CacheBehavior must include either a\n CachePolicyId or ForwardedValues. We recommend that you\n use a CachePolicyId.

\n\t\t

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field. For more information, see Working with policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

If you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

If you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

A CacheBehavior must include either a CachePolicyId or\n\t\t\t\tForwardedValues. We recommend that you use a\n\t\t\tCachePolicyId.

\n

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP\n\t\t\theaders.

" } }, "MinTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. For \n\t\t\tmore information, see \n\t\t\t\tManaging How Long Content Stays in an Edge Cache (Expiration) in the \n\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

You must specify 0 for MinTTL if you configure CloudFront to \n\t\t\tforward all headers to your origin (under Headers, if you specify 1 \n\t\t\tfor Quantity and * for Name).

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. For more information, see Managing How Long\n\t\t\t\tContent Stays in an Edge Cache (Expiration) in the \n\t\t\t\tAmazon CloudFront Developer Guide.

\n

You must specify 0 for MinTTL if you configure CloudFront to\n\t\t\tforward all headers to your origin (under Headers, if you specify\n\t\t\t\t1 for Quantity and * for\n\t\t\tName).

" } }, "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin does not add HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field\n\t\t\tin a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

The default amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. The value that you specify applies only when your origin does not add HTTP\n\t\t\theaders such as Cache-Control max-age, Cache-Control s-maxage,\n\t\t\tand Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "MaxTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin adds HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. The value that you specify applies only when your origin adds HTTP headers such\n\t\t\tas Cache-Control max-age, Cache-Control s-maxage, and\n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

A complex type that describes how CloudFront processes requests.

\n\t\t

You must create at least as many cache behaviors (including the default cache behavior) as\n\t\t\tyou have origins if you want CloudFront to serve objects from all of the origins. Each cache\n\t\t\tbehavior specifies the one origin from which you want CloudFront to get objects. If you have\n\t\t\ttwo origins and only the default cache behavior, the default cache behavior will cause\n\t\t\tCloudFront to get objects from one of the origins, but the other origin is never used.

\n\t\t

For the current quota (formerly known as limit) on the number of cache behaviors that you\n\t\t\tcan add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.

\n\t\t

If you don’t want to specify any cache behaviors, include only an empty\n\t\t\tCacheBehaviors element. Don’t include an empty CacheBehavior\n\t\t\telement because this is invalid.

\n\t\t

To delete all cache behaviors in an existing distribution, update the distribution \n\t\t\tconfiguration and include only an empty CacheBehaviors element.

\n\t\t

To add, change, or remove one or more cache behaviors, update the distribution \n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the updated \n\t\t\tdistribution.

\n\t\t

For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A complex type that describes how CloudFront processes requests.

\n

You must create at least as many cache behaviors (including the default cache\n\t\t\tbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\n\t\t\tEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\n\t\t\tyou have two origins and only the default cache behavior, the default cache behavior\n\t\t\twill cause CloudFront to get objects from one of the origins, but the other origin is never\n\t\t\tused.

\n

For the current quota (formerly known as limit) on the number of cache behaviors that\n\t\t\tyou can add to a distribution, see Quotas in the\n\t\t\tAmazon CloudFront Developer Guide.

\n

If you don't want to specify any cache behaviors, include only an empty\n\t\t\t\tCacheBehaviors element. Don't include an empty\n\t\t\t\tCacheBehavior element because this is invalid.

\n

To delete all cache behaviors in an existing distribution, update the distribution\n\t\t\tconfiguration and include only an empty CacheBehaviors element.

\n

To add, change, or remove one or more cache behaviors, update the distribution\n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the\n\t\t\tupdated distribution.

\n

For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#CacheBehaviorList": { @@ -449,19 +449,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of cache behaviors for this distribution.

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

The number of cache behaviors for this distribution.

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#CacheBehaviorList", "traits": { - "smithy.api#documentation": "

Optional: A complex type that contains cache behaviors for this distribution. If \n\t\t\t\tQuantity is 0, you can omit Items.

" + "smithy.api#documentation": "

Optional: A complex type that contains cache behaviors for this distribution. If\n\t\t\t\tQuantity is 0, you can omit Items.

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

A complex type that contains zero or more CacheBehavior elements. \n\t\t

" + "smithy.api#documentation": "

A complex type that contains zero or more CacheBehavior elements.

" } }, "com.amazonaws.cloudfront#CachePolicy": { @@ -490,7 +490,7 @@ } }, "traits": { - "smithy.api#documentation": "

A cache policy.

\n\t\t

When it’s attached to a cache behavior, the cache policy determines the\n\t\t\tfollowing:

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

The headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind a valid object in its cache that matches the request’s cache key. If you want to\n\t\t\tsend values to the origin but not include them in the cache key,\n\t\t\tuse OriginRequestPolicy.

" + "smithy.api#documentation": "

A cache policy.

\n

When it's attached to a cache behavior, the cache policy determines the\n\t\t\tfollowing:

\n \n

The headers, cookies, and query strings that are included in the cache key are\n\t\t\tautomatically included in requests that CloudFront sends to the origin. CloudFront sends a request\n\t\t\twhen it can't find a valid object in its cache that matches the request's cache key. If\n\t\t\tyou want to send values to the origin but not include them in the\n\t\t\tcache key, use OriginRequestPolicy.

" } }, "com.amazonaws.cloudfront#CachePolicyAlreadyExists": { @@ -525,19 +525,19 @@ "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The default amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. CloudFront uses this value as the object’s time to live (TTL) only when the origin\n\t\t\tdoes not send Cache-Control or Expires\n\t\t\theaders with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default value for this field is 86400 seconds (one day). If the value of\n\t\t\tMinTTL is more than 86400 seconds, then the default value for this field is\n\t\t\tthe same as the value of MinTTL.

" + "smithy.api#documentation": "

The default amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. CloudFront uses this value as the object's time to live (TTL) only when the origin\n\t\t\tdoes not send Cache-Control or Expires\n\t\t\theaders with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

The default value for this field is 86400 seconds (one day). If the value of\n\t\t\t\tMinTTL is more than 86400 seconds, then the default value for this\n\t\t\tfield is the same as the value of MinTTL.

" } }, "MaxTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that objects stay in the CloudFront cache\n\t\t\tbefore CloudFront sends another request to the origin to see if the object has been updated.\n\t\t\tCloudFront uses this value only when the origin sends Cache-Control or\n\t\t\tExpires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default value for this field is 31536000 seconds (one year). If the value of\n\t\t\tMinTTL or DefaultTTL is more than 31536000 seconds, then the\n\t\t\tdefault value for this field is the same as the value of DefaultTTL.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before\n\t\t\tCloudFront sends another request to the origin to see if the object has been updated. CloudFront\n\t\t\tuses this value only when the origin sends Cache-Control or\n\t\t\t\tExpires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

The default value for this field is 31536000 seconds (one year). If the value of\n\t\t\t\tMinTTL or DefaultTTL is more than 31536000 seconds, then\n\t\t\tthe default value for this field is the same as the value of\n\t\t\tDefaultTTL.

" } }, "MinTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\tAmazon CloudFront Developer Guide.

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

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront\n\t\t\tcache before CloudFront sends another request to the origin to see if the object has been\n\t\t\tupdated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

A cache policy configuration.

\n\t\t

This configuration determines the following:

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

The headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind a valid object in its cache that matches the request’s cache key. If you want to\n\t\t\tsend values to the origin but not include them in the cache key,\n\t\t\tuse OriginRequestPolicy.

" + "smithy.api#documentation": "

A cache policy configuration.

\n

This configuration determines the following:

\n \n

The headers, cookies, and query strings that are included in the cache key are\n\t\t\tautomatically included in requests that CloudFront sends to the origin. CloudFront sends a request\n\t\t\twhen it can't find a valid object in its cache that matches the request's cache key. If\n\t\t\tyou want to send values to the origin but not include them in the\n\t\t\tcache key, use OriginRequestPolicy.

" } }, "com.amazonaws.cloudfront#CachePolicyCookieBehavior": { @@ -587,7 +587,7 @@ "CookieBehavior": { "target": "com.amazonaws.cloudfront#CachePolicyCookieBehavior", "traits": { - "smithy.api#documentation": "

Determines whether any cookies in viewer requests are included in the cache key and\n\t\t\tautomatically included in requests that CloudFront sends to the origin. Valid values\n\t\t\tare:

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

Determines whether any cookies in viewer requests are included in the cache key and\n\t\t\tautomatically included in requests that CloudFront sends to the origin. Valid values\n\t\t\tare:

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

An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in the cache key and automatically included in requests that CloudFront sends to\n\t\t\tthe origin.

" + "smithy.api#documentation": "

An object that determines whether any cookies in viewer requests (and if so, which\n\t\t\tcookies) are included in the cache key and automatically included in requests that CloudFront\n\t\t\tsends to the origin.

" } }, "com.amazonaws.cloudfront#CachePolicyHeaderBehavior": { @@ -622,7 +622,7 @@ "HeaderBehavior": { "target": "com.amazonaws.cloudfront#CachePolicyHeaderBehavior", "traits": { - "smithy.api#documentation": "

Determines whether any HTTP headers are included in the cache key and automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. Valid values are:

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

Determines whether any HTTP headers are included in the cache key and automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. Valid values are:

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

An object that determines whether any HTTP headers (and if so, which headers) are included\n\t\t\tin the cache key and automatically included in requests that CloudFront sends to the\n\t\t\torigin.

" + "smithy.api#documentation": "

An object that determines whether any HTTP headers (and if so, which headers) are\n\t\t\tincluded in the cache key and automatically included in requests that CloudFront sends to the\n\t\t\torigin.

" } }, "com.amazonaws.cloudfront#CachePolicyInUse": { @@ -716,19 +716,19 @@ "QueryStringBehavior": { "target": "com.amazonaws.cloudfront#CachePolicyQueryStringBehavior", "traits": { - "smithy.api#documentation": "

Determines whether any URL query strings in viewer requests are included in the cache key\n\t\t\tand automatically included in requests that CloudFront sends to the origin. Valid values\n\t\t\tare:

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

Determines whether any URL query strings in viewer requests are included in the cache\n\t\t\tkey and automatically included in requests that CloudFront sends to the origin. Valid values\n\t\t\tare:

\n ", "smithy.api#required": {} } }, "QueryStrings": { "target": "com.amazonaws.cloudfront#QueryStringNames", "traits": { - "smithy.api#documentation": "

Contains the specific query strings in viewer requests that either \n are\n or \n are\n\t\t\tnot\n included in the cache key and automatically included in\n\t\t\trequests that CloudFront sends to the origin. The behavior depends on whether the\n\t\t\tQueryStringBehavior field in the CachePolicyQueryStringsConfig\n\t\t\ttype is set to whitelist (the listed query strings \n are\n included) or allExcept (the listed\n\t\t\tquery strings \n are not\n included,\n\t\t\tbut all other query strings are).

" + "smithy.api#documentation": "

Contains the specific query strings in viewer requests that either \n are\n or \n are\n\t\t\t\t\tnot\n included in the cache key and automatically included\n\t\t\tin requests that CloudFront sends to the origin. The behavior depends on whether the\n\t\t\t\tQueryStringBehavior field in the\n\t\t\t\tCachePolicyQueryStringsConfig type is set to whitelist\n\t\t\t(the listed query strings \n are\n \n\t\t\tincluded) or allExcept (the listed query strings \n are not\n included, but all other query strings\n\t\t\tare).

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

An object that determines whether any URL query strings in viewer requests (and if so, which\n\t\t\tquery strings) are included in the cache key and automatically included in requests that\n\t\t\tCloudFront sends to the origin.

" + "smithy.api#documentation": "

An object that determines whether any URL query strings in viewer requests (and if so,\n\t\t\twhich query strings) are included in the cache key and automatically included in\n\t\t\trequests that CloudFront sends to the origin.

" } }, "com.amazonaws.cloudfront#CachePolicySummary": { @@ -737,7 +737,7 @@ "Type": { "target": "com.amazonaws.cloudfront#CachePolicyType", "traits": { - "smithy.api#documentation": "

The type of cache policy, either managed (created by Amazon Web Services) or\n\t\t\tcustom (created in this Amazon Web Services account).

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

The type of cache policy, either managed (created by Amazon Web Services) or\n\t\t\t\tcustom (created in this Amazon Web Services account).

", "smithy.api#required": {} } }, @@ -785,20 +785,20 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are \n\t\t\t\t2 (for caching responses to GET and HEAD requests) \n\t\t\tand 3 (for caching responses to GET, HEAD, and \n\t\t\t\tOPTIONS requests).

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

The number of HTTP methods for which you want CloudFront to cache responses. Valid values\n\t\t\tare 2 (for caching responses to GET and HEAD\n\t\t\trequests) and 3 (for caching responses to GET,\n\t\t\t\tHEAD, and OPTIONS requests).

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#MethodsList", "traits": { - "smithy.api#documentation": "

A complex type that contains the HTTP methods that you want CloudFront to cache responses \n\t\t\tto.

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

A complex type that contains the HTTP methods that you want CloudFront to cache responses\n\t\t\tto.

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

A complex type that controls whether CloudFront caches the response to requests using the \n\t\t\tspecified HTTP methods. There are two choices:

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

If you pick the second choice for your Amazon S3 Origin, you may need to forward \n\t\t\tAccess-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the \n\t\t\tresponses to be cached correctly.

" + "smithy.api#documentation": "

A complex type that controls whether CloudFront caches the response to requests using the\n\t\t\tspecified HTTP methods. There are two choices:

\n \n

If you pick the second choice for your Amazon S3 Origin, you may need to forward\n\t\t\tAccess-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for\n\t\t\tthe responses to be cached correctly.

" } }, "com.amazonaws.cloudfront#CannotChangeImmutablePublicKeyFields": { @@ -843,21 +843,21 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ID for the origin access identity, for example, E74FTE3AJFJ256A. \n\t\t

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

The ID for the origin access identity, for example, E74FTE3AJFJ256A.\n\t\t

", "smithy.api#required": {} } }, "S3CanonicalUserId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin \n\t\t\taccess identity read permission to an object in Amazon S3.

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

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin\n\t\t\taccess identity read permission to an object in Amazon S3.

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

The current configuration information for the identity.

" + "smithy.api#documentation": "

The current configuration information for the identity.

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

If the CallerReference is a value you already sent in a previous request to create an identity but the content \n\t\t\tof the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a \n\t\t\tCloudFrontOriginAccessIdentityAlreadyExists error.

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

If the CallerReference is a value you already sent in a previous request\n\t\t\tto create an identity but the content of the\n\t\t\t\tCloudFrontOriginAccessIdentityConfig is different from the original\n\t\t\trequest, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n\t\t

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -884,20 +884,20 @@ "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

\n\t\t

If the value of CallerReference is new (regardless of the content of the \n\t\t\tCloudFrontOriginAccessIdentityConfig object), a new origin access identity is \n\t\t\tcreated.

\n\t\t

If the CallerReference is a value already sent in a previous identity \n\t\t\trequest, and the content of the CloudFrontOriginAccessIdentityConfig is identical \n\t\t\tto the original request (ignoring white space), the response includes the same information \n\t\t\treturned to the original request.

\n\t\t

If the CallerReference is a value you already sent in a previous request \n\t\t\tto create an identity, but the content of the \n\t\t\tCloudFrontOriginAccessIdentityConfig is different from the original request, \n\t\t\tCloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

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

A unique value (for example, a date-time stamp) that ensures that the request can't be\n\t\t\treplayed.

\n

If the value of CallerReference is new (regardless of the content of the\n\t\t\t\tCloudFrontOriginAccessIdentityConfig object), a new origin access\n\t\t\tidentity is created.

\n

If the CallerReference is a value already sent in a previous identity\n\t\t\trequest, and the content of the CloudFrontOriginAccessIdentityConfig is\n\t\t\tidentical to the original request (ignoring white space), the response includes the same\n\t\t\tinformation returned to the original request.

\n

If the CallerReference is a value you already sent in a previous request\n\t\t\tto create an identity, but the content of the\n\t\t\t\tCloudFrontOriginAccessIdentityConfig is different from the original\n\t\t\trequest, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n\t\t

", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A comment to describe the origin access identity. The comment cannot be longer\n\t\t\tthan 128 characters.

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

A comment to describe the origin access identity. The comment cannot be longer than\n\t\t\t128 characters.

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

Origin access identity configuration. Send a GET request to the \n\t\t\t\t\t/CloudFront API version/CloudFront/identity ID/config resource. \n\t\t

" + "smithy.api#documentation": "

Origin access identity configuration. Send a GET request to the\n\t\t\t\t\t/CloudFront API version/CloudFront/identity ID/config\n\t\t\tresource.

" } }, "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityInUse": { @@ -919,46 +919,46 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of origin \n\t\t\taccess identities. The results include identities in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tidentity on that page).

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

Use this when paginating results to indicate where to begin in your list of origin\n\t\t\taccess identities. The results include identities in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last identity on that page).

", "smithy.api#required": {} } }, "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\torigin access identities where they left off.

" + "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains\n\t\t\tthe value you can use for the Marker request parameter to continue listing\n\t\t\tyour origin access identities where they left off.

" } }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The maximum number of origin access identities you want in the response body. \n\t\t

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

The maximum number of origin access identities you want in the response body.

", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more origin access identities remain to be listed. If \n\t\t\tyour results were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker request parameter to retrieve more items in the list.

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

A flag that indicates whether more origin access identities remain to be listed. If\n\t\t\tyour results were truncated, you can make a follow-up pagination request using the\n\t\t\t\tMarker request parameter to retrieve more items in the list.

", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of CloudFront origin access identities that were created by the current Amazon Web Services account.

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

The number of CloudFront origin access identities that were created by the current\n\t\t\tAmazon Web Services account.

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentitySummaryList", "traits": { - "smithy.api#documentation": "

A complex type that contains one CloudFrontOriginAccessIdentitySummary \n\t\t\telement for each origin access identity that was created by the current Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains one CloudFrontOriginAccessIdentitySummary\n\t\t\telement for each origin access identity that was created by the current\n\t\t\tAmazon Web Services account.

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

Lists the origin access identities for CloudFront.Send a GET request to the \n\t\t\t\t\t/CloudFront API version/origin-access-identity/cloudfront \n\t\t\tresource. The response includes a CloudFrontOriginAccessIdentityList element with \n\t\t\tzero or more CloudFrontOriginAccessIdentitySummary child elements. By default, \n\t\t\tyour entire list of origin access identities is returned in one single page. If the list is \n\t\t\tlong, you can paginate it using the MaxItems and Marker \n\t\t\tparameters.

" + "smithy.api#documentation": "

Lists the origin access identities for CloudFront.Send a GET request to the\n\t\t\t\t\t/CloudFront API\n\t\t\t\tversion/origin-access-identity/cloudfront resource. The response\n\t\t\tincludes a CloudFrontOriginAccessIdentityList element with zero or more\n\t\t\t\tCloudFrontOriginAccessIdentitySummary child elements. By default, your\n\t\t\tentire list of origin access identities is returned in one single page. If the list is\n\t\t\tlong, you can paginate it using the MaxItems and Marker\n\t\t\tparameters.

" } }, "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentitySummary": { @@ -967,21 +967,21 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ID for the origin access identity. For example: \n\t\t\tE74FTE3AJFJ256A.

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

The ID for the origin access identity. For example:\n\t\t\tE74FTE3AJFJ256A.

", "smithy.api#required": {} } }, "S3CanonicalUserId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon S3 canonical user ID for the origin access identity, which you use when giving \n\t\t\tthe origin access identity read permission to an object in Amazon S3.

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

The Amazon S3 canonical user ID for the origin access identity, which you use when giving\n\t\t\tthe origin access identity read permission to an object in Amazon S3.

", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The comment for this origin access identity, as originally specified when \n\t\t\tcreated.

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

The comment for this origin access identity, as originally specified when\n\t\t\tcreated.

", "smithy.api#required": {} } } @@ -1288,6 +1288,9 @@ { "target": "com.amazonaws.cloudfront#UpdateDistribution" }, + { + "target": "com.amazonaws.cloudfront#UpdateDistributionWithStagingConfig" + }, { "target": "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfig" }, @@ -1331,7 +1334,7 @@ "name": "cloudfront" }, "aws.protocols#restXml": {}, - "smithy.api#documentation": "Amazon CloudFront\n\t\t

This is the Amazon CloudFront API Reference. This guide\n is for developers who need detailed information about \n\t\t\tCloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

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

This is the Amazon CloudFront API Reference. This guide is for developers\n\t\t\twho need detailed information about CloudFront API actions, data types, and errors. For\n\t\t\tdetailed information about CloudFront features, see the\n\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#title": "Amazon CloudFront", "smithy.api#xmlNamespace": { "uri": "http://cloudfront.amazonaws.com/doc/2020-05-31/" @@ -1390,15 +1393,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -2206,9 +2200,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", + "signingRegion": "cn-northwest-1", "signingName": "cloudfront", - "signingRegion": "cn-northwest-1" + "name": "sigv4" } ] }, @@ -2216,9 +2210,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "aws-cn-global", - "UseFIPS": false + "UseDualStack": false } }, { @@ -2228,9 +2222,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", + "signingRegion": "us-east-1", "signingName": "cloudfront", - "signingRegion": "us-east-1" + "name": "sigv4" } ] }, @@ -2238,9 +2232,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "aws-global", - "UseFIPS": false + "UseDualStack": false } }, { @@ -2251,9 +2245,9 @@ } }, "params": { - "UseDualStack": false, - "Region": "us-east-1", "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2263,9 +2257,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, - "Region": "us-east-1", "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2275,9 +2269,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, - "Region": "us-east-1", "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -2310,12 +2304,12 @@ "AccountId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The (partially hidden) ID of the Amazon Web Services account that owns the distribution that’s\n\t\t\tassociated with the alias.

" + "smithy.api#documentation": "

The (partially hidden) ID of the Amazon Web Services account that owns the distribution that's\n\t\t\tassociated with the alias.

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

An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that it’s\n\t\t\tassociated with. The distribution and account IDs are partially hidden, which allows you\n\t\t\tto identify the distributions and accounts that you own, but helps to protect the\n\t\t\tinformation of ones that you don’t own.

" + "smithy.api#documentation": "

An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that\n\t\t\tit's associated with. The distribution and account IDs are partially hidden, which\n\t\t\tallows you to identify the distributions and accounts that you own, but helps to protect\n\t\t\tthe information of ones that you don't own.

" } }, "com.amazonaws.cloudfront#ConflictingAliases": { @@ -2333,7 +2327,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value that you should use in the Marker field of a subsequent\n\t\t\trequest to continue listing conflicting aliases where you left off.

" + "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing conflicting aliases where you left off.

" } }, "MaxItems": { @@ -2356,7 +2350,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts that\n\t\t\tthey are associated with. In the list, the distribution and account IDs are partially\n\t\t\thidden, which allows you to identify the distributions and accounts that you own, but\n\t\t\thelps to protect the information of ones that you don’t own.

" + "smithy.api#documentation": "

A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts\n\t\t\tthat they are associated with. In the list, the distribution and account IDs are\n\t\t\tpartially hidden, which allows you to identify the distributions and accounts that you\n\t\t\town, but helps to protect the information of ones that you don't own.

" } }, "com.amazonaws.cloudfront#ContentTypeProfile": { @@ -2365,26 +2359,26 @@ "Format": { "target": "com.amazonaws.cloudfront#Format", "traits": { - "smithy.api#documentation": "

The format for a field-level encryption content type-profile mapping.

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

The format for a field-level encryption content type-profile mapping.

", "smithy.api#required": {} } }, "ProfileId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The profile ID for a field-level encryption content type-profile mapping.

" + "smithy.api#documentation": "

The profile ID for a field-level encryption content type-profile mapping.

" } }, "ContentType": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The content type for a field-level encryption content type-profile mapping.

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

The content type for a field-level encryption content type-profile mapping.

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

A field-level encryption content type profile.

" + "smithy.api#documentation": "

A field-level encryption content type profile.

" } }, "com.amazonaws.cloudfront#ContentTypeProfileConfig": { @@ -2393,19 +2387,19 @@ "ForwardWhenContentTypeIsUnknown": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

The setting in a field-level encryption content type-profile mapping that specifies what to do\n\t\t\twhen an unknown content type is provided for the profile. If true, content is\n\t\t\tforwarded without being encrypted when the content type is unknown. If false (the\n\t\t\tdefault), an error is returned when the content type is unknown.

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

The setting in a field-level encryption content type-profile mapping that specifies\n\t\t\twhat to do when an unknown content type is provided for the profile. If true, content is\n\t\t\tforwarded without being encrypted when the content type is unknown. If false (the\n\t\t\tdefault), an error is returned when the content type is unknown.

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

The configuration for a field-level encryption content type-profile.

" + "smithy.api#documentation": "

The configuration for a field-level encryption content type-profile.

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

The configuration for a field-level encryption content type-profile mapping.

" + "smithy.api#documentation": "

The configuration for a field-level encryption content type-profile mapping.

" } }, "com.amazonaws.cloudfront#ContentTypeProfileList": { @@ -2423,19 +2417,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of field-level encryption content type-profile mappings.

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

The number of field-level encryption content type-profile mappings.

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#ContentTypeProfileList", "traits": { - "smithy.api#documentation": "

Items in a field-level encryption content type-profile mapping.

" + "smithy.api#documentation": "

Items in a field-level encryption content type-profile mapping.

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

Field-level encryption content type-profile.

" + "smithy.api#documentation": "

Field-level encryption content type-profile.

" } }, "com.amazonaws.cloudfront#ContinuousDeploymentPolicy": { @@ -2466,27 +2460,40 @@ "smithy.api#documentation": "

A continuous deployment policy.

" } }, + "com.amazonaws.cloudfront#ContinuousDeploymentPolicyAlreadyExists": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

A continuous deployment policy with this configuration already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.cloudfront#ContinuousDeploymentPolicyConfig": { "type": "structure", "members": { "StagingDistributionDnsNames": { "target": "com.amazonaws.cloudfront#StagingDistributionDnsNames", "traits": { - "smithy.api#documentation": "

The CloudFront domain name of the staging distribution. For example:\n\t\t\td111111abcdef8.cloudfront.net.

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

The CloudFront domain name of the staging distribution. For example:\n\t\t\t\td111111abcdef8.cloudfront.net.

", "smithy.api#required": {} } }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that indicates whether this continuous deployment policy is enabled (in effect).\n\t\t\tWhen this value is true, this policy is enabled and in effect. When this\n\t\t\tvalue is false, this policy is not enabled and has no effect.

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

A Boolean that indicates whether this continuous deployment policy is enabled (in\n\t\t\teffect). When this value is true, this policy is enabled and in effect.\n\t\t\tWhen this value is false, this policy is not enabled and has no\n\t\t\teffect.

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

Contains the parameters for routing production traffic from your primary to staging distributions.

" + "smithy.api#documentation": "

Contains the parameters for routing production traffic from your primary to staging\n\t\t\tdistributions.

" } } }, @@ -2494,26 +2501,39 @@ "smithy.api#documentation": "

Contains the configuration for a continuous deployment policy.

" } }, + "com.amazonaws.cloudfront#ContinuousDeploymentPolicyInUse": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

You cannot delete a continuous deployment policy that is associated with a primary\n\t\t\tdistribution.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.cloudfront#ContinuousDeploymentPolicyList": { "type": "structure", "members": { "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Indicates the next page of continuous deployment policies. To get the next page of the list,\n\t\t\tuse this value in the Marker field of your request.

" + "smithy.api#documentation": "

Indicates the next page of continuous deployment policies. To get the next page of the\n\t\t\tlist, use this value in the Marker field of your request.

" } }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The maximum number of continuous deployment policies that were specified in your request.

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

The maximum number of continuous deployment policies that were specified in your\n\t\t\trequest.

", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The total number of continuous deployment policies in your Amazon Web Services account, regardless of the MaxItems value.

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

The total number of continuous deployment policies in your Amazon Web Services account, regardless\n\t\t\tof the MaxItems value.

", "smithy.api#required": {} } }, @@ -2575,7 +2595,7 @@ "Header": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The request header name that you want CloudFront to send to your staging distribution.

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

The request header name that you want CloudFront to send to your staging\n\t\t\tdistribution. The header must contain the prefix aws-cf-cd-.

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

This configuration determines which HTTP requests are sent to the staging\n\t\t\tdistribution. If the HTTP request contains a header and value that matches what you\n\t\t\tspecify here, the request is sent to the staging distribution. Otherwise the request\n\t\t\tis sent to the primary distribution.

" + "smithy.api#documentation": "

This configuration determines which HTTP requests are sent to the staging\n\t\t\tdistribution. If the HTTP request contains a header and value that matches what you\n\t\t\tspecify here, the request is sent to the staging distribution. Otherwise the request is\n\t\t\tsent to the primary distribution.

" } }, "com.amazonaws.cloudfront#ContinuousDeploymentSingleWeightConfig": { @@ -2597,7 +2617,7 @@ "Weight": { "target": "com.amazonaws.cloudfront#float", "traits": { - "smithy.api#documentation": "

The percentage of traffic to send to the staging distribution, expressed as a decimal number\n\t\t\tbetween 0 and 1.

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

The percentage of traffic to send to a staging distribution, expressed as a decimal\n\t\t\tnumber between 0 and .15.

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

Contains the percentage of traffic to send to a staging distribution, expressed as a decimal\n\t\t\tnumber between 0 and 1.

" + "smithy.api#documentation": "

Contains the percentage of traffic to send to a staging distribution.

" } }, "com.amazonaws.cloudfront#CookieNameList": { @@ -2645,19 +2665,19 @@ "Forward": { "target": "com.amazonaws.cloudfront#ItemSelection", "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use origin\n\t\t\trequest policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

Specifies which cookies to forward to the origin for this cache behavior: all, none, or \n\t\t\tthe list of cookies specified in the WhitelistedNames complex type.

\n\t\t

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an \n\t\t\tAmazon S3 origin, specify none for the Forward element.

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

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include cookies in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n

If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n

Specifies which cookies to forward to the origin for this cache behavior: all, none,\n\t\t\tor the list of cookies specified in the WhitelistedNames complex\n\t\t\ttype.

\n

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an\n\t\t\tAmazon S3 origin, specify none for the Forward element.

", "smithy.api#required": {} } }, "WhitelistedNames": { "target": "com.amazonaws.cloudfront#CookieNames", "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

Required if you specify whitelist for the value of Forward. \n\t\t\tA complex type that specifies how many different cookies you want CloudFront to forward to the \n\t\t\torigin for this cache behavior and, if you want to forward selected cookies, the names of \n\t\t\tthose cookies.

\n\t\t

If you specify all or none for the value of Forward, omit \n\t\t\t\tWhitelistedNames. If you change the value of Forward from \n\t\t\twhitelist to all or none and you don't delete the WhitelistedNames \n\t\t\telement and its child elements, CloudFront deletes them automatically.

\n\t\t

For the current limit on the number of cookie names that you can whitelist for each \n\t\t\tcache behavior, see \n\t\t\t\tCloudFront Limits in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include cookies in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n

If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n

Required if you specify whitelist for the value of Forward.\n\t\t\tA complex type that specifies how many different cookies you want CloudFront to forward to the\n\t\t\torigin for this cache behavior and, if you want to forward selected cookies, the names\n\t\t\tof those cookies.

\n

If you specify all or none for the value of\n\t\t\t\tForward, omit WhitelistedNames. If you change the value of\n\t\t\t\tForward from whitelist to all or\n\t\t\t\tnone and you don't delete the WhitelistedNames element and\n\t\t\tits child elements, CloudFront deletes them automatically.

\n

For the current limit on the number of cookie names that you can whitelist for each\n\t\t\tcache behavior, see CloudFront\n\t\t\t\tLimits in the Amazon Web Services General Reference.

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

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use CookiesConfig in a\n\t\t\tcache policy. See CachePolicy.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\tCookiesConfig in an origin request policy. See\n\t\t\tOriginRequestPolicy.

\n\t\t

A complex type that specifies whether you want CloudFront to forward cookies to the origin \n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see \n\t\t\tCaching Content \n\t\t\t\tBased on Cookies in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include cookies in the cache key, use CookiesConfig in a\n\t\t\tcache policy. See CachePolicy.

\n

If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\t\tCookiesConfig in an origin request policy. See\n\t\t\t\tOriginRequestPolicy.

\n

A complex type that specifies whether you want CloudFront to forward cookies to the origin\n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see\n\t\t\t\tCaching Content Based on\n\t\t\t\tCookies in the Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#CopyDistribution": { @@ -2860,7 +2880,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a staging distribution using the configuration of the provided primary distribution.\n\t\t\tA staging distribution is a copy of an existing distribution (called the primary\n\t\t\tdistribution) that you can use in a continuous deployment workflow.

\n\t\t

After you create a staging distribution, you can use UpdateDistribution to\n\t\t\tmodify the staging distribution’s configuration. Then you can use\n\t\t\t\tCreateContinuousDeploymentPolicy to incrementally move traffic to the\n\t\t\tstaging distribution.

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

Creates a staging distribution using the configuration of the provided primary\n\t\t\tdistribution. A staging distribution is a copy of an existing distribution (called the\n\t\t\tprimary distribution) that you can use in a continuous deployment workflow.

\n

After you create a staging distribution, you can use UpdateDistribution\n\t\t\tto modify the staging distribution's configuration. Then you can use\n\t\t\t\tCreateContinuousDeploymentPolicy to incrementally move traffic to the\n\t\t\tstaging distribution.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution/{PrimaryDistributionId}/copy", @@ -2874,7 +2894,7 @@ "PrimaryDistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier of the primary distribution whose configuration you are copying. To get a\n\t\t\tdistribution ID, use ListDistributions.

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

The identifier of the primary distribution whose configuration you are copying. To get\n\t\t\ta distribution ID, use ListDistributions.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2882,21 +2902,21 @@ "Staging": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

The type of distribution that your primary distribution will be copied to. The only valid\n\t\t\tvalue is True, indicating that you are copying to a staging distribution.

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

The type of distribution that your primary distribution will be copied to. The only\n\t\t\tvalid value is True, indicating that you are copying to a staging\n\t\t\tdistribution.

", "smithy.api#httpHeader": "Staging" } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version identifier of the primary distribution whose configuration you are copying. This\n\t\t\tis the ETag value returned in the response to GetDistribution\n\t\t\tand GetDistributionConfig.

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

The version identifier of the primary distribution whose configuration you are\n\t\t\tcopying. This is the ETag value returned in the response to\n\t\t\t\tGetDistribution and GetDistributionConfig.

", "smithy.api#httpHeader": "If-Match" } }, "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A value that uniquely identifies a request to create a resource. This helps to prevent CloudFront\n\t\t\tfrom creating a duplicate resource if you accidentally resubmit an identical\n\t\t\trequest.

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

A value that uniquely identifies a request to create a resource. This helps to prevent\n\t\t\tCloudFront from creating a duplicate resource if you accidentally resubmit an identical\n\t\t\trequest.

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

Creates a cache policy.

\n\t\t

After you create a cache policy, you can attach it to one or more cache behaviors. When it’s\n\t\t\tattached to a cache behavior, the cache policy determines the following:

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

The headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind an object in its cache that matches the request’s cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy.

\n\t\t

For more information about cache policies, see Controlling the cache key in the\n\t\t\tAmazon CloudFront Developer Guide.

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

Creates a cache policy.

\n

After you create a cache policy, you can attach it to one or more cache behaviors.\n\t\t\tWhen it's attached to a cache behavior, the cache policy determines the\n\t\t\tfollowing:

\n \n

The headers, cookies, and query strings that are included in the cache key are\n\t\t\tautomatically included in requests that CloudFront sends to the origin. CloudFront sends a request\n\t\t\twhen it can't find an object in its cache that matches the request's cache key. If you\n\t\t\twant to send values to the origin but not include them in the cache\n\t\t\tkey, use OriginRequestPolicy.

\n

For more information about cache policies, see Controlling the cache key in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/cache-policy", @@ -3036,7 +3056,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can \n\t\t\tuse an origin access identity to require users to access your content using a CloudFront URL instead \n\t\t\tof the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the \n\t\t\t\tAmazon CloudFront Developer Guide.

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

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can\n\t\t\tuse an origin access identity to require users to access your content using a CloudFront URL\n\t\t\tinstead of the Amazon S3 URL. For more information about how to use origin access identities,\n\t\t\tsee Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-access-identity/cloudfront", @@ -3058,7 +3078,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request to create a new origin access identity (OAI). An origin access identity is a \n\t\t\tspecial CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or \n\t\t\tjust some of your Amazon S3 content. For more information, see \n\t\t\tRestricting Access to Amazon S3 Content by Using an Origin Access Identity in the \n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The request to create a new origin access identity (OAI). An origin access identity is\n\t\t\ta special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all\n\t\t\tor just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in\n\t\t\tthe Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentityResult": { @@ -3102,6 +3122,9 @@ { "target": "com.amazonaws.cloudfront#AccessDenied" }, + { + "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyAlreadyExists" + }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, @@ -3110,10 +3133,13 @@ }, { "target": "com.amazonaws.cloudfront#StagingDistributionInUse" + }, + { + "target": "com.amazonaws.cloudfront#TooManyContinuousDeploymentPolicies" } ], "traits": { - "smithy.api#documentation": "

Creates a continuous deployment policy that distributes traffic for a custom domain name to\n\t\t\ttwo different CloudFront distributions.

\n\t\t

To use a continuous deployment policy, first use\n\t\t\tCopyDistribution to create a staging distribution, then use\n\t\t\tUpdateDistribution to modify the staging distribution’s\n\t\t\tconfiguration.

\n\t\t

After you create and update a staging distribution, you can use a continuous deployment\n\t\t\tpolicy to incrementally move traffic to the staging distribution. This workflow enables\n\t\t\tyou to test changes to a distribution’s configuration before moving all of your domain’s\n\t\t\tproduction traffic to the new configuration.

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

Creates a continuous deployment policy that distributes traffic for a custom domain\n\t\t\tname to two different CloudFront distributions.

\n

To use a continuous deployment policy, first use CopyDistribution to\n\t\t\tcreate a staging distribution, then use UpdateDistribution to modify the\n\t\t\tstaging distribution's configuration.

\n

After you create and update a staging distribution, you can use a continuous\n\t\t\tdeployment policy to incrementally move traffic to the staging distribution. This\n\t\t\tworkflow enables you to test changes to a distribution's configuration before moving all\n\t\t\tof your domain's production traffic to the new configuration.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/continuous-deployment-policy", @@ -3155,7 +3181,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version identifier for the current version of the continuous deployment policy.

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

The version identifier for the current version of the continuous deployment\n\t\t\tpolicy.

", "smithy.api#httpHeader": "ETag" } } @@ -3176,6 +3202,9 @@ { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, + { + "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyInUse" + }, { "target": "com.amazonaws.cloudfront#DistributionAlreadyExists" }, @@ -3266,6 +3295,9 @@ { "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" + }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" }, @@ -3430,6 +3462,9 @@ { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, + { + "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyInUse" + }, { "target": "com.amazonaws.cloudfront#DistributionAlreadyExists" }, @@ -3520,6 +3555,9 @@ { "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" + }, { "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" }, @@ -3626,7 +3664,7 @@ "DistributionConfigWithTags": { "target": "com.amazonaws.cloudfront#DistributionConfigWithTags", "traits": { - "smithy.api#documentation": "

The distribution's configuration information.

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

The distribution's configuration information.

", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "DistributionConfigWithTags" @@ -3634,7 +3672,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request to create a new distribution with tags.

" + "smithy.api#documentation": "

The request to create a new distribution with tags.

" } }, "com.amazonaws.cloudfront#CreateDistributionWithTagsResult": { @@ -3643,7 +3681,7 @@ "Distribution": { "target": "com.amazonaws.cloudfront#Distribution", "traits": { - "smithy.api#documentation": "

The distribution's information.

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

The distribution's information.

", "smithy.api#httpPayload": {} } }, @@ -3663,7 +3701,7 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, "com.amazonaws.cloudfront#CreateFieldLevelEncryptionConfig": { @@ -3743,7 +3781,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

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

The current version of the field level encryption configuration. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -3826,7 +3864,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

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

The current version of the field level encryption profile. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -3858,7 +3896,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a CloudFront function.

\n\t\t

To create a function, you provide the function code and some configuration information\n\t\t\tabout the function. The response contains an Amazon Resource Name (ARN) that uniquely\n\t\t\tidentifies the function.

\n\t\t

When you create a function, it’s in the DEVELOPMENT stage. In this stage, you\n\t\t\tcan test the function with TestFunction, and update it with\n\t\t\tUpdateFunction.

\n\t\t

When you’re ready to use your function with a CloudFront distribution, use\n\t\t\tPublishFunction to copy the function from the DEVELOPMENT\n\t\t\tstage to LIVE. When it’s live, you can attach the function to a\n\t\t\tdistribution’s cache behavior, using the function’s ARN.

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

Creates a CloudFront function.

\n

To create a function, you provide the function code and some configuration information\n\t\t\tabout the function. The response contains an Amazon Resource Name (ARN) that uniquely\n\t\t\tidentifies the function.

\n

When you create a function, it's in the DEVELOPMENT stage. In this stage,\n\t\t\tyou can test the function with TestFunction, and update it with\n\t\t\t\tUpdateFunction.

\n

When you're ready to use your function with a CloudFront distribution, use\n\t\t\t\tPublishFunction to copy the function from the DEVELOPMENT\n\t\t\tstage to LIVE. When it's live, you can attach the function to a\n\t\t\tdistribution's cache behavior, using the function's ARN.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/function", @@ -3879,14 +3917,14 @@ "FunctionConfig": { "target": "com.amazonaws.cloudfront#FunctionConfig", "traits": { - "smithy.api#documentation": "

Configuration information about the function, including an optional comment and the\n\t\t\tfunction’s runtime.

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

Configuration information about the function, including an optional comment and the\n\t\t\tfunction's runtime.

", "smithy.api#required": {} } }, "FunctionCode": { "target": "com.amazonaws.cloudfront#FunctionBlob", "traits": { - "smithy.api#documentation": "

The function code. For more information about writing a CloudFront function, see Writing function\n\t\t\tcode for CloudFront Functions in the Amazon CloudFront Developer Guide.

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

The function code. For more information about writing a CloudFront function, see Writing\n\t\t\t\tfunction code for CloudFront Functions in the\n\t\t\tAmazon CloudFront Developer Guide.

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

Create a new invalidation.

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

Create a new invalidation.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution/{DistributionId}/invalidation", @@ -3989,7 +4027,7 @@ "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The fully qualified URI of the distribution and invalidation batch request, including \n\t\t\tthe Invalidation ID.

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

The fully qualified URI of the distribution and invalidation batch request, including\n\t\t\tthe Invalidation ID.

", "smithy.api#httpHeader": "Location" } }, @@ -4028,7 +4066,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a key group that you can use with CloudFront signed URLs and signed cookies.

\n\t\t

To create a key group, you must specify at least one public key for the key group. After you\n\t\t\tcreate a key group, you can reference it from one or more cache behaviors. When you\n\t\t\treference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies\n\t\t\tfor all requests that match the cache behavior. The URLs or cookies must be signed with\n\t\t\ta private key whose corresponding public key is in the key group. The signed URL or\n\t\t\tcookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

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

Creates a key group that you can use with CloudFront signed URLs and signed cookies.

\n

To create a key group, you must specify at least one public key for the key group.\n\t\t\tAfter you create a key group, you can reference it from one or more cache behaviors.\n\t\t\tWhen you reference a key group in a cache behavior, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/key-group", @@ -4099,7 +4137,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables additional CloudWatch metrics for the specified CloudFront distribution. The\n\t\t\tadditional metrics incur an additional cost.

\n\t\t

For more information, see Viewing additional CloudFront distribution metrics in the\n\t\t\tAmazon CloudFront Developer Guide.

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

Enables additional CloudWatch metrics for the specified CloudFront distribution. The\n\t\t\tadditional metrics incur an additional cost.

\n

For more information, see Viewing additional CloudFront distribution metrics in\n\t\t\tthe Amazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", @@ -4121,7 +4159,7 @@ "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { - "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

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

A monitoring subscription. This structure contains information about whether\n\t\t\tadditional CloudWatch metrics are enabled for a given CloudFront distribution.

", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "MonitoringSubscription" @@ -4135,7 +4173,7 @@ "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { - "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

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

A monitoring subscription. This structure contains information about whether\n\t\t\tadditional CloudWatch metrics are enabled for a given CloudFront distribution.

", "smithy.api#httpPayload": {} } } @@ -4161,7 +4199,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new origin access control in CloudFront. After you create an origin access control, you\n\t\t\tcan add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed)\n\t\t\trequests to the origin.

\n\t\t

For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket\n\t\t\tso that viewers (users) can access the content in the bucket only through CloudFront.

\n\t\t

For more information about using a CloudFront origin access control, see Restricting access to an Amazon S3 origin in the\n\t\t\tAmazon CloudFront Developer Guide.

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

Creates a new origin access control in CloudFront. After you create an origin access\n\t\t\tcontrol, you can add it to an origin in a CloudFront distribution so that CloudFront sends\n\t\t\tauthenticated (signed) requests to the origin.

\n

For an Amazon S3 origin, this makes it possible to block public access to the Amazon S3 bucket\n\t\t\tso that viewers (users) can access the content in the bucket only through CloudFront.

\n

For more information about using a CloudFront origin access control, see Restricting access to an Amazon S3 origin in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-access-control", @@ -4244,7 +4282,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an origin request policy.

\n\t\t

After you create an origin request policy, you can attach it to one or more cache behaviors.\n\t\t\tWhen it’s attached to a cache behavior, the origin request policy determines the values\n\t\t\tthat CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends\n\t\t\tto the origin includes the following:

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

CloudFront sends a request when it can’t find a valid object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy.

\n\t\t

For more information about origin request policies, see Controlling origin requests in the\n\t\t\tAmazon CloudFront Developer Guide.

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

Creates an origin request policy.

\n

After you create an origin request policy, you can attach it to one or more cache\n\t\t\tbehaviors. When it's attached to a cache behavior, the origin request policy determines\n\t\t\tthe values that CloudFront includes in requests that it sends to the origin. Each request that\n\t\t\tCloudFront sends to the origin includes the following:

\n \n

CloudFront sends a request when it can't find a valid object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy.

\n

For more information about origin request policies, see Controlling origin requests in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/origin-request-policy", @@ -4383,7 +4421,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a real-time log configuration.

\n\t\t

After you create a real-time log configuration, you can attach it to one or more cache\n\t\t\tbehaviors to send real-time log data to the specified Amazon Kinesis data stream.

\n\t\t

For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.

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

Creates a real-time log configuration.

\n

After you create a real-time log configuration, you can attach it to one or more cache\n\t\t\tbehaviors to send real-time log data to the specified Amazon Kinesis data stream.

\n

For more information about real-time log configurations, see Real-time logs in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/realtime-log-config", @@ -4404,7 +4442,7 @@ "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { - "smithy.api#documentation": "

A list of fields to include in each real-time log record.

\n\t\t

For more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.

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

A list of fields to include in each real-time log record.

\n

For more information about fields, see Real-time log configuration fields in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, @@ -4418,7 +4456,7 @@ "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. You must\n\t\t\tprovide an integer between 1 and 100, inclusive.

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

The sampling rate for this real-time log configuration. The sampling rate determines\n\t\t\tthe percentage of viewer requests that are represented in the real-time log data. You\n\t\t\tmust provide an integer between 1 and 100, inclusive.

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

Creates a response headers policy.

\n\t\t

A response headers policy contains information about a set of HTTP response headers\n\t\t\tand their values. To create a response headers policy, you provide some metadata about\n\t\t\tthe policy, and a set of configurations that specify the response headers.

\n\t\t

After you create a response headers policy, you can use its ID to attach it to one or more\n\t\t\tcache behaviors in a CloudFront distribution. When it’s attached to a cache behavior, CloudFront\n\t\t\tadds the headers in the policy to HTTP responses that it sends for requests that match\n\t\t\tthe cache behavior.

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

Creates a response headers policy.

\n

A response headers policy contains information about a set of HTTP response headers\n\t\t\tand their values. To create a response headers policy, you provide some metadata about\n\t\t\tthe policy, and a set of configurations that specify the response headers.

\n

After you create a response headers policy, you can use its ID to attach it to one or\n\t\t\tmore cache behaviors in a CloudFront distribution. When it's attached to a cache behavior,\n\t\t\tCloudFront adds the headers in the policy to HTTP responses that it sends for requests that\n\t\t\tmatch the cache behavior.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/response-headers-policy", @@ -4565,7 +4603,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is deprecated.\n Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020.\n For more information, read the announcement on the Amazon CloudFront discussion forum.

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

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP)\n\t\t\tdistributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion\n\t\t\tforum.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/streaming-distribution", @@ -4603,7 +4641,7 @@ "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The fully qualified URI of the new streaming distribution resource just created.

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

The fully qualified URI of the new streaming distribution resource just\n\t\t\tcreated.

", "smithy.api#httpHeader": "Location" } }, @@ -4672,7 +4710,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is deprecated.\n Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020.\n For more information, read the announcement on the Amazon CloudFront discussion forum.

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

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP)\n\t\t\tdistributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion\n\t\t\tforum.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/streaming-distribution?WithTags", @@ -4686,7 +4724,7 @@ "StreamingDistributionConfigWithTags": { "target": "com.amazonaws.cloudfront#StreamingDistributionConfigWithTags", "traits": { - "smithy.api#documentation": "

The streaming distribution's configuration information.

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

The streaming distribution's configuration information.

", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "StreamingDistributionConfigWithTags" @@ -4703,14 +4741,14 @@ "StreamingDistribution": { "target": "com.amazonaws.cloudfront#StreamingDistribution", "traits": { - "smithy.api#documentation": "

The streaming distribution's information.

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

The streaming distribution's information.

", "smithy.api#httpPayload": {} } }, "Location": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The fully qualified URI of the new streaming distribution resource just created.

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

The fully qualified URI of the new streaming distribution resource just\n\t\t\tcreated.

", "smithy.api#httpHeader": "Location" } }, @@ -4723,7 +4761,7 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, "com.amazonaws.cloudfront#CustomErrorResponse": { @@ -4732,31 +4770,31 @@ "ErrorCode": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The HTTP status code for which you want to specify a custom error page and/or a caching \n\t\t\tduration.

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

The HTTP status code for which you want to specify a custom error page and/or a\n\t\t\tcaching duration.

", "smithy.api#required": {} } }, "ResponsePagePath": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The path to the custom error page that you want CloudFront to return to a viewer when your \n\t\t\torigin returns the HTTP status code specified by ErrorCode, for example, \n\t\t\t\t/4xx-errors/403-forbidden.html. If you want to store your objects and your \n\t\t\tcustom error pages in different locations, your distribution must include a cache behavior for \n\t\t\twhich the following is true:

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

If you specify a value for ResponsePagePath, you must also specify a value\n\t\t\tfor ResponseCode.

\n\t\t

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom \n\t\t\terror pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the \n\t\t\tfiles that you want to return to viewers because the origin server is unavailable.

" + "smithy.api#documentation": "

The path to the custom error page that you want CloudFront to return to a viewer when your\n\t\t\torigin returns the HTTP status code specified by ErrorCode, for example,\n\t\t\t\t/4xx-errors/403-forbidden.html. If you want to store your objects and\n\t\t\tyour custom error pages in different locations, your distribution must include a cache\n\t\t\tbehavior for which the following is true:

\n \n

If you specify a value for ResponsePagePath, you must also specify a\n\t\t\tvalue for ResponseCode.

\n

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom\n\t\t\terror pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get\n\t\t\tthe files that you want to return to viewers because the origin server is\n\t\t\tunavailable.

" } }, "ResponseCode": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The HTTP status code that you want CloudFront to return to the viewer along with the custom \n\t\t\terror page. There are a variety of reasons that you might want CloudFront to return a status code \n\t\t\tdifferent from the status code that your origin returned to CloudFront, for example:

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

If you specify a value for ResponseCode, you must also specify a value for\n\t\t\tResponsePagePath.

" + "smithy.api#documentation": "

The HTTP status code that you want CloudFront to return to the viewer along with the custom\n\t\t\terror page. There are a variety of reasons that you might want CloudFront to return a status\n\t\t\tcode different from the status code that your origin returned to CloudFront, for\n\t\t\texample:

\n \n

If you specify a value for ResponseCode, you must also specify a value\n\t\t\tfor ResponsePagePath.

" } }, "ErrorCachingMinTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status \n\t\t\tcode specified in ErrorCode. When this time period has elapsed, CloudFront queries your \n\t\t\torigin to see whether the problem that caused the error has been resolved and the requested \n\t\t\tobject is now available.

\n\t\t

For more information, see Customizing \n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status\n\t\t\tcode specified in ErrorCode. When this time period has elapsed, CloudFront\n\t\t\tqueries your origin to see whether the problem that caused the error has been resolved\n\t\t\tand the requested object is now available.

\n

For more information, see Customizing\n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.

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

A complex type that controls:

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

For more information about custom error pages, see Customizing Error Responses in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A complex type that controls:

\n \n

For more information about custom error pages, see Customizing\n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#CustomErrorResponseList": { @@ -4774,19 +4812,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of HTTP status codes for which you want to specify a custom error page \n\t\t\tand/or a caching duration. If Quantity is 0, you can omit \n\t\t\t\tItems.

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

The number of HTTP status codes for which you want to specify a custom error page\n\t\t\tand/or a caching duration. If Quantity is 0, you can omit\n\t\t\t\tItems.

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#CustomErrorResponseList", "traits": { - "smithy.api#documentation": "

A complex type that contains a CustomErrorResponse element for each HTTP \n\t\t\tstatus code for which you want to specify a custom error page and/or a caching duration. \n\t\t

" + "smithy.api#documentation": "

A complex type that contains a CustomErrorResponse element for each HTTP\n\t\t\tstatus code for which you want to specify a custom error page and/or a caching duration.\n\t\t

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

A complex type that controls:

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

For more information about custom error pages, see Customizing Error Responses in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A complex type that controls:

\n \n

For more information about custom error pages, see Customizing\n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#CustomHeaders": { @@ -4802,12 +4840,12 @@ "Items": { "target": "com.amazonaws.cloudfront#OriginCustomHeadersList", "traits": { - "smithy.api#documentation": "

\n Optional: A list that contains one \n\t\t\t\tOriginCustomHeader element for each custom header that you want CloudFront to forward \n\t\t\tto the origin. If Quantity is 0, omit Items.

" + "smithy.api#documentation": "

\n Optional: A list that contains one\n\t\t\t\tOriginCustomHeader element for each custom header that you want CloudFront to\n\t\t\tforward to the origin. If Quantity is 0, omit Items.

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

A complex type that contains the list of Custom Headers for each origin.

" + "smithy.api#documentation": "

A complex type that contains the list of Custom Headers for each origin.

" } }, "com.amazonaws.cloudfront#CustomOriginConfig": { @@ -4816,45 +4854,45 @@ "HTTPPort": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin\n\t\t\tlistens on.

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

The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the\n\t\t\torigin listens on.

", "smithy.api#required": {} } }, "HTTPSPort": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the\n\t\t\torigin listens on.

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

The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that\n\t\t\tthe origin listens on.

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

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values\n\t\t\tare:

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

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid\n\t\t\tvalues are:

\n ", "smithy.api#required": {} } }, "OriginSslProtocols": { "target": "com.amazonaws.cloudfront#OriginSslProtocols", "traits": { - "smithy.api#documentation": "

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over\n\t\t\tHTTPS. Valid values include SSLv3, TLSv1,\n\t\t\tTLSv1.1, and TLSv1.2.

\n\t\t

For more information, see Minimum Origin SSL Protocol in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin\n\t\t\tover HTTPS. Valid values include SSLv3, TLSv1,\n\t\t\t\tTLSv1.1, and TLSv1.2.

\n

For more information, see Minimum Origin SSL Protocol in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "OriginReadTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also\n\t\t\tknown as the origin response timeout. The minimum timeout is 1\n\t\t\tsecond, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is\n\t\t\t30 seconds.

\n\t\t

For more information, see Origin Response Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is\n\t\t\talso known as the origin response timeout. The minimum timeout is 1\n\t\t\tsecond, the maximum is 60 seconds, and the default (if you don't specify otherwise) is\n\t\t\t30 seconds.

\n

For more information, see Origin Response Timeout in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "OriginKeepaliveTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum\n\t\t\ttimeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify\n\t\t\totherwise) is 5 seconds.

\n\t\t

For more information, see Origin Keep-alive Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin. The\n\t\t\tminimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't\n\t\t\tspecify otherwise) is 5 seconds.

\n

For more information, see Origin Keep-alive Timeout in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

A custom origin. A custom origin is any origin that is not an Amazon S3\n\t\t\tbucket, with one exception. An Amazon S3 bucket that is configured with\n\t\t\tstatic website hosting \n is a custom origin.

" + "smithy.api#documentation": "

A custom origin. A custom origin is any origin that is not an\n\t\t\tAmazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with\n\t\t\t\tstatic website hosting\n is a custom origin.

" } }, "com.amazonaws.cloudfront#DefaultCacheBehavior": { @@ -4863,26 +4901,26 @@ "TargetOriginId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of ID for the origin that you want CloudFront to route requests to when\n\t\t\tthey use the default cache behavior.

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

The value of ID for the origin that you want CloudFront to route requests to\n\t\t\twhen they use the default cache behavior.

", "smithy.api#required": {} } }, "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "\n\t\t\t

We recommend using TrustedKeyGroups instead of\n\t\t\t\tTrustedSigners.

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

A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed\n\t\t\tcookies.

\n\t\t

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies\n\t\t\tfor all requests that match the cache behavior. The URLs or cookies must be signed with\n\t\t\tthe private key of a CloudFront key pair in a trusted signer’s Amazon Web Services account. The signed URL or\n\t\t\tcookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

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

We recommend using TrustedKeyGroups instead of\n\t\t\t\t\tTrustedSigners.

\n \n

A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or\n\t\t\tsigned cookies.

\n

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The\n\t\t\tsigned URL or cookie contains information about which public key CloudFront should use to\n\t\t\tverify the signature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "TrustedKeyGroups": { "target": "com.amazonaws.cloudfront#TrustedKeyGroups", "traits": { - "smithy.api#documentation": "

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

\n\t\t

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A list of key groups that CloudFront can use to validate signed URLs or signed\n\t\t\tcookies.

\n

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed\n\t\t\tcookies for all requests that match the cache behavior. The URLs or cookies must be\n\t\t\tsigned with a private key whose corresponding public key is in the key group. The signed\n\t\t\tURL or cookie contains information about which public key CloudFront should use to verify the\n\t\t\tsignature. For more information, see Serving private content in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "ViewerProtocolPolicy": { "target": "com.amazonaws.cloudfront#ViewerProtocolPolicy", "traits": { - "smithy.api#documentation": "

The protocol that viewers can use to access the files in the origin specified by \n\t\t\t\tTargetOriginId when a request matches the path pattern in \n\t\t\t\tPathPattern. You can specify the following options:

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

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

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

The only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects’ cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\tManaging Cache\n\t\t\t\tExpiration in the \n\t\t\t\t\tAmazon CloudFront Developer Guide.

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

The protocol that viewers can use to access the files in the origin specified by\n\t\t\t\tTargetOriginId when a request matches the path pattern in\n\t\t\t\tPathPattern. You can specify the following options:

\n \n

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n \n

The only way to guarantee that viewers retrieve an object that was fetched from\n\t\t\t\tthe origin using HTTPS is never to use any other protocol to fetch the object. If\n\t\t\t\tyou have recently changed from HTTP to HTTPS, we recommend that you clear your\n\t\t\t\tobjects' cache because cached objects are protocol agnostic. That means that an edge\n\t\t\t\tlocation will return an object from the cache regardless of whether the current\n\t\t\t\trequest protocol matches the protocol used previously. For more information, see\n\t\t\t\t\tManaging Cache\n\t\t\t\t\tExpiration in the Amazon CloudFront Developer Guide.

\n ", "smithy.api#required": {} } }, @@ -4892,49 +4930,49 @@ "SmoothStreaming": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming \n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify \n\t\t\t\ttrue; if not, specify false. If you specify true for \n\t\t\t\tSmoothStreaming, you can still distribute other content using this cache \n\t\t\tbehavior if the content matches the value of PathPattern.

" + "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming\n\t\t\tformat using the origin that is associated with this cache behavior. If so, specify\n\t\t\t\ttrue; if not, specify false. If you specify\n\t\t\t\ttrue for SmoothStreaming, you can still distribute other\n\t\t\tcontent using this cache behavior if the content matches the value of\n\t\t\t\tPathPattern.

" } }, "Compress": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior. \n\t\t\tIf so, specify true; if not, specify false. For more information, \n\t\t\tsee Serving Compressed Files in \n\t\t\tthe Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Whether you want CloudFront to automatically compress certain files for this cache behavior.\n\t\t\tIf so, specify true; if not, specify false. For more\n\t\t\tinformation, see Serving\n\t\t\t\tCompressed Files in the Amazon CloudFront Developer Guide.

" } }, "LambdaFunctionAssociations": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociations", "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more Lambda@Edge function associations for a cache \n\t\t\tbehavior.

" + "smithy.api#documentation": "

A complex type that contains zero or more Lambda@Edge function associations for a\n\t\t\tcache behavior.

" } }, "FunctionAssociations": { "target": "com.amazonaws.cloudfront#FunctionAssociations", "traits": { - "smithy.api#documentation": "

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must\n\t\t\tbe published to the LIVE stage to associate them with a cache\n\t\t\tbehavior.

" + "smithy.api#documentation": "

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions\n\t\t\tmust be published to the LIVE stage to associate them with a cache\n\t\t\tbehavior.

" } }, "FieldLevelEncryptionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of ID for the field-level encryption configuration that you want CloudFront\n\t\t\tto use for encrypting specific fields of data for the default cache behavior.

" + "smithy.api#documentation": "

The value of ID for the field-level encryption configuration that you\n\t\t\twant CloudFront to use for encrypting specific fields of data for the default cache\n\t\t\tbehavior.

" } }, "RealtimeLogConfigArn": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this\n\t\t\tcache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to\n\t\t\tthis cache behavior. For more information, see Real-time logs in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "CachePolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of the cache policy that is attached to the default cache behavior.\n\t\t\tFor more information, see Creating cache policies or Using the managed cache policies in the\n Amazon CloudFront Developer Guide.

\n

A DefaultCacheBehavior must include either a\n CachePolicyId or ForwardedValues. We recommend that you\n use a CachePolicyId.

" + "smithy.api#documentation": "

The unique identifier of the cache policy that is attached to the default cache\n\t\t\tbehavior. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

A DefaultCacheBehavior must include either a CachePolicyId\n\t\t\tor ForwardedValues. We recommend that you use a\n\t\t\tCachePolicyId.

" } }, "OriginRequestPolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of the origin request policy that is attached to the default cache\n\t\t\tbehavior. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The unique identifier of the origin request policy that is attached to the default\n\t\t\tcache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "ResponseHeadersPolicyId": { @@ -4947,33 +4985,33 @@ "target": "com.amazonaws.cloudfront#ForwardedValues", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin request\n\t\t\tpolicy instead of this field. For more information, see Working with policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you want to include values in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

If you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n Amazon CloudFront Developer Guide.

\n

A DefaultCacheBehavior must include either a\n CachePolicyId or ForwardedValues. We recommend that you\n use a CachePolicyId.

\n\t\t

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field. For more information, see Working with policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

If you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

If you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies or Using the managed origin request policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

A DefaultCacheBehavior must include either a CachePolicyId\n\t\t\tor ForwardedValues. We recommend that you use a\n\t\t\tCachePolicyId.

\n

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP\n\t\t\theaders.

" } }, "MinTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. For \n\t\t\tmore information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

\n\t\t

You must specify 0 for MinTTL if you configure CloudFront to \n\t\t\tforward all headers to your origin (under Headers, if you specify 1 \n\t\t\tfor Quantity and * for Name).

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. For more information, see Managing How Long\n\t\t\t\tContent Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

You must specify 0 for MinTTL if you configure CloudFront to\n\t\t\tforward all headers to your origin (under Headers, if you specify\n\t\t\t\t1 for Quantity and * for\n\t\t\tName).

" } }, "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The default amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin does not add HTTP headers such as \n\t\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field\n\t\t\tin a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

The default amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. The value that you specify applies only when your origin does not add HTTP\n\t\t\theaders such as Cache-Control max-age, Cache-Control s-maxage,\n\t\t\tand Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "MaxTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a cache\n\t\t\tpolicy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront \n\t\t\tforwards another request to your origin to determine whether the object has been updated. The \n\t\t\tvalue that you specify applies only when your origin adds HTTP headers such as \n\t\t\tCache-Control max-age, Cache-Control s-maxage, and \n\t\t\tExpires to objects. For more information, see Managing How Long Content Stays \n\t\t\t\tin an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a\n\t\t\tcache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront\n\t\t\tforwards another request to your origin to determine whether the object has been\n\t\t\tupdated. The value that you specify applies only when your origin adds HTTP headers such\n\t\t\tas Cache-Control max-age, Cache-Control s-maxage, and\n\t\t\t\tExpires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

A complex type that describes the default cache behavior if you don’t specify a\n\t\t\tCacheBehavior element or if request URLs don’t match any of the values of\n\t\t\tPathPattern in CacheBehavior elements. You must create exactly\n\t\t\tone default cache behavior.

" + "smithy.api#documentation": "

A complex type that describes the default cache behavior if you don't specify a\n\t\t\t\tCacheBehavior element or if request URLs don't match any of the values\n\t\t\tof PathPattern in CacheBehavior elements. You must create\n\t\t\texactly one default cache behavior.

" } }, "com.amazonaws.cloudfront#DeleteCachePolicy": { @@ -5005,7 +5043,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a cache policy.

\n\t\t

You cannot delete a cache policy if it’s attached to a cache behavior. First update your\n\t\t\tdistributions to remove the cache policy from all cache behaviors, then delete the cache\n\t\t\tpolicy.

\n\t\t

To delete a cache policy, you must provide the policy’s identifier and version. To get these\n\t\t\tvalues, you can use ListCachePolicies or\n\t\t\tGetCachePolicy.

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

Deletes a cache policy.

\n

You cannot delete a cache policy if it's attached to a cache behavior. First update\n\t\t\tyour distributions to remove the cache policy from all cache behaviors, then delete the\n\t\t\tcache policy.

\n

To delete a cache policy, you must provide the policy's identifier and version. To get\n\t\t\tthese values, you can use ListCachePolicies or\n\t\t\tGetCachePolicy.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/cache-policy/{Id}", @@ -5027,7 +5065,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version of the cache policy that you are deleting. The version is the cache\n\t\t\tpolicy’s ETag value, which you can get using\n\t\t\tListCachePolicies, GetCachePolicy, or\n\t\t\tGetCachePolicyConfig.

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

The version of the cache policy that you are deleting. The version is the cache\n\t\t\tpolicy's ETag value, which you can get using\n\t\t\tListCachePolicies, GetCachePolicy, or\n\t\t\t\tGetCachePolicyConfig.

", "smithy.api#httpHeader": "If-Match" } } @@ -5059,7 +5097,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete an origin access identity.

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

Delete an origin access identity.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}", @@ -5081,7 +5119,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header you received from a previous GET \n\t\t\tor PUT request. For example: E2QWRUHAPOMQZL.

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

The value of the ETag header you received from a previous\n\t\t\t\tGET or PUT request. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -5102,18 +5140,24 @@ { "target": "com.amazonaws.cloudfront#AccessDenied" }, + { + "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyInUse" + }, { "target": "com.amazonaws.cloudfront#InvalidArgument" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" + }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { - "smithy.api#documentation": "

Deletes a continuous deployment policy.

\n\t\t

You cannot delete a continuous deployment policy that’s attached to a primary\n\t\t\tdistribution. First update your distribution to remove the continuous deployment policy,\n\t\t\tthen you can delete the policy.

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

Deletes a continuous deployment policy.

\n

You cannot delete a continuous deployment policy that's attached to a primary\n\t\t\tdistribution. First update your distribution to remove the continuous deployment policy,\n\t\t\tthen you can delete the policy.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/continuous-deployment-policy/{Id}", @@ -5167,7 +5211,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete a distribution.

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

Delete a distribution.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/distribution/{Id}", @@ -5181,7 +5225,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution ID.

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

The distribution ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5189,13 +5233,13 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when you disabled the \n\t\t\tdistribution. For example: E2QWRUHAPOMQZL.

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

The value of the ETag header that you received when you disabled the\n\t\t\tdistribution. For example: E2QWRUHAPOMQZL.

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

This action deletes a web distribution. To delete a web distribution using the CloudFront \n\t\t\tAPI, perform the following steps.

\n\t\t

\n\t\t\t To delete a web distribution using the CloudFront API: \n\t\t

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

    Disable the web distribution

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

    Submit a GET Distribution Config request to get the current \n\t\t\t\t\tconfiguration and the Etag header for the distribution.

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

    Update the XML document that was returned in the response to your GET \n\t\t\t\t\t\tDistribution Config request to change the value of Enabled to \n\t\t\t\t\t\tfalse.

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

    Submit a PUT Distribution Config request to update the configuration \n\t\t\t\t\tfor your distribution. In the request body, include the XML document that you updated in \n\t\t\t\t\tStep 3. Set the value of the HTTP If-Match header to the value of the \n\t\t\t\t\t\tETag header that CloudFront returned when you submitted the GET \n\t\t\t\t\t\tDistribution Config request in Step 2.

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

    Review the response to the PUT Distribution Config request to confirm \n\t\t\t\t\tthat the distribution was successfully disabled.

    \n\t\t\t
    6. \n
  6. \n\t\t\t\t

    Submit a GET Distribution request to confirm that your changes have \n\t\t\t\t\tpropagated. When propagation is complete, the value of Status is \n\t\t\t\t\t\tDeployed.

    \n\t\t\t
    7. \n
  7. \n\t\t\t\t

    Submit a DELETE Distribution request. Set the value of the HTTP \n\t\t\t\t\t\tIf-Match header to the value of the ETag header that CloudFront \n\t\t\t\t\treturned when you submitted the GET Distribution Config request in Step \n\t\t\t\t\t6.

    \n\t\t\t
    8. \n
  8. \n\t\t\t\t

    Review the response to your DELETE Distribution request to confirm \n\t\t\t\t\tthat the distribution was successfully deleted.

    \n\t\t\t
    9. \n
\n\t\t

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This action deletes a web distribution. To delete a web distribution using the CloudFront\n\t\t\tAPI, perform the following steps.

\n

\n To delete a web distribution using the CloudFront API:\n

\n
    \n
  1. \n

    Disable the web distribution

    \n
    2. \n
  2. \n

    Submit a GET Distribution Config request to get the current\n\t\t\t\t\tconfiguration and the Etag header for the distribution.

    \n
    3. \n
  3. \n

    Update the XML document that was returned in the response to your GET\n\t\t\t\t\t\tDistribution Config request to change the value of\n\t\t\t\t\t\tEnabled to false.

    \n
    4. \n
  4. \n

    Submit a PUT Distribution Config request to update the\n\t\t\t\t\tconfiguration for your distribution. In the request body, include the XML\n\t\t\t\t\tdocument that you updated in Step 3. Set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Distribution Config\n\t\t\t\t\trequest in Step 2.

    \n
    5. \n
  5. \n

    Review the response to the PUT Distribution Config request to\n\t\t\t\t\tconfirm that the distribution was successfully disabled.

    \n
    6. \n
  6. \n

    Submit a GET Distribution request to confirm that your changes\n\t\t\t\t\thave propagated. When propagation is complete, the value of Status\n\t\t\t\t\tis Deployed.

    \n
    7. \n
  7. \n

    Submit a DELETE Distribution request. Set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Distribution Config\n\t\t\t\t\trequest in Step 6.

    \n
    8. \n
  8. \n

    Review the response to your DELETE Distribution request to\n\t\t\t\t\tconfirm that the distribution was successfully deleted.

    \n
    9. \n
\n

For information about deleting a distribution using the CloudFront console, see Deleting a\n\t\t\t\tDistribution in the Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfig": { @@ -5246,7 +5290,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tconfiguration identity to delete. For example: E2QWRUHAPOMQZL.

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

The value of the ETag header that you received when retrieving the\n\t\t\tconfiguration identity to delete. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -5300,7 +5344,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tprofile to delete. For example: E2QWRUHAPOMQZL.

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

The value of the ETag header that you received when retrieving the\n\t\t\tprofile to delete. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -5332,7 +5376,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a CloudFront function.

\n\t\t

You cannot delete a function if it’s associated with a cache behavior. First, update your\n\t\t\tdistributions to remove the function association from all cache behaviors, then delete\n\t\t\tthe function.

\n\t\t

To delete a function, you must provide the function’s name and version\n\t\t\t(ETag value). To get these values, you can use ListFunctions\n\t\t\tand DescribeFunction.

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

Deletes a CloudFront function.

\n

You cannot delete a function if it's associated with a cache behavior. First, update\n\t\t\tyour distributions to remove the function association from all cache behaviors, then\n\t\t\tdelete the function.

\n

To delete a function, you must provide the function's name and version\n\t\t\t\t(ETag value). To get these values, you can use\n\t\t\t\tListFunctions and DescribeFunction.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/function/{Name}", @@ -5354,7 +5398,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version (ETag value) of the function that you are deleting, which\n\t\t\tyou can get using DescribeFunction.

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

The current version (ETag value) of the function that you are deleting,\n\t\t\twhich you can get using DescribeFunction.

", "smithy.api#httpHeader": "If-Match", "smithy.api#required": {} } @@ -5384,7 +5428,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a key group.

\n\t\t

You cannot delete a key group that is referenced in a cache behavior. First update\n\t\t\tyour distributions to remove the key group from all cache behaviors, then delete the key\n\t\t\tgroup.

\n\t\t

To delete a key group, you must provide the key group’s identifier and version. To get\n\t\t\tthese values, use ListKeyGroups followed by GetKeyGroup or\n\t\t\tGetKeyGroupConfig.

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

Deletes a key group.

\n

You cannot delete a key group that is referenced in a cache behavior. First update\n\t\t\tyour distributions to remove the key group from all cache behaviors, then delete the key\n\t\t\tgroup.

\n

To delete a key group, you must provide the key group's identifier and version. To get\n\t\t\tthese values, use ListKeyGroups followed by GetKeyGroup or\n\t\t\t\tGetKeyGroupConfig.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/key-group/{Id}", @@ -5398,7 +5442,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier of the key group that you are deleting. To get the identifier, use\n\t\t\tListKeyGroups.

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

The identifier of the key group that you are deleting. To get the identifier, use\n\t\t\t\tListKeyGroups.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5406,7 +5450,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version of the key group that you are deleting. The version is the key group’s\n\t\t\tETag value. To get the ETag, use GetKeyGroup or\n\t\t\tGetKeyGroupConfig.

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

The version of the key group that you are deleting. The version is the key group's\n\t\t\t\tETag value. To get the ETag, use GetKeyGroup\n\t\t\tor GetKeyGroupConfig.

", "smithy.api#httpHeader": "If-Match" } } @@ -5435,7 +5479,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables additional CloudWatch metrics for the specified CloudFront distribution.

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

Disables additional CloudWatch metrics for the specified CloudFront\n\t\t\tdistribution.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", @@ -5486,7 +5530,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a CloudFront origin access control.

\n\t\t

You cannot delete an origin access control if it's in use. First, update all distributions\n\t\t\tto remove the origin access control from all origins, then delete the origin access\n\t\t\tcontrol.

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

Deletes a CloudFront origin access control.

\n

You cannot delete an origin access control if it's in use. First, update all\n\t\t\tdistributions to remove the origin access control from all origins, then delete the\n\t\t\torigin access control.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/origin-access-control/{Id}", @@ -5508,7 +5552,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version (ETag value) of the origin access control that you are\n\t\t\tdeleting.

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

The current version (ETag value) of the origin access control that you\n\t\t\tare deleting.

", "smithy.api#httpHeader": "If-Match" } } @@ -5543,7 +5587,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an origin request policy.

\n\t\t

You cannot delete an origin request policy if it’s attached to any cache behaviors. First\n\t\t\tupdate your distributions to remove the origin request policy from all cache behaviors,\n\t\t\tthen delete the origin request policy.

\n\t\t

To delete an origin request policy, you must provide the policy’s identifier and version. To\n\t\t\tget the identifier, you can use ListOriginRequestPolicies or\n\t\t\tGetOriginRequestPolicy.

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

Deletes an origin request policy.

\n

You cannot delete an origin request policy if it's attached to any cache behaviors.\n\t\t\tFirst update your distributions to remove the origin request policy from all cache\n\t\t\tbehaviors, then delete the origin request policy.

\n

To delete an origin request policy, you must provide the policy's identifier and\n\t\t\tversion. To get the identifier, you can use ListOriginRequestPolicies or\n\t\t\t\tGetOriginRequestPolicy.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/origin-request-policy/{Id}", @@ -5565,7 +5609,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version of the origin request policy that you are deleting. The version is the origin\n\t\t\trequest policy’s ETag value, which you can get using\n\t\t\tListOriginRequestPolicies, GetOriginRequestPolicy, or\n\t\t\tGetOriginRequestPolicyConfig.

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

The version of the origin request policy that you are deleting. The version is the\n\t\t\torigin request policy's ETag value, which you can get using\n\t\t\t\tListOriginRequestPolicies, GetOriginRequestPolicy, or\n\t\t\t\tGetOriginRequestPolicyConfig.

", "smithy.api#httpHeader": "If-Match" } } @@ -5619,7 +5663,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tpublic key identity to delete. For example: E2QWRUHAPOMQZL.

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

The value of the ETag header that you received when retrieving the public\n\t\t\tkey identity to delete. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -5648,7 +5692,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a real-time log configuration.

\n\t\t

You cannot delete a real-time log configuration if it’s attached to a cache behavior.\n\t\t\tFirst update your distributions to remove the real-time log configuration from all cache\n\t\t\tbehaviors, then delete the real-time log configuration.

\n\t\t

To delete a real-time log configuration, you can provide the configuration’s name or its\n\t\t\tAmazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront\n\t\t\tuses the name to identify the real-time log configuration to delete.

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

Deletes a real-time log configuration.

\n

You cannot delete a real-time log configuration if it's attached to a cache behavior.\n\t\t\tFirst update your distributions to remove the real-time log configuration from all cache\n\t\t\tbehaviors, then delete the real-time log configuration.

\n

To delete a real-time log configuration, you can provide the configuration's name or\n\t\t\tits Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront\n\t\t\tuses the name to identify the real-time log configuration to delete.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/delete-realtime-log-config", @@ -5702,7 +5746,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a response headers policy.

\n\t\t

You cannot delete a response headers policy if it’s attached to a cache behavior.\n\t\t\tFirst update your distributions to remove the response headers policy from all cache\n\t\t\tbehaviors, then delete the response headers policy.

\n\t\t

To delete a response headers policy, you must provide the policy’s identifier and\n\t\t\tversion. To get these values, you can use ListResponseHeadersPolicies or\n\t\t\t\tGetResponseHeadersPolicy.

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

Deletes a response headers policy.

\n

You cannot delete a response headers policy if it's attached to a cache behavior.\n\t\t\tFirst update your distributions to remove the response headers policy from all cache\n\t\t\tbehaviors, then delete the response headers policy.

\n

To delete a response headers policy, you must provide the policy's identifier and\n\t\t\tversion. To get these values, you can use ListResponseHeadersPolicies or\n\t\t\t\tGetResponseHeadersPolicy.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/response-headers-policy/{Id}", @@ -5716,7 +5760,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the response headers policy that you are deleting.

\n\t\t

To get the identifier, you can use ListResponseHeadersPolicies.

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

The identifier for the response headers policy that you are deleting.

\n

To get the identifier, you can use ListResponseHeadersPolicies.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5724,7 +5768,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version of the response headers policy that you are deleting.

\n\t\t

The version is the response headers policy’s ETag value, which you can\n\t\t\tget using ListResponseHeadersPolicies,\n\t\t\t\tGetResponseHeadersPolicy, or\n\t\t\t\tGetResponseHeadersPolicyConfig.

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

The version of the response headers policy that you are deleting.

\n

The version is the response headers policy's ETag value, which you can\n\t\t\tget using ListResponseHeadersPolicies,\n\t\t\t\tGetResponseHeadersPolicy, or\n\t\t\t\tGetResponseHeadersPolicyConfig.

", "smithy.api#httpHeader": "If-Match" } } @@ -5756,7 +5800,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, \n\t\t\tperform the following steps.

\n \n\t\t

\n To delete an RTMP distribution using the CloudFront \n\t\t\tAPI:

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

    Disable the RTMP distribution.

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

    Submit a GET Streaming Distribution Config request to get the current \n\t\t\t\t\tconfiguration and the Etag header for the distribution.

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

    Update the XML document that was returned in the response to your GET \n\t\t\t\t\t\tStreaming Distribution Config request to change the value of Enabled \n\t\t\t\t\tto false.

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

    Submit a PUT Streaming Distribution Config request to update the \n\t\t\t\t\tconfiguration for your distribution. In the request body, include the XML document that \n\t\t\t\t\tyou updated in Step 3. Then set the value of the HTTP If-Match header to the \n\t\t\t\t\tvalue of the ETag header that CloudFront returned when you submitted the GET \n\t\t\t\t\t\tStreaming Distribution Config request in Step 2.

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

    Review the response to the PUT Streaming Distribution Config request \n\t\t\t\t\tto confirm that the distribution was successfully disabled.

    \n\t\t\t
    6. \n
  6. \n\t\t\t\t

    Submit a GET Streaming Distribution Config request to confirm that \n\t\t\t\t\tyour changes have propagated. When propagation is complete, the value of \n\t\t\t\t\t\tStatus is Deployed.

    \n\t\t\t
    7. \n
  7. \n\t\t\t\t

    Submit a DELETE Streaming Distribution request. Set the value of the \n\t\t\t\t\tHTTP If-Match header to the value of the ETag header that CloudFront \n\t\t\t\t\treturned when you submitted the GET Streaming Distribution Config request in \n\t\t\t\t\tStep 2.

    \n\t\t\t
    8. \n
  8. \n\t\t\t\t

    Review the response to your DELETE Streaming Distribution request to \n\t\t\t\t\tconfirm that the distribution was successfully deleted.

    \n\t\t\t
    9. \n
\n\t\t

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the \n\t\t\t\tAmazon CloudFront Developer Guide.

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

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API,\n\t\t\tperform the following steps.

\n

\n To delete an RTMP distribution using the CloudFront\n\t\t\tAPI:

\n
    \n
  1. \n

    Disable the RTMP distribution.

    \n
    2. \n
  2. \n

    Submit a GET Streaming Distribution Config request to get the\n\t\t\t\t\tcurrent configuration and the Etag header for the distribution.\n\t\t\t\t

    \n
    3. \n
  3. \n

    Update the XML document that was returned in the response to your GET\n\t\t\t\t\t\tStreaming Distribution Config request to change the value of\n\t\t\t\t\t\tEnabled to false.

    \n
    4. \n
  4. \n

    Submit a PUT Streaming Distribution Config request to update the\n\t\t\t\t\tconfiguration for your distribution. In the request body, include the XML\n\t\t\t\t\tdocument that you updated in Step 3. Then set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Streaming Distribution\n\t\t\t\t\t\tConfig request in Step 2.

    \n
    5. \n
  5. \n

    Review the response to the PUT Streaming Distribution Config\n\t\t\t\t\trequest to confirm that the distribution was successfully disabled.

    \n
    6. \n
  6. \n

    Submit a GET Streaming Distribution Config request to confirm\n\t\t\t\t\tthat your changes have propagated. When propagation is complete, the value of\n\t\t\t\t\t\tStatus is Deployed.

    \n
    7. \n
  7. \n

    Submit a DELETE Streaming Distribution request. Set the value of\n\t\t\t\t\tthe HTTP If-Match header to the value of the ETag\n\t\t\t\t\theader that CloudFront returned when you submitted the GET Streaming\n\t\t\t\t\t\tDistribution Config request in Step 2.

    \n
    8. \n
  8. \n

    Review the response to your DELETE Streaming Distribution request\n\t\t\t\t\tto confirm that the distribution was successfully deleted.

    \n
    9. \n
\n

For information about deleting a distribution using the CloudFront console, see Deleting a\n\t\t\t\tDistribution in the Amazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-05-31/streaming-distribution/{Id}", @@ -5770,7 +5814,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution ID.

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

The distribution ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5778,7 +5822,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when you disabled the \n\t\t\tstreaming distribution. For example: E2QWRUHAPOMQZL.

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

The value of the ETag header that you received when you disabled the\n\t\t\tstreaming distribution. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -5804,7 +5848,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets configuration information and metadata about a CloudFront function, but not the function’s\n\t\t\tcode. To get a function’s code, use GetFunction.

\n\t\t

To get configuration information and metadata about a function, you must provide the\n\t\t\tfunction’s name and stage. To get these values, you can use\n\t\t\tListFunctions.

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

Gets configuration information and metadata about a CloudFront function, but not the\n\t\t\tfunction's code. To get a function's code, use GetFunction.

\n

To get configuration information and metadata about a function, you must provide the\n\t\t\tfunction's name and stage. To get these values, you can use\n\t\t\tListFunctions.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/function/{Name}/describe", @@ -5826,7 +5870,7 @@ "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { - "smithy.api#documentation": "

The function’s stage, either DEVELOPMENT or LIVE.

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

The function's stage, either DEVELOPMENT or LIVE.

", "smithy.api#httpQuery": "Stage" } } @@ -5857,21 +5901,21 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution’s identifier. For example: E1U5RQF7T870K0.

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

The distribution's identifier. For example: E1U5RQF7T870K0.

", "smithy.api#required": {} } }, "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution’s Amazon Resource Name (ARN).

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

The distribution's Amazon Resource Name (ARN).

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution’s status. When the status is Deployed, the distribution’s\n\t\t\tinformation is fully propagated to all CloudFront edge locations.

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

The distribution's status. When the status is Deployed, the\n\t\t\tdistribution's information is fully propagated to all CloudFront edge locations.

", "smithy.api#required": {} } }, @@ -5885,45 +5929,45 @@ "InProgressInvalidationBatches": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of invalidation batches currently in progress.

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

The number of invalidation batches currently in progress.

", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution’s CloudFront domain name. For example: d111111abcdef8.cloudfront.net.

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

The distribution's CloudFront domain name. For example:\n\t\t\td111111abcdef8.cloudfront.net.

", "smithy.api#required": {} } }, "ActiveTrustedSigners": { "target": "com.amazonaws.cloudfront#ActiveTrustedSigners", "traits": { - "smithy.api#documentation": "\n\t\t\t

We recommend using TrustedKeyGroups instead of\n\t\t\t\tTrustedSigners.

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

CloudFront automatically adds this field to the response if you’ve configured a cache behavior in\n\t\t\tthis distribution to serve private content using trusted signers. This field contains a\n\t\t\tlist of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use\n\t\t\tto verify the signatures of signed URLs or signed cookies.

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

We recommend using TrustedKeyGroups instead of\n\t\t\t\t\tTrustedSigners.

\n \n

This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each\n\t\t\taccount that CloudFront can use to verify the signatures of signed URLs or signed\n\t\t\tcookies.

" } }, "ActiveTrustedKeyGroups": { "target": "com.amazonaws.cloudfront#ActiveTrustedKeyGroups", "traits": { - "smithy.api#documentation": "

CloudFront automatically adds this field to the response if you’ve configured a cache\n\t\t\tbehavior in this distribution to serve private content using key groups. This field\n\t\t\tcontains a list of key groups and the public keys in each key group that CloudFront can use to\n\t\t\tverify the signatures of signed URLs or signed cookies.

" + "smithy.api#documentation": "

This field contains a list of key groups and the public keys in each key group that\n\t\t\tCloudFront can use to verify the signatures of signed URLs or signed cookies.

" } }, "DistributionConfig": { "target": "com.amazonaws.cloudfront#DistributionConfig", "traits": { - "smithy.api#documentation": "

The distribution’s configuration.

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

The distribution's configuration.

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

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions.

\n\t\t

For more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

" + "smithy.api#documentation": "

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP)\n\t\t\trecordal if they want to serve content publicly on an alternate domain name, also known\n\t\t\tas a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal\n\t\t\tstatus for CNAMEs associated with distributions.

\n

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services\n\t\t\t\tservices in China.

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

A distribution tells CloudFront where you want content to be delivered from, and the details about how to \n\t\t\ttrack and manage content delivery.

" + "smithy.api#documentation": "

A distribution tells CloudFront where you want content to be delivered from, and the details\n\t\t\tabout how to track and manage content delivery.

" } }, "com.amazonaws.cloudfront#DistributionAlreadyExists": { @@ -5934,7 +5978,7 @@ } }, "traits": { - "smithy.api#documentation": "

The caller reference you attempted to create the distribution with is associated with another distribution.

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

The caller reference you attempted to create the distribution with is associated with\n\t\t\tanother distribution.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -5945,71 +5989,71 @@ "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be \n\t\t\treplayed.

\n\t\t

If the value of CallerReference is new (regardless of the content of the \n\t\t\t\tDistributionConfig object), CloudFront creates a new distribution.

\n\t\t

If CallerReference is a value that you already sent in a previous request to \n\t\t\tcreate a distribution, CloudFront returns a DistributionAlreadyExists error.

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

A unique value (for example, a date-time stamp) that ensures that the request can't be\n\t\t\treplayed.

\n

If the value of CallerReference is new (regardless of the content of the\n\t\t\t\tDistributionConfig object), CloudFront creates a new distribution.

\n

If CallerReference is a value that you already sent in a previous request\n\t\t\tto create a distribution, CloudFront returns a DistributionAlreadyExists\n\t\t\terror.

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

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.

" + "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this distribution.

" } }, "DefaultRootObject": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The object that you want CloudFront to request from your origin (for example,\n\t\t\tindex.html) when a viewer requests the root URL for your distribution\n\t\t\t(https://www.example.com) instead of an object in your distribution\n\t\t\t(https://www.example.com/product-description.html). Specifying a default\n\t\t\troot object avoids exposing the contents of your distribution.

\n\t\t

Specify only the object name, for example, index.html. Don't add a \n\t\t\t\t/ before the object name.

\n\t\t

If you don't want to specify a default root object when you create a distribution, \n\t\t\tinclude an empty DefaultRootObject element.

\n\t\t

To delete the default root object from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty DefaultRootObject \n\t\t\telement.

\n\t\t

To replace the default root object, update the distribution configuration and specify \n\t\t\tthe new object.

\n\t\t

For more information about the default root object, see Creating a Default Root Object in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The object that you want CloudFront to request from your origin (for example,\n\t\t\t\tindex.html) when a viewer requests the root URL for your distribution\n\t\t\t\t(https://www.example.com) instead of an object in your distribution\n\t\t\t\t(https://www.example.com/product-description.html). Specifying a\n\t\t\tdefault root object avoids exposing the contents of your distribution.

\n

Specify only the object name, for example, index.html. Don't add a\n\t\t\t\t/ before the object name.

\n

If you don't want to specify a default root object when you create a distribution,\n\t\t\tinclude an empty DefaultRootObject element.

\n

To delete the default root object from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty DefaultRootObject\n\t\t\telement.

\n

To replace the default root object, update the distribution configuration and specify\n\t\t\tthe new object.

\n

For more information about the default root object, see Creating a\n\t\t\t\tDefault Root Object in the Amazon CloudFront Developer Guide.

" } }, "Origins": { "target": "com.amazonaws.cloudfront#Origins", "traits": { - "smithy.api#documentation": "

A complex type that contains information about origins for this distribution. \n\t\t

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

A complex type that contains information about origins for this distribution.

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

A complex type that contains information about origin groups for this \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A complex type that contains information about origin groups for this\n\t\t\tdistribution.

" } }, "DefaultCacheBehavior": { "target": "com.amazonaws.cloudfront#DefaultCacheBehavior", "traits": { - "smithy.api#documentation": "

A complex type that describes the default cache behavior if you don't specify a \n\t\t\t\tCacheBehavior element or if files don't match any of the values of \n\t\t\t\tPathPattern in CacheBehavior elements. You must create exactly one \n\t\t\tdefault cache behavior.

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

A complex type that describes the default cache behavior if you don't specify a\n\t\t\t\tCacheBehavior element or if files don't match any of the values of\n\t\t\t\tPathPattern in CacheBehavior elements. You must create\n\t\t\texactly one default cache behavior.

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

A complex type that contains zero or more CacheBehavior elements. \n\t\t

" + "smithy.api#documentation": "

A complex type that contains zero or more CacheBehavior elements.

" } }, "CustomErrorResponses": { "target": "com.amazonaws.cloudfront#CustomErrorResponses", "traits": { - "smithy.api#documentation": "

A complex type that controls the following:

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

For more information about custom error pages, see Customizing Error Responses in the \n\t\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A complex type that controls the following:

\n \n

For more information about custom error pages, see Customizing\n\t\t\t\tError Responses in the Amazon CloudFront Developer Guide.

" } }, "Comment": { "target": "com.amazonaws.cloudfront#CommentType", "traits": { - "smithy.api#documentation": "

An optional comment to describe the distribution. The comment cannot be longer than 128\n\t\t\tcharacters.

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

A comment to describe the distribution. The comment cannot be longer than\n\t\t\t128 characters.

", "smithy.api#required": {} } }, "Logging": { "target": "com.amazonaws.cloudfront#LoggingConfig", "traits": { - "smithy.api#documentation": "

A complex type that controls whether access logs are written for the \n\t\t\tdistribution.

\n\t\t

For more information about logging, see Access \n\t\t\t\tLogs in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A complex type that controls whether access logs are written for the\n\t\t\tdistribution.

\n

For more information about logging, see Access Logs in\n\t\t\tthe Amazon CloudFront Developer Guide.

" } }, "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "

The price class that corresponds with the maximum price that you want to pay for CloudFront \n\t\t\tservice. If you specify PriceClass_All, CloudFront responds to requests for your \n\t\t\tobjects from all CloudFront edge locations.

\n\t\t

If you specify a price class other than PriceClass_All, CloudFront serves your \n\t\t\tobjects from the CloudFront edge location that has the lowest latency among the edge locations in \n\t\t\tyour price class. Viewers who are in or near regions that are excluded from your specified \n\t\t\tprice class may encounter slower performance.

\n\t\t

For more information about price classes, see Choosing the Price Class\n\t\t\tfor a CloudFront Distribution in the Amazon CloudFront Developer Guide. For\n\t\t\tinformation about CloudFront pricing, including how price classes (such as Price Class 100)\n\t\t\tmap to CloudFront regions, see Amazon CloudFront\n\t\t\tPricing.

" + "smithy.api#documentation": "

The price class that corresponds with the maximum price that you want to pay for CloudFront\n\t\t\tservice. If you specify PriceClass_All, CloudFront responds to requests for your\n\t\t\tobjects from all CloudFront edge locations.

\n

If you specify a price class other than PriceClass_All, CloudFront serves your\n\t\t\tobjects from the CloudFront edge location that has the lowest latency among the edge locations\n\t\t\tin your price class. Viewers who are in or near regions that are excluded from your\n\t\t\tspecified price class may encounter slower performance.

\n

For more information about price classes, see Choosing the Price\n\t\t\t\tClass for a CloudFront Distribution in the Amazon CloudFront Developer Guide.\n\t\t\tFor information about CloudFront pricing, including how price classes (such as Price Class\n\t\t\t100) map to CloudFront regions, see Amazon CloudFront\n\t\t\t\tPricing.

" } }, "Enabled": { @@ -6022,31 +6066,43 @@ "ViewerCertificate": { "target": "com.amazonaws.cloudfront#ViewerCertificate", "traits": { - "smithy.api#documentation": "

A complex type that determines the distribution’s SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

" + "smithy.api#documentation": "

A complex type that determines the distribution's SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

" } }, "Restrictions": { "target": "com.amazonaws.cloudfront#Restrictions", "traits": { - "smithy.api#documentation": "

A complex type that identifies ways in which you want to restrict distribution of your \n\t\t\tcontent.

" + "smithy.api#documentation": "

A complex type that identifies ways in which you want to restrict distribution of your\n\t\t\tcontent.

" } }, "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A unique identifier that specifies the WAF web ACL, if any, to associate\n\t\t\twith this distribution. To specify a web ACL created using the latest version of\n WAF, use the ACL ARN, for example\n\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.\n\t\t\tTo specify a web ACL created using WAF Classic, use the ACL ID, for example\n\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a.

\n\t\t

WAF is a web application firewall that lets you monitor the HTTP and HTTPS \n\t\t\trequests that are forwarded to CloudFront, and lets you control access to your content. Based on \n\t\t\tconditions that you specify, such as the IP addresses that requests originate from or the \n\t\t\tvalues of query strings, CloudFront responds to requests either with the requested content or with \n\t\t\tan HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page \n\t\t\twhen a request is blocked. For more information about WAF, see the WAF \n\t\t\t\tDeveloper Guide.

" + "smithy.api#documentation": "

A unique identifier that specifies the WAF web ACL, if any, to associate with this\n\t\t\tdistribution. To specify a web ACL created using the latest version of WAF, use the\n\t\t\tACL ARN, for example\n\t\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.\n\t\t\tTo specify a web ACL created using WAF Classic, use the ACL ID, for example\n\t\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a.

\n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n\t\t\tthat are forwarded to CloudFront, and lets you control access to your content. Based on\n\t\t\tconditions that you specify, such as the IP addresses that requests originate from or\n\t\t\tthe values of query strings, CloudFront responds to requests either with the requested content\n\t\t\tor with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a\n\t\t\tcustom error page when a request is blocked. For more information about WAF, see the\n\t\t\t\tWAF Developer Guide.

" } }, "HttpVersion": { "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { - "smithy.api#documentation": "

(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate\n\t\t\twith CloudFront. The default value for new web distributions is http2. Viewers\n\t\t\tthat don't support HTTP/2 automatically use an earlier HTTP version.

\n\t\t

For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must \n\t\t\tsupport Server Name Indication (SNI).

\n\t\t

For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name\n\t\t\tIndication (SNI). CloudFront supports HTTP/3 connection migration to allow the\n\t\t\tviewer to switch networks without losing connection. For more information\n\t\t\tabout connection migration, see Connection Migration at RFC 9000. For more information about\n\t\t\tsupported TLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.

" + "smithy.api#documentation": "

(Optional) Specify the maximum HTTP version(s) that you want viewers to use to\n\t\t\tcommunicate with CloudFront. The default value for new web distributions is\n\t\t\thttp2. Viewers that don't support HTTP/2 automatically use an earlier HTTP\n\t\t\tversion.

\n

For viewers and CloudFront to use HTTP/2, viewers must support TLSv1.2 or later, and must\n\t\t\tsupport Server Name Indication (SNI).

\n

For viewers and CloudFront to use HTTP/3, viewers must support TLSv1.3 and Server Name\n\t\t\tIndication (SNI). CloudFront supports HTTP/3 connection migration to allow the viewer to\n\t\t\tswitch networks without losing connection. For more information about connection\n\t\t\tmigration, see Connection Migration at RFC 9000. For more information about supported\n\t\t\tTLSv1.3 ciphers, see Supported protocols and ciphers between viewers and CloudFront.

" } }, "IsIPV6Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your \n\t\t\tdistribution, specify true. If you specify false, CloudFront responds to \n\t\t\tIPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. \n\t\t\tThis allows viewers to submit a second request, for an IPv4 address for your distribution.

\n\t\t

In general, you should enable IPv6 if you have users on IPv6 networks who want to \n\t\t\taccess your content. However, if you're using signed URLs or signed cookies to restrict access \n\t\t\tto your content, and if you're using a custom policy that includes the IpAddress \n\t\t\tparameter to restrict the IP addresses that can access your content, don't enable IPv6. If \n\t\t\tyou want to restrict access to some content by IP address and not restrict access to other \n\t\t\tcontent (or restrict access but not by IP address), you can create two distributions. For more \n\t\t\tinformation, see \n\t\t\tCreating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

\n\t\t

If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront \n\t\t\tdistribution, you need to create a second alias resource record set when both of the following \n\t\t\tare true:

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

For more information, see Routing Traffic \n\t\t\t\tto an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration \n\t\t\t\tDeveloper Guide.

\n\t\t

If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS \n\t\t\tservice, you don't need to make any changes. A CNAME record will route traffic to your \n\t\t\tdistribution regardless of the IP address format of the viewer request.

" + "smithy.api#documentation": "

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your\n\t\t\tdistribution, specify true. If you specify false, CloudFront\n\t\t\tresponds to IPv6 DNS requests with the DNS response code NOERROR and with\n\t\t\tno IP addresses. This allows viewers to submit a second request, for an IPv4 address for\n\t\t\tyour distribution.

\n

In general, you should enable IPv6 if you have users on IPv6 networks who want to\n\t\t\taccess your content. However, if you're using signed URLs or signed cookies to restrict\n\t\t\taccess to your content, and if you're using a custom policy that includes the\n\t\t\t\tIpAddress parameter to restrict the IP addresses that can access your\n\t\t\tcontent, don't enable IPv6. If you want to restrict access to some content by IP address\n\t\t\tand not restrict access to other content (or restrict access but not by IP address), you\n\t\t\tcan create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront\n\t\t\tdistribution, you need to create a second alias resource record set when both of the\n\t\t\tfollowing are true:

\n \n

For more information, see Routing\n\t\t\t\tTraffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the\n\t\t\t\tRoute 53 Amazon Web Services Integration Developer Guide.

\n

If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS\n\t\t\tservice, you don't need to make any changes. A CNAME record will route traffic to your\n\t\t\tdistribution regardless of the IP address format of the viewer request.

" + } + }, + "ContinuousDeploymentPolicyId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The identifier of a continuous deployment policy. For more information, see\n\t\t\t\tCreateContinuousDeploymentPolicy.

" + } + }, + "Staging": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean that indicates whether this is a staging distribution. When this value is\n\t\t\t\ttrue, this is a staging distribution. When this value is\n\t\t\t\tfalse, this is not a staging distribution.

" } } }, @@ -6073,7 +6129,7 @@ } }, "traits": { - "smithy.api#documentation": "

A distribution Configuration and a list of tags to be associated with the \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A distribution Configuration and a list of tags to be associated with the\n\t\t\tdistribution.

" } }, "com.amazonaws.cloudfront#DistributionIdList": { @@ -6146,7 +6202,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\tdistributions where they left off.

" + "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains\n\t\t\tthe value you can use for the Marker request parameter to continue listing\n\t\t\tyour distributions where they left off.

" } }, "MaxItems": { @@ -6159,7 +6215,7 @@ "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more distributions remain to be listed. If your results \n\t\t\twere truncated, you can make a follow-up pagination request using the Marker \n\t\t\trequest parameter to retrieve more distributions in the list.

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

A flag that indicates whether more distributions remain to be listed. If your results\n\t\t\twere truncated, you can make a follow-up pagination request using the\n\t\t\t\tMarker request parameter to retrieve more distributions in the\n\t\t\tlist.

", "smithy.api#required": {} } }, @@ -6173,7 +6229,7 @@ "Items": { "target": "com.amazonaws.cloudfront#DistributionSummaryList", "traits": { - "smithy.api#documentation": "

A complex type that contains one DistributionSummary element for each \n\t\t\tdistribution that was created by the current Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains one DistributionSummary element for each\n\t\t\tdistribution that was created by the current Amazon Web Services account.

" } } }, @@ -6189,7 +6245,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified CloudFront distribution is not disabled. You must disable \n\t\t\tthe distribution before you can delete it.

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

The specified CloudFront distribution is not disabled. You must disable the distribution\n\t\t\tbefore you can delete it.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -6200,21 +6256,21 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the distribution. For example: \n\t\t\tEDFDVBD632BHDS5.

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

The identifier for the distribution. For example: EDFDVBD632BHDS5.

", "smithy.api#required": {} } }, "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where \n\t\t\t\t123456789012 is your Amazon Web Services account ID.

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

The ARN (Amazon Resource Name) for the distribution. For example:\n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where\n\t\t\t\t123456789012 is your Amazon Web Services account ID.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current status of the distribution. When the status is Deployed, the \n\t\t\tdistribution's information is propagated to all CloudFront edge locations.

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

The current status of the distribution. When the status is Deployed, the\n\t\t\tdistribution's information is propagated to all CloudFront edge locations.

", "smithy.api#required": {} } }, @@ -6228,14 +6284,14 @@ "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

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

The domain name that corresponds to the distribution, for example,\n\t\t\t\td111111abcdef8.cloudfront.net.

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

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this distribution.

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

A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this distribution.

", "smithy.api#required": {} } }, @@ -6249,27 +6305,27 @@ "OriginGroups": { "target": "com.amazonaws.cloudfront#OriginGroups", "traits": { - "smithy.api#documentation": "

A complex type that contains information about origin groups for this \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A complex type that contains information about origin groups for this\n\t\t\tdistribution.

" } }, "DefaultCacheBehavior": { "target": "com.amazonaws.cloudfront#DefaultCacheBehavior", "traits": { - "smithy.api#documentation": "

A complex type that describes the default cache behavior if you don't specify a \n\t\t\t\tCacheBehavior element or if files don't match any of the values of \n\t\t\t\tPathPattern in CacheBehavior elements. You must create exactly one \n\t\t\tdefault cache behavior.

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

A complex type that describes the default cache behavior if you don't specify a\n\t\t\t\tCacheBehavior element or if files don't match any of the values of\n\t\t\t\tPathPattern in CacheBehavior elements. You must create\n\t\t\texactly one default cache behavior.

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

A complex type that contains zero or more CacheBehavior \n\t\t\telements.

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

A complex type that contains zero or more CacheBehavior elements.

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

A complex type that contains zero or more CustomErrorResponses \n\t\t\telements.

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

A complex type that contains zero or more CustomErrorResponses\n\t\t\telements.

", "smithy.api#required": {} } }, @@ -6283,7 +6339,7 @@ "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "

A complex type that contains information about price class for this streaming \n\t\t\tdistribution.

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

A complex type that contains information about price class for this streaming\n\t\t\tdistribution.

", "smithy.api#required": {} } }, @@ -6297,14 +6353,14 @@ "ViewerCertificate": { "target": "com.amazonaws.cloudfront#ViewerCertificate", "traits": { - "smithy.api#documentation": "

A complex type that determines the distribution’s SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

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

A complex type that determines the distribution's SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

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

A complex type that identifies ways in which you want to restrict distribution of your \n\t\t\tcontent.

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

A complex type that identifies ways in which you want to restrict distribution of your\n\t\t\tcontent.

", "smithy.api#required": {} } }, @@ -6318,21 +6374,28 @@ "HttpVersion": { "target": "com.amazonaws.cloudfront#HttpVersion", "traits": { - "smithy.api#documentation": "

Specify the maximum HTTP version that you want viewers to use to communicate with \n\t\t\tCloudFront. The default value for new web distributions is http2. Viewers that don't \n\t\t\tsupport HTTP/2 will automatically use an earlier version.

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

Specify the maximum HTTP version that you want viewers to use to communicate with\n\t\t\tCloudFront. The default value for new web distributions is http2. Viewers that\n\t\t\tdon't support HTTP/2 will automatically use an earlier version.

", "smithy.api#required": {} } }, "IsIPV6Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your \n\t\t\tdistribution.

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

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your\n\t\t\tdistribution.

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

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content \n\t\t\tpublicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP \n\t\t\trecordal status for CNAMEs associated with distributions.

\n\t\t

For more information about ICP recordals, see \n\t\t\tSignup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.

" + "smithy.api#documentation": "

Amazon Web Services services in China customers must file for an Internet Content Provider (ICP)\n\t\t\trecordal if they want to serve content publicly on an alternate domain name, also known\n\t\t\tas a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal\n\t\t\tstatus for CNAMEs associated with distributions.

\n

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services\n\t\t\t\tservices in China.

" + } + }, + "Staging": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

Whether the primary distribution has a staging distribution enabled.

", + "smithy.api#required": {} } } }, @@ -6355,19 +6418,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Number of field pattern items in a field-level encryption content type-profile mapping.

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

Number of field pattern items in a field-level encryption content type-profile\n\t\t\tmapping.

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#EncryptionEntityList", "traits": { - "smithy.api#documentation": "

An array of field patterns in a field-level encryption content type-profile mapping.

" + "smithy.api#documentation": "

An array of field patterns in a field-level encryption content type-profile mapping.\n\t\t

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

Complex data type for field-level encryption profiles that includes all of the encryption entities.

" + "smithy.api#documentation": "

Complex data type for field-level encryption profiles that includes all of the\n\t\t\tencryption entities.

" } }, "com.amazonaws.cloudfront#EncryptionEntity": { @@ -6376,27 +6439,27 @@ "PublicKeyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match\n\t\t\tthe patterns.

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

The public key associated with a set of field-level encryption patterns, to be used\n\t\t\twhen encrypting the fields that match the patterns.

", "smithy.api#required": {} } }, "ProviderId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The provider associated with the public key being used for encryption. This value must also be provided with the private key\n\t\tfor applications to be able to decrypt data.

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

The provider associated with the public key being used for encryption. This value must\n\t\t\talso be provided with the private key for applications to be able to decrypt\n\t\t\tdata.

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

Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the \n\t\t\tfull field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have\n\t\t\tboth ABC* and AB*. Note that field patterns are case-sensitive.

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

Field patterns in a field-level encryption content type profile specify the fields\n\t\t\tthat you want to be encrypted. You can provide the full field name, or any beginning\n\t\t\tcharacters followed by a wildcard (*). You can't overlap field patterns. For example,\n\t\t\tyou can't have both ABC* and AB*. Note that field patterns are case-sensitive.

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

Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.

" + "smithy.api#documentation": "

Complex data type for field-level encryption profiles that includes the encryption key\n\t\t\tand field pattern specifications.

" } }, "com.amazonaws.cloudfront#EncryptionEntityList": { @@ -6414,14 +6477,14 @@ "StreamType": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The type of data stream where you are sending real-time log data. The only valid value is\n\t\t\tKinesis.

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

The type of data stream where you are sending real-time log data. The only valid value\n\t\t\tis Kinesis.

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

Contains information about the Amazon Kinesis data stream where you are sending\n\t\t\treal-time log data.

" + "smithy.api#documentation": "

Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.

" } } }, @@ -6470,27 +6533,27 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain\n\t\tselected data fields to be encrypted by specific public keys.

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

The configuration ID for a field-level encryption configuration which includes a set\n\t\t\tof profiles that specify certain selected data fields to be encrypted by specific public\n\t\t\tkeys.

", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

The last time the field-level encryption configuration was changed.

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

The last time the field-level encryption configuration was changed.

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

A complex data type that includes the profile configurations specified for field-level encryption.

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

A complex data type that includes the profile configurations specified for field-level\n\t\t\tencryption.

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

A complex data type that includes the profile configurations and other options specified for field-level encryption.

" + "smithy.api#documentation": "

A complex data type that includes the profile configurations and other options\n\t\t\tspecified for field-level encryption.

" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionConfig": { @@ -6512,18 +6575,18 @@ "QueryArgProfileConfig": { "target": "com.amazonaws.cloudfront#QueryArgProfileConfig", "traits": { - "smithy.api#documentation": "

A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a \n\t\t\tquery argument in a request.

" + "smithy.api#documentation": "

A complex data type that specifies when to forward content if a profile isn't found\n\t\t\tand the profile that can be provided as a query argument in a request.

" } }, "ContentTypeProfileConfig": { "target": "com.amazonaws.cloudfront#ContentTypeProfileConfig", "traits": { - "smithy.api#documentation": "

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default \n\t\t\tin a request if a query argument doesn't specify a profile to use.

" + "smithy.api#documentation": "

A complex data type that specifies when to forward content if a content type isn't\n\t\t\trecognized and profiles to use as by default in a request if a query argument doesn't\n\t\t\tspecify a profile to use.

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

A complex data type that includes the profile configurations specified for field-level encryption.

" + "smithy.api#documentation": "

A complex data type that includes the profile configurations specified for field-level\n\t\t\tencryption.

" } }, "com.amazonaws.cloudfront#FieldLevelEncryptionConfigAlreadyExists": { @@ -6558,13 +6621,13 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your configurations where you left off.

" + "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains the\n\t\t\tvalue that you can use for the Marker request parameter to continue listing\n\t\t\tyour configurations where you left off.

" } }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The maximum number of elements you want in the response body.

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

The maximum number of elements you want in the response body.

", "smithy.api#required": {} } }, @@ -6592,7 +6655,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain\n\t\t\tselected data fields to be encrypted by specific public keys.

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

The ID for a field-level encryption profile configuration which includes a set of\n\t\t\tprofiles that specify certain selected data fields to be encrypted by specific public\n\t\t\tkeys.

", "smithy.api#required": {} } }, @@ -6606,7 +6669,7 @@ "FieldLevelEncryptionProfileConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", "traits": { - "smithy.api#documentation": "

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

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

A complex data type that includes the profile name and the encryption entities for the\n\t\t\tfield-level encryption profile.

", "smithy.api#required": {} } } @@ -6648,13 +6711,13 @@ "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

An optional comment for the field-level encryption profile. The comment cannot be longer\n\t\t\tthan 128 characters.

" + "smithy.api#documentation": "

An optional comment for the field-level encryption profile. The comment cannot be\n\t\t\tlonger than 128 characters.

" } }, "EncryptionEntities": { "target": "com.amazonaws.cloudfront#EncryptionEntities", "traits": { - "smithy.api#documentation": "

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and\n\t\t\tfield patterns for specifying which fields to encrypt with this key.

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

A complex data type of encryption entities for the field-level encryption profile that\n\t\t\tinclude the public key ID, provider, and field patterns for specifying which fields to\n\t\t\tencrypt with this key.

", "smithy.api#required": {} } } @@ -6682,13 +6745,13 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your profiles where you left off.

" + "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains the\n\t\t\tvalue that you can use for the Marker request parameter to continue listing\n\t\t\tyour profiles where you left off.

" } }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The maximum number of field-level encryption profiles you want in the response body.

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

The maximum number of field-level encryption profiles you want in the response body.\n\t\t

", "smithy.api#required": {} } }, @@ -6750,14 +6813,14 @@ "EncryptionEntities": { "target": "com.amazonaws.cloudfront#EncryptionEntities", "traits": { - "smithy.api#documentation": "

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and\n\t\t\tfield patterns for specifying which fields to encrypt with this key.

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

A complex data type of encryption entities for the field-level encryption profile that\n\t\t\tinclude the public key ID, provider, and field patterns for specifying which fields to\n\t\t\tencrypt with this key.

", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

An optional comment for the field-level encryption profile summary. The comment cannot be\n\t\t\tlonger than 128 characters.

" + "smithy.api#documentation": "

An optional comment for the field-level encryption profile summary. The comment cannot\n\t\t\tbe longer than 128 characters.

" } } }, @@ -6794,19 +6857,19 @@ "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

An optional comment about the field-level encryption item. The comment cannot be longer than\n\t\t\t128 characters.

" + "smithy.api#documentation": "

An optional comment about the field-level encryption item. The comment cannot be\n\t\t\tlonger than 128 characters.

" } }, "QueryArgProfileConfig": { "target": "com.amazonaws.cloudfront#QueryArgProfileConfig", "traits": { - "smithy.api#documentation": "

\n\t\t\tA summary of a query argument-profile mapping.\n\t\t

" + "smithy.api#documentation": "

A summary of a query argument-profile mapping.

" } }, "ContentTypeProfileConfig": { "target": "com.amazonaws.cloudfront#ContentTypeProfileConfig", "traits": { - "smithy.api#documentation": "

\n\t\t\tA summary of a content type-profile mapping.\n\t\t

" + "smithy.api#documentation": "

A summary of a content type-profile mapping.

" } } }, @@ -6859,7 +6922,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex data type that includes the field patterns to match for field-level encryption.

" + "smithy.api#documentation": "

A complex data type that includes the field patterns to match for field-level\n\t\t\tencryption.

" } }, "com.amazonaws.cloudfront#Format": { @@ -6879,32 +6942,32 @@ "QueryString": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send query strings to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

Indicates whether you want CloudFront to forward query strings to the origin that is \n\t\t\tassociated with this cache behavior and cache based on the query string parameters. CloudFront \n\t\t\tbehavior depends on the value of QueryString and on the values that you specify \n\t\t\tfor QueryStringCacheKeys, if any:

\n\t\t

If you specify true for QueryString and you don't specify any values for \n\t\t\t\tQueryStringCacheKeys, CloudFront forwards all query string parameters to the origin \n\t\t\tand caches based on all query string parameters. Depending on how many query string parameters \n\t\t\tand values you have, this can adversely affect performance because CloudFront must forward more \n\t\t\trequests to the origin.

\n\t\t

If you specify true for QueryString and you specify one or more values for \n\t\t\t\tQueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, \n\t\t\tbut it only caches based on the query string parameters that you specify.

\n\t\t

If you specify false for QueryString, CloudFront doesn't forward any query \n\t\t\tstring parameters to the origin, and doesn't cache based on query string parameters.

\n\t\t

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the \n\t\t\t\tAmazon CloudFront Developer Guide.

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

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n

If you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse an origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n

Indicates whether you want CloudFront to forward query strings to the origin that is\n\t\t\tassociated with this cache behavior and cache based on the query string parameters. CloudFront\n\t\t\tbehavior depends on the value of QueryString and on the values that you\n\t\t\tspecify for QueryStringCacheKeys, if any:

\n

If you specify true for QueryString and you don't specify any values for\n\t\t\t\tQueryStringCacheKeys, CloudFront forwards all query string parameters to the\n\t\t\torigin and caches based on all query string parameters. Depending on how many query\n\t\t\tstring parameters and values you have, this can adversely affect performance because\n\t\t\tCloudFront must forward more requests to the origin.

\n

If you specify true for QueryString and you specify one or more values\n\t\t\tfor QueryStringCacheKeys, CloudFront forwards all query string parameters to the\n\t\t\torigin, but it only caches based on the query string parameters that you specify.

\n

If you specify false for QueryString, CloudFront doesn't forward any query\n\t\t\tstring parameters to the origin, and doesn't cache based on query string\n\t\t\tparameters.

\n

For more information, see Configuring\n\t\t\t\tCloudFront to Cache Based on Query String Parameters in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, "Cookies": { "target": "com.amazonaws.cloudfront#CookiePreference", "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include cookies in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send cookies to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that specifies whether you want CloudFront to forward cookies to the origin\n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see\n\t\t\tHow CloudFront Forwards, Caches, and Logs Cookies in the\n\t\t\tAmazon CloudFront Developer Guide.

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

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include cookies in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n

If you want to send cookies to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n

A complex type that specifies whether you want CloudFront to forward cookies to the origin\n\t\t\tand, if so, which ones. For more information about forwarding cookies to the origin, see\n\t\t\t\tHow CloudFront Forwards, Caches,\n\t\t\t\tand Logs Cookies in the Amazon CloudFront Developer Guide.

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

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include headers in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send headers to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that specifies the Headers, if any, that you want CloudFront to forward to the \n\t\t\torigin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches \n\t\t\tseparate versions of a specified object that is based on the header values in viewer requests.

\n\t\t

For more information, see \n\t\t\tCaching Content Based on Request Headers in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include headers in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n

If you want to send headers to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n

A complex type that specifies the Headers, if any, that you want CloudFront to\n\t\t\tforward to the origin for this cache behavior (whitelisted headers). For the headers\n\t\t\tthat you specify, CloudFront also caches separate versions of a specified object that is based\n\t\t\ton the header values in viewer requests.

\n

For more information, see Caching Content\n\t\t\t\tBased on Request Headers in the Amazon CloudFront Developer Guide.

" } }, "QueryStringCacheKeys": { "target": "com.amazonaws.cloudfront#QueryStringCacheKeys", "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send query strings to the origin but not include them in the cache key, use\n\t\t\tan origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that contains information about the query string parameters that you \n\t\t\twant CloudFront to use for caching for this cache behavior.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include query strings in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n

If you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse an origin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n

A complex type that contains information about the query string parameters that you\n\t\t\twant CloudFront to use for caching for this cache behavior.

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

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include values in the cache key, use a cache policy. For more information,\n\t\t\tsee Creating cache policies in the Amazon CloudFront Developer Guide.

\n\t\t

If you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include values in the cache key, use a cache policy. For more\n\t\t\tinformation, see Creating cache policies in the Amazon CloudFront Developer Guide.

\n

If you want to send values to the origin but not include them in the cache key, use an\n\t\t\torigin request policy. For more information, see Creating origin request policies in the\n\t\t\tAmazon CloudFront Developer Guide.

\n

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP\n\t\t\theaders.

" } }, "com.amazonaws.cloudfront#FrameOptionsList": { @@ -6942,7 +7005,7 @@ } }, "traits": { - "smithy.api#documentation": "

A function with the same name already exists in this Amazon Web Services account. To create a\n\t\t\tfunction, you must provide a unique name. To update an existing function, use\n\t\t\tUpdateFunction.

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

A function with the same name already exists in this Amazon Web Services account. To create a\n\t\t\tfunction, you must provide a unique name. To update an existing function, use\n\t\t\t\tUpdateFunction.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -6960,7 +7023,7 @@ "EventType": { "target": "com.amazonaws.cloudfront#EventType", "traits": { - "smithy.api#documentation": "

The event type of the function, either viewer-request or\n\t\t\tviewer-response. You cannot use origin-facing event types\n\t\t\t(origin-request and origin-response) with a CloudFront\n\t\t\tfunction.

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

The event type of the function, either viewer-request or\n\t\t\t\tviewer-response. You cannot use origin-facing event types\n\t\t\t\t(origin-request and origin-response) with a CloudFront\n\t\t\tfunction.

", "smithy.api#required": {} } } @@ -6991,12 +7054,12 @@ "Items": { "target": "com.amazonaws.cloudfront#FunctionAssociationList", "traits": { - "smithy.api#documentation": "

The CloudFront functions that are associated with a cache behavior in a CloudFront distribution. CloudFront\n\t\t\tfunctions must be published to the LIVE stage to associate them with a\n\t\t\tcache behavior.

" + "smithy.api#documentation": "

The CloudFront functions that are associated with a cache behavior in a CloudFront distribution.\n\t\t\tCloudFront functions must be published to the LIVE stage to associate them with a\n\t\t\tcache behavior.

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

A list of CloudFront functions that are associated with a cache behavior in a CloudFront distribution.\n\t\t\tCloudFront functions must be published to the LIVE stage to associate them with a\n\t\t\tcache behavior.

" + "smithy.api#documentation": "

A list of CloudFront functions that are associated with a cache behavior in a CloudFront\n\t\t\tdistribution. CloudFront functions must be published to the LIVE stage to\n\t\t\tassociate them with a cache behavior.

" } }, "com.amazonaws.cloudfront#FunctionBlob": { @@ -7022,7 +7085,7 @@ "Runtime": { "target": "com.amazonaws.cloudfront#FunctionRuntime", "traits": { - "smithy.api#documentation": "

The function’s runtime environment. The only valid value is\n\t\t\tcloudfront-js-1.0.

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

The function's runtime environment. The only valid value is\n\t\t\t\tcloudfront-js-1.0.

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

Cannot delete the function because it’s attached to one or more cache\n\t\t\tbehaviors.

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

Cannot delete the function because it's attached to one or more cache\n\t\t\tbehaviors.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -7110,7 +7173,7 @@ "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { - "smithy.api#documentation": "

The stage that the function is in, either DEVELOPMENT or\n\t\t\tLIVE.

\n\t\t

When a function is in the DEVELOPMENT stage, you can test the function with\n\t\t\t\tTestFunction, and update it with UpdateFunction.

\n\t\t

When a function is in the LIVE stage, you can attach the function to a\n\t\t\tdistribution’s cache behavior, using the function’s ARN.

" + "smithy.api#documentation": "

The stage that the function is in, either DEVELOPMENT or\n\t\t\t\tLIVE.

\n

When a function is in the DEVELOPMENT stage, you can test the function\n\t\t\twith TestFunction, and update it with UpdateFunction.

\n

When a function is in the LIVE stage, you can attach the function to a\n\t\t\tdistribution's cache behavior, using the function's ARN.

" } }, "CreatedTime": { @@ -7160,7 +7223,7 @@ } }, "traits": { - "smithy.api#documentation": "

The function is too large. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

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

The function is too large. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 413 } @@ -7232,26 +7295,26 @@ "RestrictionType": { "target": "com.amazonaws.cloudfront#GeoRestrictionType", "traits": { - "smithy.api#documentation": "

The method that you want to use to restrict distribution of your content by \n\t\t\tcountry:

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

The method that you want to use to restrict distribution of your content by\n\t\t\tcountry:

\n ", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

When geo restriction is enabled, this is the number of countries in your \n\t\t\t\twhitelist or blacklist. Otherwise, when it is not enabled, \n\t\t\t\tQuantity is 0, and you can omit Items.

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

When geo restriction is enabled, this is the number of countries in your\n\t\t\t\twhitelist or blacklist. Otherwise, when it is not enabled,\n\t\t\t\tQuantity is 0, and you can omit Items.

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#LocationList", "traits": { - "smithy.api#documentation": "

A complex type that contains a Location element for each country in which \n\t\t\tyou want CloudFront either to distribute your content (whitelist) or not distribute \n\t\t\tyour content (blacklist).

\n\t\t

The Location element is a two-letter, uppercase country code for a country \n\t\t\tthat you want to include in your blacklist or whitelist. Include one \n\t\t\t\tLocation element for each country.

\n\t\t

CloudFront and MaxMind both use ISO 3166 country codes. For the \n\t\t\tcurrent list of countries and the corresponding codes, see ISO 3166-1-alpha-2 \n\t\t\tcode on the International Organization for Standardization website. You \n\t\t\tcan also refer to the country list on the CloudFront console, which includes both country names and \n\t\t\tcodes.

" + "smithy.api#documentation": "

A complex type that contains a Location element for each country in\n\t\t\twhich you want CloudFront either to distribute your content (whitelist) or not\n\t\t\tdistribute your content (blacklist).

\n

The Location element is a two-letter, uppercase country code for a\n\t\t\tcountry that you want to include in your blacklist or\n\t\t\t\twhitelist. Include one Location element for each\n\t\t\tcountry.

\n

CloudFront and MaxMind both use ISO 3166 country codes. For the\n\t\t\tcurrent list of countries and the corresponding codes, see ISO\n\t\t\t\t3166-1-alpha-2 code on the International Organization for\n\t\t\t\tStandardization website. You can also refer to the country list on the\n\t\t\tCloudFront console, which includes both country names and codes.

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

A complex type that controls the countries in which your content is distributed. CloudFront \n\t\t\tdetermines the location of your users using MaxMind GeoIP databases.

" + "smithy.api#documentation": "

A complex type that controls the countries in which your content is distributed. CloudFront\n\t\t\tdetermines the location of your users using MaxMind GeoIP databases.\n\t\t

" } }, "com.amazonaws.cloudfront#GeoRestrictionType": { @@ -7294,7 +7357,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a cache policy, including the following metadata:

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

To get a cache policy, you must provide the policy’s identifier. If the cache policy is\n\t\t\tattached to a distribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions or GetDistribution. If the cache policy is\n\t\t\tnot attached to a cache behavior, you can get the identifier using\n\t\t\tListCachePolicies.

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

Gets a cache policy, including the following metadata:

\n \n

To get a cache policy, you must provide the policy's identifier. If the cache policy\n\t\t\tis attached to a distribution's cache behavior, you can get the policy's identifier\n\t\t\tusing ListDistributions or GetDistribution. If the cache\n\t\t\tpolicy is not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListCachePolicies.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/cache-policy/{Id}", @@ -7319,7 +7382,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a cache policy configuration.

\n\t\t

To get a cache policy configuration, you must provide the policy’s identifier. If the cache\n\t\t\tpolicy is attached to a distribution’s cache behavior, you can get the policy’s\n\t\t\tidentifier using ListDistributions or GetDistribution. If the\n\t\t\tcache policy is not attached to a cache behavior, you can get the identifier using\n\t\t\tListCachePolicies.

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

Gets a cache policy configuration.

\n

To get a cache policy configuration, you must provide the policy's identifier. If the\n\t\t\tcache policy is attached to a distribution's cache behavior, you can get the policy's\n\t\t\tidentifier using ListDistributions or GetDistribution. If the\n\t\t\tcache policy is not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListCachePolicies.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/cache-policy/{Id}/config", @@ -7333,7 +7396,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier for the cache policy. If the cache policy is attached to a\n\t\t\tdistribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions or GetDistribution. If the cache policy is\n\t\t\tnot attached to a cache behavior, you can get the identifier using\n\t\t\tListCachePolicies.

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

The unique identifier for the cache policy. If the cache policy is attached to a\n\t\t\tdistribution's cache behavior, you can get the policy's identifier using\n\t\t\t\tListDistributions or GetDistribution. If the cache policy\n\t\t\tis not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListCachePolicies.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7365,7 +7428,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier for the cache policy. If the cache policy is attached to a\n\t\t\tdistribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions or GetDistribution. If the cache policy is\n\t\t\tnot attached to a cache behavior, you can get the identifier using\n\t\t\tListCachePolicies.

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

The unique identifier for the cache policy. If the cache policy is attached to a\n\t\t\tdistribution's cache behavior, you can get the policy's identifier using\n\t\t\t\tListDistributions or GetDistribution. If the cache policy\n\t\t\tis not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListCachePolicies.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7408,7 +7471,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the information about an origin access identity.

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

Get the information about an origin access identity.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}", @@ -7433,7 +7496,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the configuration information about an origin access identity.

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

Get the configuration information about an origin access identity.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}/config", @@ -7447,14 +7510,14 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identity's ID.

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

The identity's ID.

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

The origin access identity's configuration information. For more information, see \n\t\t\tCloudFrontOriginAccessIdentityConfig.

" + "smithy.api#documentation": "

The origin access identity's configuration information. For more information, see\n\t\t\t\tCloudFrontOriginAccessIdentityConfig.

" } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigResult": { @@ -7463,14 +7526,14 @@ "CloudFrontOriginAccessIdentityConfig": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", "traits": { - "smithy.api#documentation": "

The origin access identity's configuration information.

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

The origin access identity's configuration information.

", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

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

The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -7508,7 +7571,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the origin access identity's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL.

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

The current version of the origin access identity's information. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -7528,10 +7591,13 @@ "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" } ], "traits": { - "smithy.api#documentation": "

Gets a continuous deployment policy, including metadata (the policy’s identifier and\n\t\t\tthe date and time when the policy was last modified).

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

Gets a continuous deployment policy, including metadata (the policy's identifier and\n\t\t\tthe date and time when the policy was last modified).

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/continuous-deployment-policy/{Id}", @@ -7550,6 +7616,9 @@ "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" } ], "traits": { @@ -7586,7 +7655,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version identifier for the current version of the continuous deployment policy.

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

The version identifier for the current version of the continuous deployment\n\t\t\tpolicy.

", "smithy.api#httpHeader": "ETag" } } @@ -7618,7 +7687,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version identifier for the current version of the continuous deployment policy.

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

The version identifier for the current version of the continuous deployment\n\t\t\tpolicy.

", "smithy.api#httpHeader": "ETag" } } @@ -7684,7 +7753,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the configuration information about a distribution.

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

Get the configuration information about a distribution.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distribution/{Id}/config", @@ -7698,7 +7767,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

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

The distribution's ID. If the ID is empty, an empty distribution configuration is\n\t\t\treturned.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7721,7 +7790,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

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

The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -7736,7 +7805,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

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

The distribution's ID. If the ID is empty, an empty distribution configuration is\n\t\t\treturned.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7759,7 +7828,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the distribution's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL.

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

The current version of the distribution's information. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -7844,7 +7913,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

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

The current version of the field level encryption configuration. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -7926,7 +7995,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.

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

The current version of the field-level encryption profile configuration result. For\n\t\t\texample: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -7958,7 +8027,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

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

The current version of the field level encryption profile. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -7990,7 +8059,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

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

The current version of the field level encryption configuration. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -8013,7 +8082,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the code of a CloudFront function. To get configuration information and metadata about\n\t\t\ta function, use DescribeFunction.

\n\t\t

To get a function’s code, you must provide the function’s name and stage. To get these\n\t\t\tvalues, you can use ListFunctions.

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

Gets the code of a CloudFront function. To get configuration information and metadata about\n\t\t\ta function, use DescribeFunction.

\n

To get a function's code, you must provide the function's name and stage. To get these\n\t\t\tvalues, you can use ListFunctions.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/function/{Name}", @@ -8035,7 +8104,7 @@ "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { - "smithy.api#documentation": "

The function’s stage, either DEVELOPMENT or LIVE.

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

The function's stage, either DEVELOPMENT or LIVE.

", "smithy.api#httpQuery": "Stage" } } @@ -8087,7 +8156,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the information about an invalidation.

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

Get the information about an invalidation.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distribution/{DistributionId}/invalidation/{Id}", @@ -8127,14 +8196,14 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the invalidation request, for example, \n\t\t\tIDFDVBD632BHDS5.

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

The identifier for the invalidation request, for example,\n\t\t\tIDFDVBD632BHDS5.

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

The request to get an invalidation's information.

" + "smithy.api#documentation": "

The request to get an invalidation's information.

" } }, "com.amazonaws.cloudfront#GetInvalidationResult": { @@ -8143,7 +8212,7 @@ "Invalidation": { "target": "com.amazonaws.cloudfront#Invalidation", "traits": { - "smithy.api#documentation": "

The invalidation's information. For more information, see Invalidation Complex Type.

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

The invalidation's information. For more information, see Invalidation\n\t\t\t\tComplex Type.

", "smithy.api#httpPayload": {} } } @@ -8166,7 +8235,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a key group, including the date and time when the key group was last modified.

\n\t\t

To get a key group, you must provide the key group’s identifier. If the key group is\n\t\t\treferenced in a distribution’s cache behavior, you can get the key group’s identifier\n\t\t\tusing ListDistributions or GetDistribution. If the key group\n\t\t\tis not referenced in a cache behavior, you can get the identifier using\n\t\t\tListKeyGroups.

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

Gets a key group, including the date and time when the key group was last\n\t\t\tmodified.

\n

To get a key group, you must provide the key group's identifier. If the key group is\n\t\t\treferenced in a distribution's cache behavior, you can get the key group's identifier\n\t\t\tusing ListDistributions or GetDistribution. If the key group\n\t\t\tis not referenced in a cache behavior, you can get the identifier using\n\t\t\t\tListKeyGroups.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/key-group/{Id}", @@ -8188,7 +8257,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a key group configuration.

\n\t\t

To get a key group configuration, you must provide the key group’s identifier. If the\n\t\t\tkey group is referenced in a distribution’s cache behavior, you can get the key group’s\n\t\t\tidentifier using ListDistributions or GetDistribution. If the\n\t\t\tkey group is not referenced in a cache behavior, you can get the identifier using\n\t\t\tListKeyGroups.

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

Gets a key group configuration.

\n

To get a key group configuration, you must provide the key group's identifier. If the\n\t\t\tkey group is referenced in a distribution's cache behavior, you can get the key group's\n\t\t\tidentifier using ListDistributions or GetDistribution. If the\n\t\t\tkey group is not referenced in a cache behavior, you can get the identifier using\n\t\t\t\tListKeyGroups.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/key-group/{Id}/config", @@ -8234,7 +8303,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier of the key group that you are getting. To get the identifier, use\n\t\t\tListKeyGroups.

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

The identifier of the key group that you are getting. To get the identifier, use\n\t\t\t\tListKeyGroups.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8283,7 +8352,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about whether additional CloudWatch metrics are enabled for the specified\n\t\t\tCloudFront distribution.

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

Gets information about whether additional CloudWatch metrics are enabled for the\n\t\t\tspecified CloudFront distribution.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distributions/{DistributionId}/monitoring-subscription", @@ -8310,7 +8379,7 @@ "MonitoringSubscription": { "target": "com.amazonaws.cloudfront#MonitoringSubscription", "traits": { - "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

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

A monitoring subscription. This structure contains information about whether\n\t\t\tadditional CloudWatch metrics are enabled for a given CloudFront distribution.

", "smithy.api#httpPayload": {} } } @@ -8447,7 +8516,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an origin request policy, including the following metadata:

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

To get an origin request policy, you must provide the policy’s identifier. If the origin\n\t\t\trequest policy is attached to a distribution’s cache behavior, you can get the policy’s\n\t\t\tidentifier using ListDistributions or GetDistribution. If the\n\t\t\torigin request policy is not attached to a cache behavior, you can get the identifier\n\t\t\tusing ListOriginRequestPolicies.

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

Gets an origin request policy, including the following metadata:

\n \n

To get an origin request policy, you must provide the policy's identifier. If the\n\t\t\torigin request policy is attached to a distribution's cache behavior, you can get the\n\t\t\tpolicy's identifier using ListDistributions or\n\t\t\tGetDistribution. If the origin request policy is not attached to a cache\n\t\t\tbehavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-request-policy/{Id}", @@ -8472,7 +8541,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an origin request policy configuration.

\n\t\t

To get an origin request policy configuration, you must provide the policy’s identifier. If\n\t\t\tthe origin request policy is attached to a distribution’s cache behavior, you can get\n\t\t\tthe policy’s identifier using ListDistributions or\n\t\t\tGetDistribution. If the origin request policy is not attached to a cache\n\t\t\tbehavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies.

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

Gets an origin request policy configuration.

\n

To get an origin request policy configuration, you must provide the policy's\n\t\t\tidentifier. If the origin request policy is attached to a distribution's cache behavior,\n\t\t\tyou can get the policy's identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the origin request policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-request-policy/{Id}/config", @@ -8486,7 +8555,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier for the origin request policy. If the origin request policy is\n\t\t\tattached to a distribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions or GetDistribution. If the origin request\n\t\t\tpolicy is not attached to a cache behavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies.

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

The unique identifier for the origin request policy. If the origin request policy is\n\t\t\tattached to a distribution's cache behavior, you can get the policy's identifier using\n\t\t\t\tListDistributions or GetDistribution. If the origin\n\t\t\trequest policy is not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListOriginRequestPolicies.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8518,7 +8587,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier for the origin request policy. If the origin request policy is\n\t\t\tattached to a distribution’s cache behavior, you can get the policy’s identifier using\n\t\t\tListDistributions or GetDistribution. If the origin request\n\t\t\tpolicy is not attached to a cache behavior, you can get the identifier using\n\t\t\tListOriginRequestPolicies.

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

The unique identifier for the origin request policy. If the origin request policy is\n\t\t\tattached to a distribution's cache behavior, you can get the policy's identifier using\n\t\t\t\tListDistributions or GetDistribution. If the origin\n\t\t\trequest policy is not attached to a cache behavior, you can get the identifier using\n\t\t\t\tListOriginRequestPolicies.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8678,7 +8747,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a real-time log configuration.

\n\t\t

To get a real-time log configuration, you can provide the configuration’s name or its Amazon\n\t\t\tResource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the\n\t\t\tname to identify the real-time log configuration to get.

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

Gets a real-time log configuration.

\n

To get a real-time log configuration, you can provide the configuration's name or its\n\t\t\tAmazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront\n\t\t\tuses the name to identify the real-time log configuration to get.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/get-realtime-log-config", @@ -8731,7 +8800,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a response headers policy, including metadata (the policy’s identifier and the date and\n\t\t\ttime when the policy was last modified).

\n\t\t

To get a response headers policy, you must provide the policy’s identifier. If the\n\t\t\tresponse headers policy is attached to a distribution’s cache behavior, you can get the\n\t\t\tpolicy’s identifier using ListDistributions or\n\t\t\tGetDistribution. If the response headers policy is not attached to a cache\n\t\t\tbehavior, you can get the identifier using\n\t\t\tListResponseHeadersPolicies.

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

Gets a response headers policy, including metadata (the policy's identifier and the\n\t\t\tdate and time when the policy was last modified).

\n

To get a response headers policy, you must provide the policy's identifier. If the\n\t\t\tresponse headers policy is attached to a distribution's cache behavior, you can get the\n\t\t\tpolicy's identifier using ListDistributions or\n\t\t\tGetDistribution. If the response headers policy is not attached to a cache\n\t\t\tbehavior, you can get the identifier using\n\t\t\tListResponseHeadersPolicies.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/response-headers-policy/{Id}", @@ -8756,7 +8825,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a response headers policy configuration.

\n\t\t

To get a response headers policy configuration, you must provide the policy’s\n\t\t\tidentifier. If the response headers policy is attached to a distribution’s cache\n\t\t\tbehavior, you can get the policy’s identifier using ListDistributions or\n\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\tListResponseHeadersPolicies.

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

Gets a response headers policy configuration.

\n

To get a response headers policy configuration, you must provide the policy's\n\t\t\tidentifier. If the response headers policy is attached to a distribution's cache\n\t\t\tbehavior, you can get the policy's identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\t\tListResponseHeadersPolicies.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/response-headers-policy/{Id}/config", @@ -8770,7 +8839,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the response headers policy.

\n\t\t

If the response headers policy is attached to a distribution’s cache behavior, you can\n\t\t\tget the policy’s identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\t\tListResponseHeadersPolicies.

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

The identifier for the response headers policy.

\n

If the response headers policy is attached to a distribution's cache behavior, you can\n\t\t\tget the policy's identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\t\tListResponseHeadersPolicies.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8802,7 +8871,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the response headers policy.

\n\t\t

If the response headers policy is attached to a distribution’s cache behavior, you can\n\t\t\tget the policy’s identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\t\tListResponseHeadersPolicies.

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

The identifier for the response headers policy.

\n

If the response headers policy is attached to a distribution's cache behavior, you can\n\t\t\tget the policy's identifier using ListDistributions or\n\t\t\t\tGetDistribution. If the response headers policy is not attached to a\n\t\t\tcache behavior, you can get the identifier using\n\t\t\t\tListResponseHeadersPolicies.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8845,7 +8914,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a specified RTMP distribution, including the distribution configuration.

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

Gets information about a specified RTMP distribution, including the distribution\n\t\t\tconfiguration.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/streaming-distribution/{Id}", @@ -8888,7 +8957,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get the configuration information about a streaming distribution.

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

Get the configuration information about a streaming distribution.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/streaming-distribution/{Id}/config", @@ -8925,7 +8994,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the configuration. For example: E2QWRUHAPOMQZL. \n\t\t

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

The current version of the configuration. For example: E2QWRUHAPOMQZL.\n\t\t

", "smithy.api#httpHeader": "ETag" } } @@ -8963,7 +9032,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the streaming distribution's information. For example: \n\t\t\t\tE2QWRUHAPOMQZL.

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

The current version of the streaming distribution's information. For example:\n\t\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -9075,7 +9144,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified configuration for field-level encryption can't be associated with the specified cache behavior.

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

The specified configuration for field-level encryption can't be associated with the\n\t\t\tspecified cache behavior.

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

An origin cannot contain both an origin access control (OAC) and an origin access identity\n\t\t\t(OAI).

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

An origin cannot contain both an origin access control (OAC) and an origin access\n\t\t\tidentity (OAI).

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

The value of Quantity and the size of Items don't match.

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

The value of Quantity and the size of Items don't\n\t\t\tmatch.

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

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted \n\t\t\tlist of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

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

Your request contains forward cookies option which doesn't match with the expectation\n\t\t\tfor the whitelisted list of cookie names. Either list of cookie names has\n\t\t\tbeen specified when not allowed or list of cookie names is missing when expected.

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

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support \n\t\t\tServer Name Indication (SNI).

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

You cannot specify SSLv3 as the minimum protocol version if you only want to support\n\t\t\tonly clients that support Server Name Indication (SNI).

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

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

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

The relative path is too big, is not URL-encoded, or does not begin with a slash\n\t\t\t(/).

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

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the \n\t\t\tRequiredProtocols element from your distribution configuration.

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

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol\n\t\t\tin your request, or omit the RequiredProtocols element from your\n\t\t\tdistribution configuration.

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

A web ACL ID specified is not valid. To specify a web ACL created using the latest\n\t\t\tversion of WAF, use the ACL ARN, for example\n\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.\n\t\t\tTo specify a web ACL created using WAF Classic, use the ACL ID, for example\n\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a.

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

A web ACL ID specified is not valid. To specify a web ACL created using the latest\n\t\t\tversion of WAF, use the ACL ARN, for example\n\t\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a.\n\t\t\tTo specify a web ACL created using WAF Classic, use the ACL ID, for example\n\t\t\t\t473e64fd-f30b-4765-81a0-62ad96dd167a.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -9463,34 +9532,34 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the invalidation request. For example: \n\t\t\tIDFDVBD632BHDS5.

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

The identifier for the invalidation request. For example:\n\t\t\tIDFDVBD632BHDS5.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The status of the invalidation request. When the invalidation batch is finished, the \n\t\t\tstatus is Completed.

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

The status of the invalidation request. When the invalidation batch is finished, the\n\t\t\tstatus is Completed.

", "smithy.api#required": {} } }, "CreateTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

The date and time the invalidation request was first made.

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

The date and time the invalidation request was first made.

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

The current invalidation information for the batch request.

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

The current invalidation information for the batch request.

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

An invalidation.

" + "smithy.api#documentation": "

An invalidation.

" } }, "com.amazonaws.cloudfront#InvalidationBatch": { @@ -9499,14 +9568,14 @@ "Paths": { "target": "com.amazonaws.cloudfront#Paths", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the objects that you want to invalidate. \n\t\t\tFor more information, see Specifying the Objects \n\t\t\t\tto Invalidate in the Amazon CloudFront Developer Guide.

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

A complex type that contains information about the objects that you want to\n\t\t\tinvalidate. For more information, see Specifying the Objects to Invalidate in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A value that you specify to uniquely identify an invalidation request. CloudFront uses the \n\t\t\tvalue to prevent you from accidentally resubmitting an identical request. Whenever you create \n\t\t\ta new invalidation request, you must specify a new value for CallerReference and \n\t\t\tchange other values in the request as applicable. One way to ensure that the value of \n\t\t\t\tCallerReference is unique is to use a timestamp, for example, \n\t\t\t\t20120301090000.

\n\t\t

If you make a second invalidation request with the same value for \n\t\t\t\tCallerReference, and if the rest of the request is the same, CloudFront doesn't \n\t\t\tcreate a new invalidation request. Instead, CloudFront returns information about the invalidation \n\t\t\trequest that you previously created with the same CallerReference.

\n\t\t

If CallerReference is a value you already sent in a previous invalidation \n\t\t\tbatch request but the content of any Path is different from the original request, \n\t\t\tCloudFront returns an InvalidationBatchAlreadyExists error.

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

A value that you specify to uniquely identify an invalidation request. CloudFront uses the\n\t\t\tvalue to prevent you from accidentally resubmitting an identical request. Whenever you\n\t\t\tcreate a new invalidation request, you must specify a new value for\n\t\t\t\tCallerReference and change other values in the request as applicable.\n\t\t\tOne way to ensure that the value of CallerReference is unique is to use a\n\t\t\t\ttimestamp, for example, 20120301090000.

\n

If you make a second invalidation request with the same value for\n\t\t\t\tCallerReference, and if the rest of the request is the same, CloudFront\n\t\t\tdoesn't create a new invalidation request. Instead, CloudFront returns information about the\n\t\t\tinvalidation request that you previously created with the same\n\t\t\t\tCallerReference.

\n

If CallerReference is a value you already sent in a previous invalidation\n\t\t\tbatch request but the content of any Path is different from the original\n\t\t\trequest, CloudFront returns an InvalidationBatchAlreadyExists error.

", "smithy.api#required": {} } } @@ -9528,7 +9597,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value that you can use for the Marker request parameter to continue listing \n\t\t\tyour invalidation batches where they left off.

" + "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your invalidation batches where they left off.

" } }, "MaxItems": { @@ -9541,26 +9610,26 @@ "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more invalidation batch requests remain to be listed. If \n\t\t\tyour results were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker request parameter to retrieve more invalidation batches in the \n\t\t\tlist.

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

A flag that indicates whether more invalidation batch requests remain to be listed. If\n\t\t\tyour results were truncated, you can make a follow-up pagination request using the\n\t\t\t\tMarker request parameter to retrieve more invalidation batches in the\n\t\t\tlist.

", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of invalidation batches that were created by the current Amazon Web Services account. \n\t\t

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

The number of invalidation batches that were created by the current Amazon Web Services account.\n\t\t

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#InvalidationSummaryList", "traits": { - "smithy.api#documentation": "

A complex type that contains one InvalidationSummary element for each \n\t\t\tinvalidation batch created by the current Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains one InvalidationSummary element for each\n\t\t\tinvalidation batch created by the current Amazon Web Services account.

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

The InvalidationList complex type describes the list of invalidation \n\t\t\tobjects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in \n\t\t\tthe Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The InvalidationList complex type describes the list of invalidation\n\t\t\tobjects. For more information about invalidation, see Invalidating Objects\n\t\t\t\t(Web Distributions Only) in the Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#InvalidationSummary": { @@ -9638,7 +9707,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of identifiers for the public keys that CloudFront can use to verify the\n\t\t\tsignatures of signed URLs and signed cookies.

" + "smithy.api#documentation": "

A list of identifiers for the public keys that CloudFront can use to verify the signatures\n\t\t\tof signed URLs and signed cookies.

" } }, "com.amazonaws.cloudfront#KGKeyPairIdsList": { @@ -9676,7 +9745,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key group.

\n\t\t

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

" + "smithy.api#documentation": "

A key group.

\n

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

" } }, "com.amazonaws.cloudfront#KeyGroupAlreadyExists": { @@ -9687,7 +9756,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key group with this name already exists. You must provide a unique name. To modify an\n\t\t\texisting key group, use UpdateKeyGroup.

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

A key group with this name already exists. You must provide a unique name. To modify\n\t\t\tan existing key group, use UpdateKeyGroup.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -9717,7 +9786,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key group configuration.

\n\t\t

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

" + "smithy.api#documentation": "

A key group configuration.

\n

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

" } }, "com.amazonaws.cloudfront#KeyGroupList": { @@ -9726,7 +9795,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value that you should use in the Marker field of a subsequent\n\t\t\trequest to continue listing key groups.

" + "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing key groups.

" } }, "MaxItems": { @@ -9814,20 +9883,20 @@ "RoleARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n\t\t\tCloudFront can use to send real-time log data to your Kinesis data stream.

\n\t\t

For more information the IAM role, see Real-time log configuration IAM role in the\n\t\t\tAmazon CloudFront Developer Guide.

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

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to\n\t\t\tsend real-time log data to your Kinesis data stream.

\n

For more information the IAM role, see Real-time log configuration IAM role in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time\n\t\t\tlog data.

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

The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending\n\t\t\treal-time log data.

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

Contains information about the Amazon Kinesis data stream where you are sending\n\t\t\treal-time log data.

" + "smithy.api#documentation": "

Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.

" } }, "com.amazonaws.cloudfront#LambdaFunctionARN": { @@ -9839,21 +9908,21 @@ "LambdaFunctionARN": { "target": "com.amazonaws.cloudfront#LambdaFunctionARN", "traits": { - "smithy.api#documentation": "

The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias \n\t\t\tor $LATEST.

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

The ARN of the Lambda@Edge function. You must specify the ARN of a function version;\n\t\t\tyou can't specify an alias or $LATEST.

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

Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:

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

Specifies the event type that triggers a Lambda@Edge function invocation. You can\n\t\t\tspecify the following values:

\n ", "smithy.api#required": {} } }, "IncludeBody": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that allows a Lambda@Edge function to have read access to the body content. For more information, \n\t\t\tsee Accessing the Request Body by Choosing the \n\t\t\t\tInclude Body Option in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A flag that allows a Lambda@Edge function to have read access to the body content. For\n\t\t\tmore information, see Accessing the Request Body by Choosing the Include Body Option in the\n\t\t\tAmazon CloudFront Developer Guide.

" } } }, @@ -9883,12 +9952,12 @@ "Items": { "target": "com.amazonaws.cloudfront#LambdaFunctionAssociationList", "traits": { - "smithy.api#documentation": "

\n Optional: A complex type that contains LambdaFunctionAssociation items \n\t\t\tfor this cache behavior. If Quantity is 0, you can omit Items.

" + "smithy.api#documentation": "

\n Optional: A complex type that contains\n\t\t\t\tLambdaFunctionAssociation items for this cache behavior. If\n\t\t\t\tQuantity is 0, you can omit Items.

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

A complex type that specifies a list of Lambda@Edge functions associations for a cache \n\t\t\tbehavior.

\n \n\t\t

If you want to invoke one or more Lambda@Edge functions triggered by requests that match the \n\t\t\t\tPathPattern of the cache behavior, specify the applicable values for \n\t\t\t\tQuantity and Items. Note that there can be up to 4 \n\t\t\t\tLambdaFunctionAssociation items in this list (one for each possible value of \n\t\t\t\tEventType) and each EventType can be associated with only one function.

\n \n\t\t

If you don't want to invoke any Lambda@Edge functions for the requests that match \n\t\t\t\tPathPattern, specify 0 for Quantity and omit \n\t\t\t\tItems.

" + "smithy.api#documentation": "

A complex type that specifies a list of Lambda@Edge functions associations for a cache\n\t\t\tbehavior.

\n

If you want to invoke one or more Lambda@Edge functions triggered by requests that\n\t\t\tmatch the PathPattern of the cache behavior, specify the applicable values\n\t\t\tfor Quantity and Items. Note that there can be up to 4\n\t\t\t\tLambdaFunctionAssociation items in this list (one for each possible\n\t\t\tvalue of EventType) and each EventType can be associated with\n\t\t\tonly one function.

\n

If you don't want to invoke any Lambda@Edge functions for the requests that match\n\t\t\t\tPathPattern, specify 0 for Quantity and omit\n\t\t\t\tItems.

" } }, "com.amazonaws.cloudfront#ListCachePolicies": { @@ -9911,7 +9980,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of cache policies.

\n\t\t

You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or\n\t\t\tonly the custom policies created in your Amazon Web Services account.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of cache policies.

\n

You can optionally apply a filter to return only the managed policies created by\n\t\t\tAmazon Web Services, or only the custom policies created in your Amazon Web Services account.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/cache-policy", @@ -9925,14 +9994,14 @@ "Type": { "target": "com.amazonaws.cloudfront#CachePolicyType", "traits": { - "smithy.api#documentation": "

A filter to return only the specified kinds of cache policies. Valid values\n\t\t\tare:

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

A filter to return only the specified kinds of cache policies. Valid values\n\t\t\tare:

\n ", "smithy.api#httpQuery": "Type" } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcache policies. The response includes cache policies in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcache policies. The response includes cache policies in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -9991,20 +10060,20 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of origin \n\t\t\taccess identities. The results include identities in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tidentity on that page).

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

Use this when paginating results to indicate where to begin in your list of origin\n\t\t\taccess identities. The results include identities in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last identity on that page).

", "smithy.api#httpQuery": "Marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of origin access identities you want in the response body. \n\t\t

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

The maximum number of origin access identities you want in the response body.

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

The request to list origin access identities.

" + "smithy.api#documentation": "

The request to list origin access identities.

" } }, "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesResult": { @@ -10013,13 +10082,13 @@ "CloudFrontOriginAccessIdentityList": { "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityList", "traits": { - "smithy.api#documentation": "

The CloudFrontOriginAccessIdentityList type.

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

The CloudFrontOriginAccessIdentityList type.

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

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, "com.amazonaws.cloudfront#ListConflictingAliases": { @@ -10039,7 +10108,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or\n\t\t\toverlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services\n\t\t\taccounts for each conflicting alias. In the returned list, the distribution and account\n\t\t\tIDs are partially hidden, which allows you to identify the distributions and accounts\n\t\t\tthat you own, but helps to protect the information of ones that you don’t own.

\n\t\t

Use this operation to find aliases that are in use in CloudFront that conflict or overlap\n\t\t\twith the provided alias. For example, if you provide www.example.com as\n\t\t\tinput, the returned list can include www.example.com and the overlapping\n\t\t\twildcard alternate domain name (*.example.com), if they exist. If you\n\t\t\tprovide *.example.com as input, the returned list can include\n\t\t\t*.example.com and any alternate domain names covered by that wildcard (for\n\t\t\texample, www.example.com, test.example.com,\n\t\t\tdev.example.com, and so on), if they exist.

\n\t\t

To list conflicting aliases, you provide the alias to search and the ID of a distribution in\n\t\t\tyour account that has an attached SSL/TLS certificate that includes the provided alias.\n\t\t\tFor more information, including how to set up the distribution and certificate, see\n\t\t\tMoving an alternate domain name to a different distribution\n\t\t\tin the Amazon CloudFront Developer Guide.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or\n\t\t\toverlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services\n\t\t\taccounts for each conflicting alias. In the returned list, the distribution and account\n\t\t\tIDs are partially hidden, which allows you to identify the distributions and accounts\n\t\t\tthat you own, but helps to protect the information of ones that you don't own.

\n

Use this operation to find aliases that are in use in CloudFront that conflict or overlap\n\t\t\twith the provided alias. For example, if you provide www.example.com as\n\t\t\tinput, the returned list can include www.example.com and the overlapping\n\t\t\twildcard alternate domain name (*.example.com), if they exist. If you\n\t\t\tprovide *.example.com as input, the returned list can include\n\t\t\t\t*.example.com and any alternate domain names covered by that wildcard\n\t\t\t(for example, www.example.com, test.example.com,\n\t\t\t\tdev.example.com, and so on), if they exist.

\n

To list conflicting aliases, you provide the alias to search and the ID of a\n\t\t\tdistribution in your account that has an attached SSL/TLS certificate that includes the\n\t\t\tprovided alias. For more information, including how to set up the distribution and\n\t\t\tcertificate, see Moving an alternate domain name to a different\n\t\t\t\tdistribution in the Amazon CloudFront Developer Guide.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/conflicting-alias", @@ -10069,7 +10138,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in the list of\n\t\t\tconflicting aliases. The response includes conflicting aliases in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field’s value to the value\n\t\t\tof NextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in the list of\n\t\t\tconflicting aliases. The response includes conflicting aliases in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10108,10 +10177,13 @@ }, { "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" } ], "traits": { - "smithy.api#documentation": "

Gets a list of the continuous deployment policies in your Amazon Web Services account.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of the continuous deployment policies in your Amazon Web Services account.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/continuous-deployment-policy", @@ -10125,7 +10197,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcontinuous deployment policies. The response includes policies in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field’s value to the value\n\t\t\tof NextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcontinuous deployment policies. The response includes policies in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10198,7 +10270,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of distribution IDs for distributions that have a cache behavior that’s\n\t\t\tassociated with the specified cache policy.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of distribution IDs for distributions that have a cache behavior that's\n\t\t\tassociated with the specified cache policy.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distributionsByCachePolicyId/{CachePolicyId}", @@ -10212,7 +10284,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10262,7 +10334,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of distribution IDs for distributions that have a cache behavior that references\n\t\t\tthe specified key group.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of distribution IDs for distributions that have a cache behavior that\n\t\t\treferences the specified key group.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distributionsByKeyGroupId/{KeyGroupId}", @@ -10276,7 +10348,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10328,7 +10400,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of distribution IDs for distributions that have a cache behavior that’s\n\t\t\tassociated with the specified origin request policy.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of distribution IDs for distributions that have a cache behavior that's\n\t\t\tassociated with the specified origin request policy.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distributionsByOriginRequestPolicyId/{OriginRequestPolicyId}", @@ -10342,7 +10414,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10389,7 +10461,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of distributions that have a cache behavior that’s associated with the specified\n\t\t\treal-time log configuration.

\n\t\t

You can specify the real-time log configuration by its name or its Amazon Resource Name\n\t\t\t(ARN). You must provide at least one. If you provide both, CloudFront uses the name to\n\t\t\tidentify the real-time log configuration to list distributions for.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of distributions that have a cache behavior that's associated with the\n\t\t\tspecified real-time log configuration.

\n

You can specify the real-time log configuration by its name or its Amazon Resource\n\t\t\tName (ARN). You must provide at least one. If you provide both, CloudFront uses the name to\n\t\t\tidentify the real-time log configuration to list distributions for.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distributionsByRealtimeLogConfig", @@ -10403,7 +10475,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The response includes distributions in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

" + "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The response includes distributions in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

" } }, "MaxItems": { @@ -10457,7 +10529,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of distribution IDs for distributions that have a cache behavior that’s\n\t\t\tassociated with the specified response headers policy.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of distribution IDs for distributions that have a cache behavior that's\n\t\t\tassociated with the specified response headers policy.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distributionsByResponseHeadersPolicyId/{ResponseHeadersPolicyId}", @@ -10471,7 +10543,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field’s value to the value of\n\t\t\t\tNextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tdistribution IDs. The response includes distribution IDs in the list that occur after\n\t\t\tthe marker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10534,28 +10606,28 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use Marker and MaxItems to control pagination of results. If \n\t\t\tyou have more than MaxItems distributions that satisfy the request, the response \n\t\t\tincludes a NextMarker element. To get the next page of results, submit another \n\t\t\trequest. For the value of Marker, specify the value of NextMarker \n\t\t\tfrom the last response. (For the first request, omit Marker.)

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

Use Marker and MaxItems to control pagination of results. If\n\t\t\tyou have more than MaxItems distributions that satisfy the request, the\n\t\t\tresponse includes a NextMarker element. To get the next page of results,\n\t\t\tsubmit another request. For the value of Marker, specify the value of\n\t\t\t\tNextMarker from the last response. (For the first request, omit\n\t\t\t\tMarker.)

", "smithy.api#httpQuery": "Marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of distributions that you want CloudFront to return in the response body. \n\t\t\tThe maximum and default values are both 100.

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

The maximum number of distributions that you want CloudFront to return in the response body.\n\t\t\tThe maximum and default values are both 100.

", "smithy.api#httpQuery": "MaxItems" } }, "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ID of the WAF web ACL that you want to list the associated distributions. \n\t\t\tIf you specify \"null\" for the ID, the request returns a list of the distributions that aren't \n\t\t\tassociated with a web ACL.

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

The ID of the WAF web ACL that you want to list the associated distributions. If you\n\t\t\tspecify \"null\" for the ID, the request returns a list of the distributions that aren't\n\t\t\tassociated with a web ACL.

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

The request to list distributions that are associated with a specified WAF web \n\t\t\tACL.

" + "smithy.api#documentation": "

The request to list distributions that are associated with a specified WAF web\n\t\t\tACL.

" } }, "com.amazonaws.cloudfront#ListDistributionsByWebACLIdResult": { @@ -10564,13 +10636,13 @@ "DistributionList": { "target": "com.amazonaws.cloudfront#DistributionList", "traits": { - "smithy.api#documentation": "

The DistributionList type.

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

The DistributionList type.

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

The response to a request to list the distributions that are associated with a \n\t\t\tspecified WAF web ACL.

" + "smithy.api#documentation": "

The response to a request to list the distributions that are associated with a\n\t\t\tspecified WAF web ACL.

" } }, "com.amazonaws.cloudfront#ListDistributionsRequest": { @@ -10579,7 +10651,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of \n\t\t\tdistributions. The results include distributions in the list that occur after the marker. To \n\t\t\tget the next page of results, set the Marker to the value of the \n\t\t\t\tNextMarker from the current page's response (which is also the ID of the last \n\t\t\tdistribution on that page).

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

Use this when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The results include distributions in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last distribution on that page).

", "smithy.api#httpQuery": "Marker" } }, @@ -10592,7 +10664,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request to list your distributions.

" + "smithy.api#documentation": "

The request to list your distributions.

" } }, "com.amazonaws.cloudfront#ListDistributionsResult": { @@ -10601,13 +10673,13 @@ "DistributionList": { "target": "com.amazonaws.cloudfront#DistributionList", "traits": { - "smithy.api#documentation": "

The DistributionList type.

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

The DistributionList type.

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

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigs": { @@ -10624,7 +10696,7 @@ } ], "traits": { - "smithy.api#documentation": "

List all field-level encryption configurations that have been created in CloudFront for this account.

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

List all field-level encryption configurations that have been created in CloudFront for this\n\t\t\taccount.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption", @@ -10638,14 +10710,14 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker to the value of the \n\t\t\tNextMarker from the current page's response (which is also the ID of the last configuration on that page).

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

Use this when paginating results to indicate where to begin in your list of\n\t\t\tconfigurations. The results include configurations in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last configuration on that page).

", "smithy.api#httpQuery": "Marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of field-level encryption configurations you want in the response body.

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

The maximum number of field-level encryption configurations you want in the response\n\t\t\tbody.

", "smithy.api#httpQuery": "MaxItems" } } @@ -10657,7 +10729,7 @@ "FieldLevelEncryptionList": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionList", "traits": { - "smithy.api#documentation": "

Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

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

Returns a list of all field-level encryption configurations that have been created in\n\t\t\tCloudFront for this account.

", "smithy.api#httpPayload": {} } } @@ -10677,7 +10749,7 @@ } ], "traits": { - "smithy.api#documentation": "

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

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

Request a list of field-level encryption profiles that have been created in CloudFront for\n\t\t\tthis account.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/field-level-encryption-profile", @@ -10691,14 +10763,14 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker to the value of the \n\t\t\tNextMarker from the current page's response (which is also the ID of the last profile on that page).

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

Use this when paginating results to indicate where to begin in your list of profiles.\n\t\t\tThe results include profiles in the list that occur after the marker. To get the next\n\t\t\tpage of results, set the Marker to the value of the NextMarker\n\t\t\tfrom the current page's response (which is also the ID of the last profile on that\n\t\t\tpage).

", "smithy.api#httpQuery": "Marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of field-level encryption profiles you want in the response body.

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

The maximum number of field-level encryption profiles you want in the response body.\n\t\t

", "smithy.api#httpQuery": "MaxItems" } } @@ -10710,7 +10782,7 @@ "FieldLevelEncryptionProfileList": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileList", "traits": { - "smithy.api#documentation": "

Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.

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

Returns a list of the field-level encryption profiles that have been created in CloudFront\n\t\t\tfor this account.

", "smithy.api#httpPayload": {} } } @@ -10733,7 +10805,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all CloudFront functions in your Amazon Web Services account.

\n\t\t

You can optionally apply a filter to return only the functions that are in the\n\t\t\tspecified stage, either DEVELOPMENT or LIVE.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of all CloudFront functions in your Amazon Web Services account.

\n

You can optionally apply a filter to return only the functions that are in the\n\t\t\tspecified stage, either DEVELOPMENT or LIVE.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/function", @@ -10747,7 +10819,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tfunctions. The response includes functions in the list that occur after the marker. To\n\t\t\tget the next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tfunctions. The response includes functions in the list that occur after the marker. To\n\t\t\tget the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10799,7 +10871,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists invalidation batches.

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

Lists invalidation batches.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/distribution/{DistributionId}/invalidation", @@ -10827,20 +10899,20 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this parameter when paginating results to indicate where to begin in your list of \n\t\t\tinvalidation batches. Because the results are returned in decreasing order from most recent to \n\t\t\toldest, the most recent results are on the first page, the second page will contain earlier \n\t\t\tresults, and so on. To get the next page of results, set Marker to the value of \n\t\t\tthe NextMarker from the current page's response. This value is the same as the ID \n\t\t\tof the last invalidation batch on that page.

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

Use this parameter when paginating results to indicate where to begin in your list of\n\t\t\tinvalidation batches. Because the results are returned in decreasing order from most\n\t\t\trecent to oldest, the most recent results are on the first page, the second page will\n\t\t\tcontain earlier results, and so on. To get the next page of results, set\n\t\t\t\tMarker to the value of the NextMarker from the current\n\t\t\tpage's response. This value is the same as the ID of the last invalidation batch on that\n\t\t\tpage.

", "smithy.api#httpQuery": "Marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of invalidation batches that you want in the response \n\t\t\tbody.

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

The maximum number of invalidation batches that you want in the response body.

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

The request to list invalidations.

" + "smithy.api#documentation": "

The request to list invalidations.

" } }, "com.amazonaws.cloudfront#ListInvalidationsResult": { @@ -10849,13 +10921,13 @@ "InvalidationList": { "target": "com.amazonaws.cloudfront#InvalidationList", "traits": { - "smithy.api#documentation": "

Information about invalidation batches.

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

Information about invalidation batches.

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

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, "com.amazonaws.cloudfront#ListKeyGroups": { @@ -10872,7 +10944,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of key groups.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of key groups.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/key-group", @@ -10886,7 +10958,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of key\n\t\t\tgroups. The response includes key groups in the list that occur after the marker. To get\n\t\t\tthe next page of the list, set this field’s value to the value of\n\t\t\tNextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of key\n\t\t\tgroups. The response includes key groups in the list that occur after the marker. To get\n\t\t\tthe next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10925,7 +10997,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the list of CloudFront origin access controls in this Amazon Web Services account.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If the\n\t\t\ttotal number of items in the list exceeds the maximum that you specify, or the default\n\t\t\tmaximum, the response is paginated. To get the next page of items, send another request\n\t\t\tthat specifies the NextMarker value from the current response as the\n\t\t\tMarker value in the next request.

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

Gets the list of CloudFront origin access controls in this Amazon Web Services account.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send another\n\t\t\trequest that specifies the NextMarker value from the current response as\n\t\t\tthe Marker value in the next request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-access-control", @@ -10939,7 +11011,7 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of origin\n\t\t\taccess controls. The response includes the items in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field's value to the value of\n\t\t\tNextMarker from the current page's response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\torigin access controls. The response includes the items in the list that occur after the\n\t\t\tmarker. To get the next page of the list, set this field's value to the value of\n\t\t\t\tNextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -10984,7 +11056,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of origin request policies.

\n\t\t

You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or\n\t\t\tonly the custom policies created in your Amazon Web Services account.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of origin request policies.

\n

You can optionally apply a filter to return only the managed policies created by\n\t\t\tAmazon Web Services, or only the custom policies created in your Amazon Web Services account.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/origin-request-policy", @@ -10998,14 +11070,14 @@ "Type": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyType", "traits": { - "smithy.api#documentation": "

A filter to return only the specified kinds of origin request policies. Valid values\n\t\t\tare:

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

A filter to return only the specified kinds of origin request policies. Valid values\n\t\t\tare:

\n ", "smithy.api#httpQuery": "Type" } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of\n\t\t\torigin request policies. The response includes origin request policies in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field’s value to the\n\t\t\tvalue of NextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\torigin request policies. The response includes origin request policies in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field's value to the\n\t\t\tvalue of NextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, @@ -11058,14 +11130,14 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that \n\t\t\toccur after the marker. To get the next page of results, set the Marker to the value of the \n\t\t\tNextMarker from the current page's response (which is also the ID of the last public key on that page).

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

Use this when paginating results to indicate where to begin in your list of public\n\t\t\tkeys. The results include public keys in the list that occur after the marker. To get\n\t\t\tthe next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last public key on that page).

", "smithy.api#httpQuery": "Marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of public keys you want in the response body.

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

The maximum number of public keys you want in the response body.

", "smithy.api#httpQuery": "MaxItems" } } @@ -11077,7 +11149,7 @@ "PublicKeyList": { "target": "com.amazonaws.cloudfront#PublicKeyList", "traits": { - "smithy.api#documentation": "

Returns a list of all public keys that have been added to CloudFront for this account.

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

Returns a list of all public keys that have been added to CloudFront for this\n\t\t\taccount.

", "smithy.api#httpPayload": {} } } @@ -11103,7 +11175,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of real-time log configurations.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of real-time log configurations.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/realtime-log-config", @@ -11117,14 +11189,14 @@ "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of real-time log configurations that you want in the response.

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

The maximum number of real-time log configurations that you want in the\n\t\t\tresponse.

", "smithy.api#httpQuery": "MaxItems" } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of real-time\n\t\t\tlog configurations. The response includes real-time log configurations in the list that\n\t\t\toccur after the marker. To get the next page of the list, set this field’s value to the\n\t\t\tvalue of NextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\treal-time log configurations. The response includes real-time log configurations in the\n\t\t\tlist that occur after the marker. To get the next page of the list, set this field's\n\t\t\tvalue to the value of NextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } } @@ -11162,7 +11234,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of response headers policies.

\n\t\t

You can optionally apply a filter to get only the managed policies created by Amazon Web Services,\n\t\t\tor only the custom policies created in your Amazon Web Services account.

\n\t\t

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

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

Gets a list of response headers policies.

\n

You can optionally apply a filter to get only the managed policies created by Amazon Web Services,\n\t\t\tor only the custom policies created in your Amazon Web Services account.

\n

You can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/response-headers-policy", @@ -11176,21 +11248,21 @@ "Type": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyType", "traits": { - "smithy.api#documentation": "

A filter to get only the specified kind of response headers policies. Valid values\n\t\t\tare:

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

A filter to get only the specified kind of response headers policies. Valid values\n\t\t\tare:

\n ", "smithy.api#httpQuery": "Type" } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Use this field when paginating results to indicate where to begin in your list of response\n\t\t\theaders policies. The response includes response headers policies in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field’s value to the value\n\t\t\tof NextMarker from the current page’s response.

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

Use this field when paginating results to indicate where to begin in your list of\n\t\t\tresponse headers policies. The response includes response headers policies in the list\n\t\t\tthat occur after the marker. To get the next page of the list, set this field's value to\n\t\t\tthe value of NextMarker from the current page's response.

", "smithy.api#httpQuery": "Marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of response headers policies that you want to get in the response.

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

The maximum number of response headers policies that you want to get in the\n\t\t\tresponse.

", "smithy.api#httpQuery": "MaxItems" } } @@ -11222,7 +11294,7 @@ } ], "traits": { - "smithy.api#documentation": "

List streaming distributions.

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

List streaming distributions.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/streaming-distribution", @@ -11255,7 +11327,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request to list your streaming distributions.

" + "smithy.api#documentation": "

The request to list your streaming distributions.

" } }, "com.amazonaws.cloudfront#ListStreamingDistributionsResult": { @@ -11264,13 +11336,13 @@ "StreamingDistributionList": { "target": "com.amazonaws.cloudfront#StreamingDistributionList", "traits": { - "smithy.api#documentation": "

The StreamingDistributionList type.

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

The StreamingDistributionList type.

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

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, "com.amazonaws.cloudfront#ListTagsForResource": { @@ -11310,14 +11382,14 @@ "Resource": { "target": "com.amazonaws.cloudfront#ResourceARN", "traits": { - "smithy.api#documentation": "

An ARN of a CloudFront resource.

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

An ARN of a CloudFront resource.

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

The request to list tags for a CloudFront resource.

" + "smithy.api#documentation": "

The request to list tags for a CloudFront resource.

" } }, "com.amazonaws.cloudfront#ListTagsForResourceResult": { @@ -11326,14 +11398,14 @@ "Tags": { "target": "com.amazonaws.cloudfront#Tags", "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more Tag elements.

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

A complex type that contains zero or more Tag elements.

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

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, "com.amazonaws.cloudfront#LocationList": { @@ -11351,34 +11423,34 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't \n\t\t\twant to enable logging when you create a distribution or if you want to disable logging for an \n\t\t\texisting distribution, specify false for Enabled, and specify empty \n\t\t\t\tBucket and Prefix elements. If you specify false for \n\t\t\t\tEnabled but you specify values for Bucket, prefix, \n\t\t\tand IncludeCookies, the values are automatically deleted.

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

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't\n\t\t\twant to enable logging when you create a distribution or if you want to disable logging\n\t\t\tfor an existing distribution, specify false for Enabled, and\n\t\t\tspecify empty Bucket and Prefix elements. If you specify\n\t\t\t\tfalse for Enabled but you specify values for\n\t\t\t\tBucket, prefix, and IncludeCookies, the\n\t\t\tvalues are automatically deleted.

", "smithy.api#required": {} } }, "IncludeCookies": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Specifies whether you want CloudFront to include cookies in access logs, specify \n\t\t\t\ttrue for IncludeCookies. If you choose to include cookies in logs, \n\t\t\tCloudFront logs all cookies regardless of how you configure the cache behaviors for this \n\t\t\tdistribution. If you don't want to include cookies when you create a distribution or if you \n\t\t\twant to disable include cookies for an existing distribution, specify false for \n\t\t\t\tIncludeCookies.

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

Specifies whether you want CloudFront to include cookies in access logs, specify\n\t\t\t\ttrue for IncludeCookies. If you choose to include cookies\n\t\t\tin logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for\n\t\t\tthis distribution. If you don't want to include cookies when you create a distribution\n\t\t\tor if you want to disable include cookies for an existing distribution, specify\n\t\t\t\tfalse for IncludeCookies.

", "smithy.api#required": {} } }, "Bucket": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket to store the access logs in, for example, \n\t\t\t\tmyawslogbucket.s3.amazonaws.com.

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

The Amazon S3 bucket to store the access logs in, for example,\n\t\t\t\tmyawslogbucket.s3.amazonaws.com.

", "smithy.api#required": {} } }, "Prefix": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

An optional string that you want CloudFront to prefix to the access log \n\t\t\t\tfilenames for this distribution, for example, myprefix/. If you \n\t\t\twant to enable logging, but you don't want to specify a prefix, you still must include an \n\t\t\tempty Prefix element in the Logging element.

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

An optional string that you want CloudFront to prefix to the access log\n\t\t\t\tfilenames for this distribution, for example, myprefix/.\n\t\t\tIf you want to enable logging, but you don't want to specify a prefix, you still must\n\t\t\tinclude an empty Prefix element in the Logging element.

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

A complex type that controls whether access logs are written for the \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A complex type that controls whether access logs are written for the\n\t\t\tdistribution.

" } }, "com.amazonaws.cloudfront#Method": { @@ -11492,7 +11564,7 @@ } }, "traits": { - "smithy.api#documentation": "

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

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

This operation requires a body. Ensure that the body is present and the\n\t\t\t\tContent-Type header is set.

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

A monitoring subscription. This structure contains information about whether additional\n\t\t\tCloudWatch metrics are enabled for a given CloudFront distribution.

" + "smithy.api#documentation": "

A monitoring subscription. This structure contains information about whether\n\t\t\tadditional CloudWatch metrics are enabled for a given CloudFront distribution.

" } }, "com.amazonaws.cloudfront#MonitoringSubscriptionAlreadyExists": { @@ -11550,6 +11622,19 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

The continuous deployment policy doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.cloudfront#NoSuchDistribution": { "type": "structure", "members": { @@ -11636,7 +11721,7 @@ } }, "traits": { - "smithy.api#documentation": "

No origin exists with the specified Origin Id.

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

No origin exists with the specified Origin Id.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -11738,68 +11823,68 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A unique identifier for the origin. This value must be unique within the\n\t\t\tdistribution.

\n

Use this value to specify the TargetOriginId in a\n CacheBehavior or DefaultCacheBehavior.

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

A unique identifier for the origin. This value must be unique within the\n\t\t\tdistribution.

\n

Use this value to specify the TargetOriginId in a\n\t\t\t\tCacheBehavior or DefaultCacheBehavior.

", "smithy.api#required": {} } }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The domain name for the origin.

\n\t\t

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

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

The domain name for the origin.

\n

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, "OriginPath": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from\n\t\t\tthe origin.

\n\t\t

For more information, see Origin Path in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

An optional path that CloudFront appends to the origin domain name when CloudFront requests\n\t\t\tcontent from the origin.

\n

For more information, see Origin Path in the\n\t\t\tAmazon CloudFront Developer Guide.

" } }, "CustomHeaders": { "target": "com.amazonaws.cloudfront#CustomHeaders", "traits": { - "smithy.api#documentation": "

A list of HTTP header names and values that CloudFront adds to the requests that it sends to\n the origin.

\n\t\t

For more information, see Adding Custom Headers to Origin Requests in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A list of HTTP header names and values that CloudFront adds to the requests that it sends to\n\t\t\tthe origin.

\n

For more information, see Adding Custom Headers to Origin Requests in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "S3OriginConfig": { "target": "com.amazonaws.cloudfront#S3OriginConfig", "traits": { - "smithy.api#documentation": "

Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static\n\t\t\twebsite hosting. To specify any other type of origin, including an Amazon S3 bucket that is\n\t\t\tconfigured with static website hosting, use the CustomOriginConfig type\n\t\t\tinstead.

" + "smithy.api#documentation": "

Use this type to specify an origin that is an Amazon S3 bucket that is not configured with\n\t\t\tstatic website hosting. To specify any other type of origin, including an Amazon S3 bucket\n\t\t\tthat is configured with static website hosting, use the CustomOriginConfig\n\t\t\ttype instead.

" } }, "CustomOriginConfig": { "target": "com.amazonaws.cloudfront#CustomOriginConfig", "traits": { - "smithy.api#documentation": "

Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the\n\t\t\tAmazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket\n\t\t\tis not configured with static website hosting, use the S3OriginConfig type\n\t\t\tinstead.

" + "smithy.api#documentation": "

Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If\n\t\t\tthe Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3\n\t\t\tbucket is not configured with static website hosting, use the\n\t\t\t\tS3OriginConfig type instead.

" } }, "ConnectionAttempts": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of times that CloudFront attempts to connect to the origin. The minimum number\n is 1, the maximum is 3, and the default (if you don’t specify otherwise) is 3.

\n

For a custom origin (including an Amazon S3 bucket that’s configured with static\n website hosting), this value also specifies the number of times that CloudFront attempts to\n get a response from the origin, in the case of an Origin Response Timeout.

\n

For more information, see Origin Connection Attempts in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The number of times that CloudFront attempts to connect to the origin. The minimum number is\n\t\t\t1, the maximum is 3, and the default (if you don't specify otherwise) is 3.

\n

For a custom origin (including an Amazon S3 bucket that's configured with static website\n\t\t\thosting), this value also specifies the number of times that CloudFront attempts to get a\n\t\t\tresponse from the origin, in the case of an Origin Response Timeout.

\n

For more information, see Origin Connection Attempts in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "ConnectionTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of seconds that CloudFront waits when trying to establish a connection to the origin.\n\t\t\tThe minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you\n\t\t\tdon’t specify otherwise) is 10 seconds.

\n\t\t

For more information, see Origin Connection Timeout in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The number of seconds that CloudFront waits when trying to establish a connection to the\n\t\t\torigin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if\n\t\t\tyou don't specify otherwise) is 10 seconds.

\n

For more information, see Origin Connection Timeout in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "OriginShield": { "target": "com.amazonaws.cloudfront#OriginShield", "traits": { - "smithy.api#documentation": "

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your\n origin.

\n\t\t

For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your\n\t\t\torigin.

\n

For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

" } }, "OriginAccessControlId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier of an origin access control for this origin.

\n\t\t

For more information, see Restricting access to an Amazon S3 origin in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The unique identifier of an origin access control for this origin.

\n

For more information, see Restricting access to an Amazon S3 origin in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

An origin.

\n\t\t

An origin is the location where content is stored, and from which CloudFront gets content to\n\t\t\tserve to viewers. To specify an origin:

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

For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide\n\t\t\t(quotas were formerly referred to as limits).

" + "smithy.api#documentation": "

An origin.

\n

An origin is the location where content is stored, and from which CloudFront gets content to\n\t\t\tserve to viewers. To specify an origin:

\n \n

For the current maximum number of origins that you can specify per distribution, see\n\t\t\t\tGeneral Quotas on Web Distributions in the\n\t\t\t\tAmazon CloudFront Developer Guide (quotas were formerly referred to as\n\t\t\tlimits).

" } }, "com.amazonaws.cloudfront#OriginAccessControl": { @@ -11862,14 +11947,14 @@ "SigningBehavior": { "target": "com.amazonaws.cloudfront#OriginAccessControlSigningBehaviors", "traits": { - "smithy.api#documentation": "

Specifies which requests CloudFront signs (adds authentication information to). Specify\n\t\t\talways for the most common use case. For more information, see origin access control advanced settings in the\n\t\t\tAmazon CloudFront Developer Guide.

\n\t\t

This field can have one of the following values:

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

Specifies which requests CloudFront signs (adds authentication information to). Specify\n\t\t\t\talways for the most common use case. For more information, see origin access control advanced settings in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

This field can have one of the following values:

\n ", "smithy.api#required": {} } }, "OriginAccessControlOriginType": { "target": "com.amazonaws.cloudfront#OriginAccessControlOriginTypes", "traits": { - "smithy.api#documentation": "

The type of origin that this origin access control is for. The only valid value is\n\t\t\ts3.

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

The type of origin that this origin access control is for. The only valid value is\n\t\t\t\ts3.

", "smithy.api#required": {} } } @@ -11904,7 +11989,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value to use in the Marker field of another request to\n\t\t\tcontinue listing origin access controls.

" + "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value to use in the Marker field of another\n\t\t\trequest to continue listing origin access controls.

" } }, "MaxItems": { @@ -11917,7 +12002,7 @@ "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

If there are more items in the list than are in this response, this value is\n\t\t\ttrue.

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

If there are more items in the list than are in this response, this value is\n\t\t\t\ttrue.

", "smithy.api#required": {} } }, @@ -12018,14 +12103,14 @@ "SigningBehavior": { "target": "com.amazonaws.cloudfront#OriginAccessControlSigningBehaviors", "traits": { - "smithy.api#documentation": "

A value that specifies which requests CloudFront signs (adds authentication information to).\n\t\t\tThis field can have one of the following values:

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

A value that specifies which requests CloudFront signs (adds authentication information to).\n\t\t\tThis field can have one of the following values:

\n ", "smithy.api#required": {} } }, "OriginAccessControlOriginType": { "target": "com.amazonaws.cloudfront#OriginAccessControlOriginTypes", "traits": { - "smithy.api#documentation": "

The type of origin that this origin access control is for. The only valid value is\n\t\t\ts3.

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

The type of origin that this origin access control is for. The only valid value is\n\t\t\t\ts3.

", "smithy.api#required": {} } } @@ -12049,20 +12134,20 @@ "HeaderName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The name of a header that you want CloudFront to send to your origin. For more information, see\n\t\t\tAdding Custom\n\t\t\tHeaders to Origin Requests in the Amazon CloudFront Developer Guide.

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

The name of a header that you want CloudFront to send to your origin. For more information,\n\t\t\tsee Adding\n\t\t\t\tCustom Headers to Origin Requests in the \n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, "HeaderValue": { "target": "com.amazonaws.cloudfront#sensitiveStringType", "traits": { - "smithy.api#documentation": "

The value for the header that you specified in the HeaderName \n\t\t\tfield.

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

The value for the header that you specified in the HeaderName\n\t\t\tfield.

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

A complex type that contains HeaderName and HeaderValue \n\t\t\telements, if any, for this distribution.

" + "smithy.api#documentation": "

A complex type that contains HeaderName and HeaderValue\n\t\t\telements, if any, for this distribution.

" } }, "com.amazonaws.cloudfront#OriginCustomHeadersList": { @@ -12087,7 +12172,7 @@ "FailoverCriteria": { "target": "com.amazonaws.cloudfront#OriginGroupFailoverCriteria", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the failover criteria for an origin group.

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

A complex type that contains information about the failover criteria for an origin\n\t\t\tgroup.

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

An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify.\n\t\tYou create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specifiy \n\t\tthe origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin\n\t\tunder the failover conditions that you've chosen.

" + "smithy.api#documentation": "

An origin group includes two origins (a primary origin and a second origin to failover\n\t\t\tto) and a failover criteria that you specify. You create an origin group to support\n\t\t\torigin failover in CloudFront. When you create or update a distribution, you can\n\t\t\tspecifiy the origin group instead of a single origin, and CloudFront will failover from\n\t\t\tthe primary origin to the second origin under the failover conditions that you've\n\t\t\tchosen.

" } }, "com.amazonaws.cloudfront#OriginGroupFailoverCriteria": { @@ -12109,13 +12194,13 @@ "StatusCodes": { "target": "com.amazonaws.cloudfront#StatusCodes", "traits": { - "smithy.api#documentation": "

The status codes that, when returned from the primary origin, will trigger CloudFront to failover \n\t\tto the second origin.

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

The status codes that, when returned from the primary origin, will trigger CloudFront\n\t\t\tto failover to the second origin.

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

A complex data type that includes information about the failover criteria for an origin group, including\n\t\tthe status codes for which CloudFront will failover from the primary origin to the second origin.

" + "smithy.api#documentation": "

A complex data type that includes information about the failover criteria for an\n\t\t\torigin group, including the status codes for which CloudFront will failover from the\n\t\t\tprimary origin to the second origin.

" } }, "com.amazonaws.cloudfront#OriginGroupList": { @@ -12267,7 +12352,7 @@ } }, "traits": { - "smithy.api#documentation": "

An origin request policy.

\n\t\t

When it’s attached to a cache behavior, the origin request policy determines the values that\n\t\t\tCloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to\n\t\t\tthe origin includes the following:

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

CloudFront sends a request when it can’t find an object in its cache that matches the request. If\n\t\t\tyou want to send values to the origin and also include them in the cache key, use\n\t\t\tCachePolicy.

" + "smithy.api#documentation": "

An origin request policy.

\n

When it's attached to a cache behavior, the origin request policy determines the\n\t\t\tvalues that CloudFront includes in requests that it sends to the origin. Each request that\n\t\t\tCloudFront sends to the origin includes the following:

\n \n

CloudFront sends a request when it can't find an object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy.

" } }, "com.amazonaws.cloudfront#OriginRequestPolicyAlreadyExists": { @@ -12278,7 +12363,7 @@ } }, "traits": { - "smithy.api#documentation": "

An origin request policy with this name already exists. You must provide a unique\n\t\t\tname. To modify an existing origin request policy, use\n\t\t\tUpdateOriginRequestPolicy.

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

An origin request policy with this name already exists. You must provide a unique\n\t\t\tname. To modify an existing origin request policy, use\n\t\t\t\tUpdateOriginRequestPolicy.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -12322,7 +12407,7 @@ } }, "traits": { - "smithy.api#documentation": "

An origin request policy configuration.

\n\t\t

This configuration determines the values that CloudFront includes in requests that it sends to the\n\t\t\torigin. Each request that CloudFront sends to the origin includes the following:

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

CloudFront sends a request when it can’t find an object in its cache that matches the request. If\n\t\t\tyou want to send values to the origin and also include them in the cache key, use\n\t\t\tCachePolicy.

" + "smithy.api#documentation": "

An origin request policy configuration.

\n

This configuration determines the values that CloudFront includes in requests that it sends\n\t\t\tto the origin. Each request that CloudFront sends to the origin includes the following:

\n \n

CloudFront sends a request when it can't find an object in its cache that matches the\n\t\t\trequest. If you want to send values to the origin and also include them in the cache\n\t\t\tkey, use CachePolicy.

" } }, "com.amazonaws.cloudfront#OriginRequestPolicyCookieBehavior": { @@ -12354,7 +12439,7 @@ "CookieBehavior": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyCookieBehavior", "traits": { - "smithy.api#documentation": "

Determines whether cookies in viewer requests are included in requests that CloudFront sends to\n\t\t\tthe origin. Valid values are:

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

Determines whether cookies in viewer requests are included in requests that CloudFront sends\n\t\t\tto the origin. Valid values are:

\n ", "smithy.api#required": {} } }, @@ -12363,7 +12448,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in requests that CloudFront sends to the origin.

" + "smithy.api#documentation": "

An object that determines whether any cookies in viewer requests (and if so, which\n\t\t\tcookies) are included in requests that CloudFront sends to the origin.

" } }, "com.amazonaws.cloudfront#OriginRequestPolicyHeaderBehavior": { @@ -12401,7 +12486,7 @@ "HeaderBehavior": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyHeaderBehavior", "traits": { - "smithy.api#documentation": "

Determines whether any HTTP headers are included in requests that CloudFront sends to the origin.\n\t\t\tValid values are:

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

Determines whether any HTTP headers are included in requests that CloudFront sends to the\n\t\t\torigin. Valid values are:

\n ", "smithy.api#required": {} } }, @@ -12410,7 +12495,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that determines whether any HTTP headers (and if so, which headers) are included\n\t\t\tin requests that CloudFront sends to the origin.

" + "smithy.api#documentation": "

An object that determines whether any HTTP headers (and if so, which headers) are\n\t\t\tincluded in requests that CloudFront sends to the origin.

" } }, "com.amazonaws.cloudfront#OriginRequestPolicyInUse": { @@ -12489,19 +12574,19 @@ "QueryStringBehavior": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyQueryStringBehavior", "traits": { - "smithy.api#documentation": "

Determines whether any URL query strings in viewer requests are included in requests that\n\t\t\tCloudFront sends to the origin. Valid values are:

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

Determines whether any URL query strings in viewer requests are included in requests\n\t\t\tthat CloudFront sends to the origin. Valid values are:

\n ", "smithy.api#required": {} } }, "QueryStrings": { "target": "com.amazonaws.cloudfront#QueryStringNames", "traits": { - "smithy.api#documentation": "

Contains a list of the query strings in viewer requests that are included in requests that\n\t\t\tCloudFront sends to the origin.

" + "smithy.api#documentation": "

Contains a list of the query strings in viewer requests that are included in requests\n\t\t\tthat CloudFront sends to the origin.

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

An object that determines whether any URL query strings in viewer requests (and if so, which\n\t\t\tquery strings) are included in requests that CloudFront sends to the origin.

" + "smithy.api#documentation": "

An object that determines whether any URL query strings in viewer requests (and if so,\n\t\t\twhich query strings) are included in requests that CloudFront sends to the origin.

" } }, "com.amazonaws.cloudfront#OriginRequestPolicySummary": { @@ -12510,7 +12595,7 @@ "Type": { "target": "com.amazonaws.cloudfront#OriginRequestPolicyType", "traits": { - "smithy.api#documentation": "

The type of origin request policy, either managed (created by Amazon Web Services) or\n\t\t\tcustom (created in this Amazon Web Services account).

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

The type of origin request policy, either managed (created by Amazon Web Services) or\n\t\t\t\tcustom (created in this Amazon Web Services account).

", "smithy.api#required": {} } }, @@ -12558,19 +12643,19 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that specifies whether Origin Shield is enabled.

\n\t\t

When it’s enabled, CloudFront routes all requests through Origin Shield, which can\n help protect your origin. When it’s disabled, CloudFront might send requests directly to\n your origin from multiple edge locations or regional edge caches.

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

A flag that specifies whether Origin Shield is enabled.

\n

When it's enabled, CloudFront routes all requests through Origin Shield, which can help\n\t\t\tprotect your origin. When it's disabled, CloudFront might send requests directly to your\n\t\t\torigin from multiple edge locations or regional edge caches.

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

The Amazon Web Services Region for Origin Shield.

\n\t\t

Specify the Amazon Web Services Region that has the lowest latency to your origin.\n To specify a region, use the region code, not the region name.\n For example, specify the US East (Ohio) region as us-east-2.

\n

When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin\n Shield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the best\n Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Region for Origin Shield.

\n

Specify the Amazon Web Services Region that has the lowest latency to your origin. To specify a\n\t\t\tregion, use the region code, not the region name. For example, specify the US East\n\t\t\t(Ohio) region as us-east-2.

\n

When you enable CloudFront Origin Shield, you must specify the Amazon Web Services Region for Origin\n\t\t\tShield. For the list of Amazon Web Services Regions that you can specify, and for help choosing the\n\t\t\tbest Region for your origin, see Choosing the Amazon Web Services Region for Origin Shield in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

CloudFront Origin Shield.

\n\t\t

Using Origin Shield can help reduce the load on your origin. For more\n information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

CloudFront Origin Shield.

\n

Using Origin Shield can help reduce the load on your origin. For more information, see\n\t\t\t\tUsing Origin Shield in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#OriginShieldRegion": { @@ -12589,7 +12674,7 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an \n\t\t\tHTTPS connection with this origin.

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

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing\n\t\t\tan HTTPS connection with this origin.

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

A complex type that contains information about the SSL/TLS protocols that CloudFront can use \n\t\t\twhen establishing an HTTPS connection with your origin.

" + "smithy.api#documentation": "

A complex type that contains information about the SSL/TLS protocols that CloudFront can use\n\t\t\twhen establishing an HTTPS connection with your origin.

" } }, "com.amazonaws.cloudfront#Origins": { @@ -12633,14 +12718,14 @@ "EnableAcceptEncodingGzip": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that can affect whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.

\n\t\t

This field is related to the EnableAcceptEncodingBrotli field. If one or\n\t\t\tboth of these fields is true \n and the viewer request\n\t\t\tincludes the Accept-Encoding header, then CloudFront does the following:

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

For more information, see Compression support in the\n Amazon CloudFront Developer Guide.

\n\t\t

If you set this value to true, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding header in\n\t\t\torigin requests when the value of this field is true, so including this\n\t\t\theader in an origin request policy has no effect.

\n\t\t

If both of these fields are false, then CloudFront treats the\n\t\t\tAccept-Encoding header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it’s not included in the cache key and it’s not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding to the headers\n\t\t\twhitelist like any other HTTP header.

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

A flag that can affect whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.

\n

This field is related to the EnableAcceptEncodingBrotli field. If one or\n\t\t\tboth of these fields is true\n and the viewer request includes the Accept-Encoding\n\t\t\theader, then CloudFront does the following:

\n \n

For more information, see Compression support in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

If you set this value to true, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding header in\n\t\t\torigin requests when the value of this field is true, so including this\n\t\t\theader in an origin request policy has no effect.

\n

If both of these fields are false, then CloudFront treats the\n\t\t\t\tAccept-Encoding header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it's not included in the cache key and it's not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding to the headers\n\t\t\twhitelist like any other HTTP header.

", "smithy.api#required": {} } }, "EnableAcceptEncodingBrotli": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that can affect whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.

\n\t\t

This field is related to the EnableAcceptEncodingGzip field. If one or\n\t\t\tboth of these fields is true \n and the viewer request\n\t\t\tincludes the Accept-Encoding header, then CloudFront does the following:

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

For more information, see Compression support in the\n Amazon CloudFront Developer Guide.

\n

If you set this value to true, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding header in\n\t\t\torigin requests when the value of this field is true, so including this\n\t\t\theader in an origin request policy has no effect.

\n\t\t

If both of these fields are false, then CloudFront treats the\n\t\t\tAccept-Encoding header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it’s not included in the cache key and it’s not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding to the headers\n\t\t\twhitelist like any other HTTP header.

" + "smithy.api#documentation": "

A flag that can affect whether the Accept-Encoding HTTP header is\n\t\t\tincluded in the cache key and included in requests that CloudFront sends to the origin.

\n

This field is related to the EnableAcceptEncodingGzip field. If one or\n\t\t\tboth of these fields is true\n and the viewer request includes the Accept-Encoding\n\t\t\theader, then CloudFront does the following:

\n \n

For more information, see Compression support in the\n\t\t\t\tAmazon CloudFront Developer Guide.

\n

If you set this value to true, and this cache behavior also has an origin\n\t\t\trequest policy attached, do not include the Accept-Encoding header in the\n\t\t\torigin request policy. CloudFront always includes the Accept-Encoding header in\n\t\t\torigin requests when the value of this field is true, so including this\n\t\t\theader in an origin request policy has no effect.

\n

If both of these fields are false, then CloudFront treats the\n\t\t\t\tAccept-Encoding header the same as any other HTTP header in the viewer\n\t\t\trequest. By default, it's not included in the cache key and it's not included in origin\n\t\t\trequests. In this case, you can manually add Accept-Encoding to the headers\n\t\t\twhitelist like any other HTTP header.

" } }, "HeadersConfig": { @@ -12653,20 +12738,20 @@ "CookiesConfig": { "target": "com.amazonaws.cloudfront#CachePolicyCookiesConfig", "traits": { - "smithy.api#documentation": "

An object that determines whether any cookies in viewer requests (and if so, which cookies)\n\t\t\tare included in the cache key and automatically included in requests that CloudFront sends to\n\t\t\tthe origin.

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

An object that determines whether any cookies in viewer requests (and if so, which\n\t\t\tcookies) are included in the cache key and automatically included in requests that CloudFront\n\t\t\tsends to the origin.

", "smithy.api#required": {} } }, "QueryStringsConfig": { "target": "com.amazonaws.cloudfront#CachePolicyQueryStringsConfig", "traits": { - "smithy.api#documentation": "

An object that determines whether any URL query strings in viewer requests (and if so, which\n\t\t\tquery strings) are included in the cache key and automatically included in requests that\n\t\t\tCloudFront sends to the origin.

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

An object that determines whether any URL query strings in viewer requests (and if so,\n\t\t\twhich query strings) are included in the cache key and automatically included in\n\t\t\trequests that CloudFront sends to the origin.

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

This object determines the values that CloudFront includes in the cache key. These values can\n\t\t\tinclude HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an\n\t\t\tobject in its cache that it can return to the viewer.

\n\t\t

The headers, cookies, and query strings that are included in the cache key are automatically\n\t\t\tincluded in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t\n\t\t\tfind an object in its cache that matches the request’s cache key. If you want to send\n\t\t\tvalues to the origin but not include them in the cache key, use\n\t\t\tOriginRequestPolicy.

" + "smithy.api#documentation": "

This object determines the values that CloudFront includes in the cache key. These values\n\t\t\tcan include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to\n\t\t\tfind an object in its cache that it can return to the viewer.

\n

The headers, cookies, and query strings that are included in the cache key are\n\t\t\tautomatically included in requests that CloudFront sends to the origin. CloudFront sends a request\n\t\t\twhen it can't find an object in its cache that matches the request's cache key. If you\n\t\t\twant to send values to the origin but not include them in the cache\n\t\t\tkey, use OriginRequestPolicy.

" } }, "com.amazonaws.cloudfront#PathList": { @@ -12684,7 +12769,7 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of invalidation paths specified for the objects that you want to invalidate.

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

The number of invalidation paths specified for the objects that you want to\n\t\t\tinvalidate.

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

A complex type that contains information about the objects that you want to invalidate. \n\t\t\tFor more information, see Specifying the Objects \n\t\t\t\tto Invalidate in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A complex type that contains information about the objects that you want to\n\t\t\tinvalidate. For more information, see Specifying the Objects to Invalidate in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#PreconditionFailed": { @@ -12783,7 +12868,7 @@ "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A string included in the request to help make sure that the request can’t be\n\t\t\treplayed.

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

A string included in the request to help make sure that the request can't be\n\t\t\treplayed.

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

The specified public key is in use.

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

The specified public key is in use.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -12840,7 +12925,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains\n\t\t\tthe value that you can use for the Marker request parameter to continue\n\t\t\tlisting your public keys where you left off.

" + "smithy.api#documentation": "

If there are more elements to be listed, this element is present and contains the\n\t\t\tvalue that you can use for the Marker request parameter to continue listing\n\t\t\tyour public keys where you left off.

" } }, "MaxItems": { @@ -12945,7 +13030,7 @@ } ], "traits": { - "smithy.api#documentation": "

Publishes a CloudFront function by copying the function code from the DEVELOPMENT\n\t\t\tstage to LIVE. This automatically updates all cache behaviors that are\n\t\t\tusing this function to use the newly published copy in the LIVE\n\t\t\tstage.

\n\t\t

When a function is published to the LIVE stage, you can attach the function to\n\t\t\ta distribution’s cache behavior, using the function’s Amazon Resource Name (ARN).

\n\t\t

To publish a function, you must provide the function’s name and version (ETag\n\t\t\tvalue). To get these values, you can use ListFunctions and\n\t\t\tDescribeFunction.

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

Publishes a CloudFront function by copying the function code from the\n\t\t\t\tDEVELOPMENT stage to LIVE. This automatically updates all\n\t\t\tcache behaviors that are using this function to use the newly published copy in the\n\t\t\t\tLIVE stage.

\n

When a function is published to the LIVE stage, you can attach the\n\t\t\tfunction to a distribution's cache behavior, using the function's Amazon Resource Name\n\t\t\t(ARN).

\n

To publish a function, you must provide the function's name and version\n\t\t\t\t(ETag value). To get these values, you can use\n\t\t\t\tListFunctions and DescribeFunction.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/function/{Name}/publish", @@ -12967,7 +13052,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version (ETag value) of the function that you are publishing, which\n\t\t\tyou can get using DescribeFunction.

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

The current version (ETag value) of the function that you are publishing,\n\t\t\twhich you can get using DescribeFunction.

", "smithy.api#httpHeader": "If-Match", "smithy.api#required": {} } @@ -13014,14 +13099,14 @@ "ForwardWhenQueryArgProfileIsUnknown": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument,\n\t\t\tfle-profile, is unknown.

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

Flag to set if you want a request to be forwarded to the origin even if the profile\n\t\t\tspecified by the field-level encryption query argument, fle-profile, is unknown.

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

Profiles specified for query argument-profile mapping for field-level encryption.

" + "smithy.api#documentation": "

Profiles specified for query argument-profile mapping for field-level\n\t\t\tencryption.

" } } }, @@ -13057,7 +13142,7 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Number of profiles for query argument-profile mapping for field-level encryption.

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

Number of profiles for query argument-profile mapping for field-level\n\t\t\tencryption.

", "smithy.api#required": {} } }, @@ -13078,19 +13163,19 @@ "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of whitelisted query string parameters for a cache \n\t\t\tbehavior.

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

The number of whitelisted query string parameters for a cache\n\t\t\tbehavior.

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#QueryStringCacheKeysList", "traits": { - "smithy.api#documentation": "

A list that contains the query string parameters that you want CloudFront to use \n\t\t\tas a basis for caching for a cache behavior. If Quantity is 0, you can omit \n\t\t\tItems.

" + "smithy.api#documentation": "

A list that contains the query string parameters that you want CloudFront to use as a basis\n\t\t\tfor caching for a cache behavior. If Quantity is 0, you can omit\n\t\t\t\tItems.

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

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n\t\t

If you want to include query strings in the cache key, use\n\t\t\tQueryStringsConfig in a cache policy. See\n\t\t\tCachePolicy.

\n\t\t

If you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse QueryStringsConfig in an origin request policy. See\n\t\t\tOriginRequestPolicy.

\n\t\t

A complex type that contains information about the query string parameters that you want\n\t\t\tCloudFront to use for caching for a cache behavior.\n\t\t

" + "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin\n\t\t\trequest policy instead of this field.

\n

If you want to include query strings in the cache key, use\n\t\t\t\tQueryStringsConfig in a cache policy. See\n\t\t\tCachePolicy.

\n

If you want to send query strings to the origin but not include them in the cache key,\n\t\t\tuse QueryStringsConfig in an origin request policy. See\n\t\t\t\tOriginRequestPolicy.

\n

A complex type that contains information about the query string parameters that you\n\t\t\twant CloudFront to use for caching for a cache behavior.

" } }, "com.amazonaws.cloudfront#QueryStringCacheKeysList": { @@ -13152,7 +13237,7 @@ "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. The\n\t\t\tsampling rate is an integer between 1 and 100, inclusive.

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

The sampling rate for this real-time log configuration. The sampling rate determines\n\t\t\tthe percentage of viewer requests that are represented in the real-time log data. The\n\t\t\tsampling rate is an integer between 1 and 100, inclusive.

", "smithy.api#required": {} } }, @@ -13166,7 +13251,7 @@ "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { - "smithy.api#documentation": "

A list of fields that are included in each real-time log record. In an API response, the\n\t\t\tfields are provided in the same order in which they are sent to the Amazon Kinesis data\n\t\t\tstream.

\n\t\t

For more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.

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

A list of fields that are included in each real-time log record. In an API response,\n\t\t\tthe fields are provided in the same order in which they are sent to the Amazon Kinesis data\n\t\t\tstream.

\n

For more information about fields, see Real-time log configuration fields in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

A real-time log configuration with this name already exists. You must provide a unique name.\n\t\t\tTo modify an existing real-time log configuration, use\n\t\t\tUpdateRealtimeLogConfig.

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

A real-time log configuration with this name already exists. You must provide a unique\n\t\t\tname. To modify an existing real-time log configuration, use\n\t\t\t\tUpdateRealtimeLogConfig.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -13196,7 +13281,7 @@ } }, "traits": { - "smithy.api#documentation": "

Cannot delete the real-time log configuration because it is attached to one or more cache\n\t\t\tbehaviors.

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

Cannot delete the real-time log configuration because it is attached to one or more\n\t\t\tcache behaviors.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -13239,21 +13324,21 @@ "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more real-time log configurations than are contained\n\t\t\tin this list.

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

A flag that indicates whether there are more real-time log configurations than are\n\t\t\tcontained in this list.

", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

This parameter indicates where this list of real-time log configurations begins. This list\n\t\t\tincludes real-time log configurations that occur after the marker.

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

This parameter indicates where this list of real-time log configurations begins. This\n\t\t\tlist includes real-time log configurations that occur after the marker.

", "smithy.api#required": {} } }, "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value that you should use in the Marker field of a subsequent\n\t\t\trequest to continue listing real-time log configurations where you left off.

" + "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing real-time log configurations where you left off.\n\t\t

" } } }, @@ -13385,13 +13470,13 @@ "ResponseHeadersPolicyConfig": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyConfig", "traits": { - "smithy.api#documentation": "

A response headers policy configuration.

\n\t\t

A response headers policy contains information about a set of HTTP response headers and\n\t\t\ttheir values. CloudFront adds the headers in the policy to HTTP responses that it sends for\n\t\t\trequests that match a cache behavior that’s associated with the policy.

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

A response headers policy configuration.

\n

A response headers policy contains information about a set of HTTP response headers\n\t\t\tand their values. CloudFront adds the headers in the policy to HTTP responses that it sends\n\t\t\tfor requests that match a cache behavior that's associated with the policy.

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

A response headers policy.

\n\t\t

A response headers policy contains information about a set of HTTP response headers\n\t\t\tand their values.

\n\t\t

After you create a response headers policy, you can use its ID to attach it to one or more\n\t\t\tcache behaviors in a CloudFront distribution. When it’s attached to a cache behavior, CloudFront\n\t\t\tadds the headers in the policy to HTTP responses that it sends for requests that match\n\t\t\tthe cache behavior.

\n\t\t

For more information, see Adding HTTP headers to CloudFront responses in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A response headers policy.

\n

A response headers policy contains information about a set of HTTP response headers\n\t\t\tand their values.

\n

After you create a response headers policy, you can use its ID to attach it to one or\n\t\t\tmore cache behaviors in a CloudFront distribution. When it's attached to a cache behavior,\n\t\t\tCloudFront adds the headers in the policy to HTTP responses that it sends for requests that\n\t\t\tmatch the cache behavior.

\n

For more information, see Adding HTTP headers to CloudFront responses in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlAllowHeaders": { @@ -13407,13 +13492,13 @@ "Items": { "target": "com.amazonaws.cloudfront#AccessControlAllowHeadersList", "traits": { - "smithy.api#documentation": "

The list of HTTP header names. You can specify * to allow all headers.

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

The list of HTTP header names. You can specify * to allow all\n\t\t\theaders.

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

A list of HTTP header names that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Headers HTTP response header.

\n\t\t

For more information about the Access-Control-Allow-Headers HTTP response\n\t\t\theader, see Access-Control-Allow-Headers in the MDN Web Docs.

" + "smithy.api#documentation": "

A list of HTTP header names that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Headers HTTP response header.

\n

For more information about the Access-Control-Allow-Headers HTTP response\n\t\t\theader, see Access-Control-Allow-Headers in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlAllowMethods": { @@ -13429,13 +13514,13 @@ "Items": { "target": "com.amazonaws.cloudfront#AccessControlAllowMethodsList", "traits": { - "smithy.api#documentation": "

The list of HTTP methods. Valid values are:

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

\n ALL is a special value that includes all of the listed HTTP\n\t\t\tmethods.

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

The list of HTTP methods. Valid values are:

\n \n

\n ALL is a special value that includes all of the listed HTTP\n\t\t\tmethods.

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

A list of HTTP methods that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Methods HTTP response header.

\n\t\t

For more information about the Access-Control-Allow-Methods HTTP response\n\t\t\theader, see Access-Control-Allow-Methods in the MDN Web Docs.

" + "smithy.api#documentation": "

A list of HTTP methods that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Methods HTTP response header.

\n

For more information about the Access-Control-Allow-Methods HTTP response\n\t\t\theader, see Access-Control-Allow-Methods in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlAllowMethodsValues": { @@ -13510,7 +13595,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of origins (domain names) that CloudFront can use as the value for the\n\t\t\tAccess-Control-Allow-Origin HTTP response header.

\n\t\t

For more information about the Access-Control-Allow-Origin HTTP response\n\t\t\theader, see Access-Control-Allow-Origin in the MDN Web Docs.

" + "smithy.api#documentation": "

A list of origins (domain names) that CloudFront can use as the value for the\n\t\t\t\tAccess-Control-Allow-Origin HTTP response header.

\n

For more information about the Access-Control-Allow-Origin HTTP response\n\t\t\theader, see Access-Control-Allow-Origin in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlExposeHeaders": { @@ -13531,7 +13616,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of HTTP headers that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Expose-Headers HTTP response header.

\n\t\t

For more information about the Access-Control-Expose-Headers HTTP\n\t\t\tresponse header, see Access-Control-Expose-Headers in the MDN Web Docs.

" + "smithy.api#documentation": "

A list of HTTP headers that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Expose-Headers HTTP response header.

\n

For more information about the Access-Control-Expose-Headers HTTP\n\t\t\tresponse header, see Access-Control-Expose-Headers in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyAlreadyExists": { @@ -13542,7 +13627,7 @@ } }, "traits": { - "smithy.api#documentation": "

A response headers policy with this name already exists. You must provide a unique name. To\n\t\t\tmodify an existing response headers policy, use\n\t\t\tUpdateResponseHeadersPolicy.

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

A response headers policy with this name already exists. You must provide a unique\n\t\t\tname. To modify an existing response headers policy, use\n\t\t\t\tUpdateResponseHeadersPolicy.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -13553,13 +13638,13 @@ "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A comment to describe the response headers policy.

\n\t\t

The comment cannot be longer than 128 characters.

" + "smithy.api#documentation": "

A comment to describe the response headers policy.

\n

The comment cannot be longer than 128 characters.

" } }, "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A name to identify the response headers policy.

\n\t\t

The name must be unique for response headers policies in this Amazon Web Services account.

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

A name to identify the response headers policy.

\n

The name must be unique for response headers policies in this Amazon Web Services account.

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

A response headers policy configuration.

\n\t\t

A response headers policy configuration contains metadata about the response headers policy,\n\t\t\tand configurations for sets of HTTP response headers and their values. CloudFront adds the\n\t\t\theaders in the policy to HTTP responses that it sends for requests that match a cache\n\t\t\tbehavior associated with the policy.

" + "smithy.api#documentation": "

A response headers policy configuration.

\n

A response headers policy configuration contains metadata about the response headers\n\t\t\tpolicy, and configurations for sets of HTTP response headers and their values. CloudFront adds\n\t\t\tthe headers in the policy to HTTP responses that it sends for requests that match a\n\t\t\tcache behavior associated with the policy.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyContentSecurityPolicy": { @@ -13598,7 +13683,7 @@ "Override": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront overrides the Content-Security-Policy\n\t\t\tHTTP response header received from the origin with the one specified in this response\n\t\t\theaders policy.

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

A Boolean that determines whether CloudFront overrides the\n\t\t\t\tContent-Security-Policy HTTP response header received from the origin\n\t\t\twith the one specified in this response headers policy.

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

The policy directives and their values that CloudFront includes as values for the\n\t\t\t\tContent-Security-Policy HTTP response header.

\n\t\t

For more information about the Content-Security-Policy HTTP response\n\t\t\theader, see Content-Security-Policy in the MDN Web Docs.

" + "smithy.api#documentation": "

The policy directives and their values that CloudFront includes as values for the\n\t\t\t\tContent-Security-Policy HTTP response header.

\n

For more information about the Content-Security-Policy HTTP response\n\t\t\theader, see Content-Security-Policy in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyContentTypeOptions": { @@ -13620,13 +13705,13 @@ "Override": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront overrides the X-Content-Type-Options\n\t\t\tHTTP response header received from the origin with the one specified in this response\n\t\t\theaders policy.

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

A Boolean that determines whether CloudFront overrides the\n\t\t\t\tX-Content-Type-Options HTTP response header received from the origin\n\t\t\twith the one specified in this response headers policy.

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

Determines whether CloudFront includes the X-Content-Type-Options HTTP response\n\t\t\theader with its value set to nosniff.

\n\t\t

For more information about the X-Content-Type-Options HTTP response\n\t\t\theader, see X-Content-Type-Options in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the X-Content-Type-Options HTTP response\n\t\t\theader with its value set to nosniff.

\n

For more information about the X-Content-Type-Options HTTP response\n\t\t\theader, see X-Content-Type-Options in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyCorsConfig": { @@ -13635,53 +13720,53 @@ "AccessControlAllowOrigins": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlAllowOrigins", "traits": { - "smithy.api#documentation": "

A list of origins (domain names) that CloudFront can use as the value for the\n\t\t\tAccess-Control-Allow-Origin HTTP response header.

\n\t\t

For more information about the Access-Control-Allow-Origin HTTP response\n\t\t\theader, see Access-Control-Allow-Origin in the MDN Web Docs.

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

A list of origins (domain names) that CloudFront can use as the value for the\n\t\t\t\tAccess-Control-Allow-Origin HTTP response header.

\n

For more information about the Access-Control-Allow-Origin HTTP response\n\t\t\theader, see Access-Control-Allow-Origin in the MDN Web Docs.

", "smithy.api#required": {} } }, "AccessControlAllowHeaders": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlAllowHeaders", "traits": { - "smithy.api#documentation": "

A list of HTTP header names that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Headers HTTP response header.

\n\t\t

For more information about the Access-Control-Allow-Headers HTTP response\n\t\t\theader, see Access-Control-Allow-Headers in the MDN Web Docs.

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

A list of HTTP header names that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Headers HTTP response header.

\n

For more information about the Access-Control-Allow-Headers HTTP response\n\t\t\theader, see Access-Control-Allow-Headers in the MDN Web Docs.

", "smithy.api#required": {} } }, "AccessControlAllowMethods": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlAllowMethods", "traits": { - "smithy.api#documentation": "

A list of HTTP methods that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Methods HTTP response header.

\n\t\t

For more information about the Access-Control-Allow-Methods HTTP response\n\t\t\theader, see Access-Control-Allow-Methods in the MDN Web Docs.

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

A list of HTTP methods that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Allow-Methods HTTP response header.

\n

For more information about the Access-Control-Allow-Methods HTTP response\n\t\t\theader, see Access-Control-Allow-Methods in the MDN Web Docs.

", "smithy.api#required": {} } }, "AccessControlAllowCredentials": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that CloudFront uses as the value for the Access-Control-Allow-Credentials\n\t\t\tHTTP response header.

\n\t\t

For more information about the Access-Control-Allow-Credentials HTTP\n\t\t\tresponse header, see Access-Control-Allow-Credentials in the MDN Web Docs.

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

A Boolean that CloudFront uses as the value for the\n\t\t\t\tAccess-Control-Allow-Credentials HTTP response header.

\n

For more information about the Access-Control-Allow-Credentials HTTP\n\t\t\tresponse header, see Access-Control-Allow-Credentials in the MDN Web Docs.

", "smithy.api#required": {} } }, "AccessControlExposeHeaders": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyAccessControlExposeHeaders", "traits": { - "smithy.api#documentation": "

A list of HTTP headers that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Expose-Headers HTTP response header.

\n\t\t

For more information about the Access-Control-Expose-Headers HTTP\n\t\t\tresponse header, see Access-Control-Expose-Headers in the MDN Web Docs.

" + "smithy.api#documentation": "

A list of HTTP headers that CloudFront includes as values for the\n\t\t\t\tAccess-Control-Expose-Headers HTTP response header.

\n

For more information about the Access-Control-Expose-Headers HTTP\n\t\t\tresponse header, see Access-Control-Expose-Headers in the MDN Web Docs.

" } }, "AccessControlMaxAgeSec": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP\n\t\t\tresponse header.

\n\t\t

For more information about the Access-Control-Max-Age HTTP response\n\t\t\theader, see Access-Control-Max-Age in the MDN Web Docs.

" + "smithy.api#documentation": "

A number that CloudFront uses as the value for the Access-Control-Max-Age HTTP\n\t\t\tresponse header.

\n

For more information about the Access-Control-Max-Age HTTP response\n\t\t\theader, see Access-Control-Max-Age in the MDN Web Docs.

" } }, "OriginOverride": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront overrides HTTP response headers received from the\n\t\t\torigin with the ones specified in this response headers policy.

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

A Boolean that determines whether CloudFront overrides HTTP response headers received from\n\t\t\tthe origin with the ones specified in this response headers policy.

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

A configuration for a set of HTTP response headers that are used for cross-origin resource\n\t\t\tsharing (CORS). CloudFront adds these headers to HTTP responses that it sends for CORS\n\t\t\trequests that match a cache behavior associated with this response headers\n\t\t\tpolicy.

\n\t\t

For more information about CORS, see Cross-Origin Resource\n\t\t\t\tSharing (CORS) in the MDN Web Docs.

" + "smithy.api#documentation": "

A configuration for a set of HTTP response headers that are used for cross-origin\n\t\t\tresource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for\n\t\t\tCORS requests that match a cache behavior associated with this response headers\n\t\t\tpolicy.

\n

For more information about CORS, see Cross-Origin Resource\n\t\t\t\tSharing (CORS) in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyCustomHeader": { @@ -13710,7 +13795,7 @@ } }, "traits": { - "smithy.api#documentation": "

An HTTP response header name and its value. CloudFront includes this header in HTTP responses that\n\t\t\tit sends for requests that match a cache behavior that’s associated with this response\n\t\t\theaders policy.

" + "smithy.api#documentation": "

An HTTP response header name and its value. CloudFront includes this header in HTTP\n\t\t\tresponses that it sends for requests that match a cache behavior that's associated with\n\t\t\tthis response headers policy.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyCustomHeaderList": { @@ -13740,7 +13825,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of HTTP response header names and their values. CloudFront includes these headers in HTTP\n\t\t\tresponses that it sends for requests that match a cache behavior that’s associated with\n\t\t\tthis response headers policy.

" + "smithy.api#documentation": "

A list of HTTP response header names and their values. CloudFront includes these headers in\n\t\t\tHTTP responses that it sends for requests that match a cache behavior that's associated\n\t\t\twith this response headers policy.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyFrameOptions": { @@ -13756,13 +13841,13 @@ "FrameOption": { "target": "com.amazonaws.cloudfront#FrameOptionsList", "traits": { - "smithy.api#documentation": "

The value of the X-Frame-Options HTTP response header. Valid values are\n\t\t\t\tDENY and SAMEORIGIN.

\n\t\t

For more information about these values, see X-Frame-Options in the MDN Web Docs.

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

The value of the X-Frame-Options HTTP response header. Valid values are\n\t\t\t\tDENY and SAMEORIGIN.

\n

For more information about these values, see X-Frame-Options in the MDN Web Docs.

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

Determines whether CloudFront includes the X-Frame-Options HTTP response header and\n\t\t\tthe header’s value.

\n\t\t

For more information about the X-Frame-Options HTTP response header, see\n\t\t\t\tX-Frame-Options in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the X-Frame-Options HTTP response header\n\t\t\tand the header's value.

\n

For more information about the X-Frame-Options HTTP response header, see\n\t\t\t\tX-Frame-Options in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyInUse": { @@ -13773,7 +13858,7 @@ } }, "traits": { - "smithy.api#documentation": "

Cannot delete the response headers policy because it is attached to one or more cache\n\t\t\tbehaviors in a CloudFront distribution.

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

Cannot delete the response headers policy because it is attached to one or more cache\n\t\t\tbehaviors in a CloudFront distribution.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -13784,7 +13869,7 @@ "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is present. It\n\t\t\tcontains the value that you should use in the Marker field of a subsequent\n\t\t\trequest to continue listing response headers policies where you left off.

" + "smithy.api#documentation": "

If there are more items in the list than are in this response, this element is\n\t\t\tpresent. It contains the value that you should use in the Marker field of a\n\t\t\tsubsequent request to continue listing response headers policies where you left\n\t\t\toff.

" } }, "MaxItems": { @@ -13825,13 +13910,13 @@ "ReferrerPolicy": { "target": "com.amazonaws.cloudfront#ReferrerPolicyList", "traits": { - "smithy.api#documentation": "

The value of the Referrer-Policy HTTP response header. Valid values\n\t\t\tare:

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

For more information about these values, see Referrer-Policy in the MDN Web Docs.

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

The value of the Referrer-Policy HTTP response header. Valid values\n\t\t\tare:

\n \n

For more information about these values, see Referrer-Policy in the MDN Web Docs.

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

Determines whether CloudFront includes the Referrer-Policy HTTP response header and\n\t\t\tthe header’s value.

\n\t\t

For more information about the Referrer-Policy HTTP response header, see\n\t\t\t\tReferrer-Policy in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the Referrer-Policy HTTP response header\n\t\t\tand the header's value.

\n

For more information about the Referrer-Policy HTTP response header, see\n\t\t\t\tReferrer-Policy in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicySecurityHeadersConfig": { @@ -13840,42 +13925,42 @@ "XSSProtection": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyXSSProtection", "traits": { - "smithy.api#documentation": "

Determines whether CloudFront includes the X-XSS-Protection HTTP response header and\n\t\t\tthe header’s value.

\n\t\t

For more information about the X-XSS-Protection HTTP response header, see\n\t\t\tX-XSS-Protection in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the X-XSS-Protection HTTP response\n\t\t\theader and the header's value.

\n

For more information about the X-XSS-Protection HTTP response header, see\n\t\t\t\tX-XSS-Protection in the MDN Web Docs.

" } }, "FrameOptions": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyFrameOptions", "traits": { - "smithy.api#documentation": "

Determines whether CloudFront includes the X-Frame-Options HTTP response header and\n\t\t\tthe header’s value.

\n\t\t

For more information about the X-Frame-Options HTTP response header, see\n\t\t\tX-Frame-Options in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the X-Frame-Options HTTP response header\n\t\t\tand the header's value.

\n

For more information about the X-Frame-Options HTTP response header, see\n\t\t\t\tX-Frame-Options in the MDN Web Docs.

" } }, "ReferrerPolicy": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyReferrerPolicy", "traits": { - "smithy.api#documentation": "

Determines whether CloudFront includes the Referrer-Policy HTTP response header and\n\t\t\tthe header’s value.

\n\t\t

For more information about the Referrer-Policy HTTP response header, see\n\t\t\tReferrer-Policy in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the Referrer-Policy HTTP response header\n\t\t\tand the header's value.

\n

For more information about the Referrer-Policy HTTP response header, see\n\t\t\t\tReferrer-Policy in the MDN Web Docs.

" } }, "ContentSecurityPolicy": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyContentSecurityPolicy", "traits": { - "smithy.api#documentation": "

The policy directives and their values that CloudFront includes as values for the\n\t\t\t\tContent-Security-Policy HTTP response header.

\n\t\t

For more information about the Content-Security-Policy HTTP response\n\t\t\theader, see Content-Security-Policy in the MDN Web Docs.

" + "smithy.api#documentation": "

The policy directives and their values that CloudFront includes as values for the\n\t\t\t\tContent-Security-Policy HTTP response header.

\n

For more information about the Content-Security-Policy HTTP response\n\t\t\theader, see Content-Security-Policy in the MDN Web Docs.

" } }, "ContentTypeOptions": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyContentTypeOptions", "traits": { - "smithy.api#documentation": "

Determines whether CloudFront includes the X-Content-Type-Options HTTP response\n\t\t\theader with its value set to nosniff.

\n\t\t

For more information about the X-Content-Type-Options HTTP response\n\t\t\theader, see X-Content-Type-Options in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the X-Content-Type-Options HTTP response\n\t\t\theader with its value set to nosniff.

\n

For more information about the X-Content-Type-Options HTTP response\n\t\t\theader, see X-Content-Type-Options in the MDN Web Docs.

" } }, "StrictTransportSecurity": { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyStrictTransportSecurity", "traits": { - "smithy.api#documentation": "

Determines whether CloudFront includes the Strict-Transport-Security HTTP response\n\t\t\theader and the header’s value.

\n\t\t

For more information about the Strict-Transport-Security HTTP response\n\t\t\theader, see Strict-Transport-Security in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the Strict-Transport-Security HTTP\n\t\t\tresponse header and the header's value.

\n

For more information about the Strict-Transport-Security HTTP response\n\t\t\theader, see Strict-Transport-Security in the MDN Web Docs.

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

A configuration for a set of security-related HTTP response headers. CloudFront adds these headers\n\t\t\tto HTTP responses that it sends for requests that match a cache behavior associated with\n\t\t\tthis response headers policy.

" + "smithy.api#documentation": "

A configuration for a set of security-related HTTP response headers. CloudFront adds these\n\t\t\theaders to HTTP responses that it sends for requests that match a cache behavior\n\t\t\tassociated with this response headers policy.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyServerTimingHeadersConfig": { @@ -13884,19 +13969,19 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP\n\t\t\tresponses that it sends in response to requests that match a cache behavior that's\n\t\t\tassociated with this response headers policy.

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

A Boolean that determines whether CloudFront adds the Server-Timing header to\n\t\t\tHTTP responses that it sends in response to requests that match a cache behavior that's\n\t\t\tassociated with this response headers policy.

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

A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to\n\t\t\tadd the Server-Timing header to. When you set the sampling rate to 100,\n\t\t\tCloudFront adds the Server-Timing header to the HTTP response for every request\n\t\t\tthat matches the cache behavior that this response headers policy is attached to. When\n\t\t\tyou set it to 50, CloudFront adds the header to 50% of the responses for requests that match\n\t\t\tthe cache behavior. You can set the sampling rate to any number 0–100 with up to four\n\t\t\tdecimal places.

" + "smithy.api#documentation": "

A number 0–100 (inclusive) that specifies the percentage of responses that you want\n\t\t\tCloudFront to add the Server-Timing header to. When you set the sampling rate to\n\t\t\t100, CloudFront adds the Server-Timing header to the HTTP response for every\n\t\t\trequest that matches the cache behavior that this response headers policy is attached\n\t\t\tto. When you set it to 50, CloudFront adds the header to 50% of the responses for requests\n\t\t\tthat match the cache behavior. You can set the sampling rate to any number 0–100 with up\n\t\t\tto four decimal places.

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

A configuration for enabling the Server-Timing header in HTTP responses sent\n\t\t\tfrom CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests\n\t\t\tthat match a cache behavior that's associated with this response headers policy.

\n\t\t

You can use the Server-Timing header to view metrics that can help you gain\n\t\t\tinsights about the behavior and performance of CloudFront. For example, you can see which\n\t\t\tcache layer served a cache hit, or the first byte latency from the origin when there was\n\t\t\ta cache miss. You can use the metrics in the Server-Timing header to\n\t\t\ttroubleshoot issues or test the efficiency of your CloudFront configuration. For more\n\t\t\tinformation, see Server-Timing header in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A configuration for enabling the Server-Timing header in HTTP responses\n\t\t\tsent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to\n\t\t\trequests that match a cache behavior that's associated with this response headers\n\t\t\tpolicy.

\n

You can use the Server-Timing header to view metrics that can help you\n\t\t\tgain insights about the behavior and performance of CloudFront. For example, you can see which\n\t\t\tcache layer served a cache hit, or the first byte latency from the origin when there was\n\t\t\ta cache miss. You can use the metrics in the Server-Timing header to\n\t\t\ttroubleshoot issues or test the efficiency of your CloudFront configuration. For more\n\t\t\tinformation, see Server-Timing header in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicyStrictTransportSecurity": { @@ -13905,20 +13990,20 @@ "Override": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront overrides the Strict-Transport-Security\n\t\t\tHTTP response header received from the origin with the one specified in this response\n\t\t\theaders policy.

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

A Boolean that determines whether CloudFront overrides the\n\t\t\t\tStrict-Transport-Security HTTP response header received from the origin\n\t\t\twith the one specified in this response headers policy.

", "smithy.api#required": {} } }, "IncludeSubdomains": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront includes the includeSubDomains directive\n\t\t\tin the Strict-Transport-Security HTTP response header.

" + "smithy.api#documentation": "

A Boolean that determines whether CloudFront includes the includeSubDomains\n\t\t\tdirective in the Strict-Transport-Security HTTP response header.

" } }, "Preload": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront includes the preload directive in the\n\t\t\tStrict-Transport-Security HTTP response header.

" + "smithy.api#documentation": "

A Boolean that determines whether CloudFront includes the preload directive in\n\t\t\tthe Strict-Transport-Security HTTP response header.

" } }, "AccessControlMaxAgeSec": { @@ -13930,7 +14015,7 @@ } }, "traits": { - "smithy.api#documentation": "

Determines whether CloudFront includes the Strict-Transport-Security HTTP response\n\t\t\theader and the header’s value.

\n\t\t

For more information about the Strict-Transport-Security HTTP response\n\t\t\theader, see Strict-Transport-Security in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the Strict-Transport-Security HTTP\n\t\t\tresponse header and the header's value.

\n

For more information about the Strict-Transport-Security HTTP response\n\t\t\theader, see Strict-Transport-Security in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#ResponseHeadersPolicySummary": { @@ -13987,32 +14072,32 @@ "Override": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront overrides the X-XSS-Protection HTTP\n\t\t\tresponse header received from the origin with the one specified in this response headers\n\t\t\tpolicy.

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

A Boolean that determines whether CloudFront overrides the X-XSS-Protection\n\t\t\tHTTP response header received from the origin with the one specified in this response\n\t\t\theaders policy.

", "smithy.api#required": {} } }, "Protection": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines the value of the X-XSS-Protection HTTP response\n\t\t\theader. When this setting is true, the value of the\n\t\t\tX-XSS-Protection header is 1. When this setting is\n\t\t\tfalse, the value of the X-XSS-Protection header is\n\t\t\t0.

\n\t\t

For more information about these settings, see X-XSS-Protection in the MDN Web Docs.

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

A Boolean that determines the value of the X-XSS-Protection HTTP response\n\t\t\theader. When this setting is true, the value of the\n\t\t\t\tX-XSS-Protection header is 1. When this setting is\n\t\t\t\tfalse, the value of the X-XSS-Protection header is\n\t\t\t\t0.

\n

For more information about these settings, see X-XSS-Protection in the MDN Web Docs.

", "smithy.api#required": {} } }, "ModeBlock": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that determines whether CloudFront includes the mode=block directive in the\n\t\t\tX-XSS-Protection header.

\n\t\t

For more information about this directive, see X-XSS-Protection in the MDN Web Docs.

" + "smithy.api#documentation": "

A Boolean that determines whether CloudFront includes the mode=block directive\n\t\t\tin the X-XSS-Protection header.

\n

For more information about this directive, see X-XSS-Protection in the MDN Web Docs.

" } }, "ReportUri": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A reporting URI, which CloudFront uses as the value of the report directive in the\n\t\t\tX-XSS-Protection header.

\n\t\t

You cannot specify a ReportUri when ModeBlock is\n\t\t\ttrue.

\n\t\t

For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.

" + "smithy.api#documentation": "

A reporting URI, which CloudFront uses as the value of the report directive in\n\t\t\tthe X-XSS-Protection header.

\n

You cannot specify a ReportUri when ModeBlock is\n\t\t\t\ttrue.

\n

For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.

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

Determines whether CloudFront includes the X-XSS-Protection HTTP response header and\n\t\t\tthe header’s value.

\n\t\t

For more information about the X-XSS-Protection HTTP response header, see\n\t\t\t\tX-XSS-Protection in the MDN Web Docs.

" + "smithy.api#documentation": "

Determines whether CloudFront includes the X-XSS-Protection HTTP response\n\t\t\theader and the header's value.

\n

For more information about the X-XSS-Protection HTTP response header, see\n\t\t\t\tX-XSS-Protection in the MDN Web Docs.

" } }, "com.amazonaws.cloudfront#Restrictions": { @@ -14021,13 +14106,13 @@ "GeoRestriction": { "target": "com.amazonaws.cloudfront#GeoRestriction", "traits": { - "smithy.api#documentation": "

A complex type that controls the countries in which your content is distributed. CloudFront \n\t\t\tdetermines the location of your users using MaxMind GeoIP databases.

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

A complex type that controls the countries in which your content is distributed. CloudFront\n\t\t\tdetermines the location of your users using MaxMind GeoIP databases.

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

A complex type that identifies ways in which you want to restrict distribution of your \n\t\t\tcontent.

" + "smithy.api#documentation": "

A complex type that identifies ways in which you want to restrict distribution of your\n\t\t\tcontent.

" } }, "com.amazonaws.cloudfront#S3Origin": { @@ -14036,20 +14121,20 @@ "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The DNS name of the Amazon S3 origin.

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

The DNS name of the Amazon S3 origin.

", "smithy.api#required": {} } }, "OriginAccessIdentity": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The CloudFront origin access identity to associate with the distribution. Use an origin \n\t\t\taccess identity to configure the distribution so that end users can only access objects in an \n\t\t\tAmazon S3 bucket through CloudFront.

\n\t\t

If you want end users to be able to access objects using either the CloudFront URL or the \n\t\t\tAmazon S3 URL, specify an empty OriginAccessIdentity element.

\n\t\t

To delete the origin access identity from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty OriginAccessIdentity \n\t\t\telement.

\n\t\t

To replace the origin access identity, update the distribution configuration and \n\t\t\tspecify the new origin access identity.

\n\t\t

For more information, see Using an Origin Access \n\t\t\t\tIdentity to Restrict Access to Your Amazon S3 Content in the \n\t\t\t\tAmazon CloudFront Developer Guide.

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

The CloudFront origin access identity to associate with the distribution. Use an origin\n\t\t\taccess identity to configure the distribution so that end users can only access objects\n\t\t\tin an Amazon S3 bucket through CloudFront.

\n

If you want end users to be able to access objects using either the CloudFront URL or the\n\t\t\tAmazon S3 URL, specify an empty OriginAccessIdentity element.

\n

To delete the origin access identity from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty OriginAccessIdentity\n\t\t\telement.

\n

To replace the origin access identity, update the distribution configuration and\n\t\t\tspecify the new origin access identity.

\n

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in\n\t\t\tthe Amazon CloudFront Developer Guide.

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

A complex type that contains information about the Amazon S3 bucket from which you want \n\t\t\tCloudFront to get your media files for distribution.

" + "smithy.api#documentation": "

A complex type that contains information about the Amazon S3 bucket from which you want\n\t\t\tCloudFront to get your media files for distribution.

" } }, "com.amazonaws.cloudfront#S3OriginConfig": { @@ -14058,13 +14143,13 @@ "OriginAccessIdentity": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The CloudFront origin access identity to associate with the origin. Use an origin access \n\t\t\tidentity to configure the origin so that viewers can only access objects \n\t\t\tin an Amazon S3 bucket through CloudFront. The format of the value is:

\n\t\t

origin-access-identity/cloudfront/ID-of-origin-access-identity\n

\n\t\t

where \n ID-of-origin-access-identity\n is the value that \n\t\t\tCloudFront returned in the ID element when you created the origin access \n\t\t\tidentity.

\n\t\t

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 \n\t\t\tURL, specify an empty OriginAccessIdentity element.

\n\t\t

To delete the origin access identity from an existing distribution, update the \n\t\t\tdistribution configuration and include an empty OriginAccessIdentity \n\t\t\telement.

\n\t\t

To replace the origin access identity, update the distribution configuration and \n\t\t\tspecify the new origin access identity.

\n\t\t

For more information about the origin access identity, see Serving Private Content through CloudFront in the \n\t\t\t\tAmazon CloudFront Developer Guide.

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

The CloudFront origin access identity to associate with the origin. Use an origin access\n\t\t\tidentity to configure the origin so that viewers can only access\n\t\t\tobjects in an Amazon S3 bucket through CloudFront. The format of the value is:

\n

origin-access-identity/cloudfront/ID-of-origin-access-identity\n

\n

where \n ID-of-origin-access-identity\n is the value that\n\t\t\tCloudFront returned in the ID element when you created the origin access\n\t\t\tidentity.

\n

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3\n\t\t\tURL, specify an empty OriginAccessIdentity element.

\n

To delete the origin access identity from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty OriginAccessIdentity\n\t\t\telement.

\n

To replace the origin access identity, update the distribution configuration and\n\t\t\tspecify the new origin access identity.

\n

For more information about the origin access identity, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

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

A complex type that contains information about the Amazon S3 origin. If the origin is a\n\t\t\tcustom origin or an S3 bucket that is configured as a website endpoint, use the\n CustomOriginConfig element instead.

" + "smithy.api#documentation": "

A complex type that contains information about the Amazon S3 origin. If the origin is a\n\t\t\tcustom origin or an S3 bucket that is configured as a website endpoint, use the\n\t\t\t\tCustomOriginConfig element instead.

" } }, "com.amazonaws.cloudfront#SSLSupportMethod": { @@ -14105,20 +14190,20 @@ "IdleTTL": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The amount of time after which you want sessions to cease if no requests are\n\t\t\treceived.\u2028Allowed values are 300–3600 seconds (5–60 minutes).

\n\t\t

The value must be less than or equal to MaximumTTL.

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

The amount of time after which you want sessions to cease if no requests are\n\t\t\treceived. Allowed values are 300–3600 seconds (5–60 minutes).

\n

The value must be less than or equal to MaximumTTL.

", "smithy.api#required": {} } }, "MaximumTTL": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The maximum amount of time to consider requests from the viewer as being part of the same\n\t\t\tsession. Allowed values are 300–3600 seconds (5–60 minutes).

\n\t\t

The value must be less than or equal to IdleTTL.

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

The maximum amount of time to consider requests from the viewer as being part of the\n\t\t\tsame session. Allowed values are 300–3600 seconds (5–60 minutes).

\n

The value must be less than or equal to IdleTTL.

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

Session stickiness provides the ability to define multiple requests from a single viewer as\n\t\t\ta single session. This prevents the potentially inconsistent experience of sending some\n\t\t\tof a given user's requests to your staging distribution, while others are sent to your\n\t\t\tprimary distribution. Define the session duration using TTL values.

" + "smithy.api#documentation": "

Session stickiness provides the ability to define multiple requests from a single\n\t\t\tviewer as a single session. This prevents the potentially inconsistent experience of\n\t\t\tsending some of a given user's requests to your staging distribution, while others are\n\t\t\tsent to your primary distribution. Define the session duration using TTL values.

" } }, "com.amazonaws.cloudfront#Signer": { @@ -14127,7 +14212,7 @@ "AwsAccountNumber": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the\n\t\t\tsignatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs\n\t\t\tis the same account that owns the CloudFront distribution, the value of this field is\n\t\t\tself.

" + "smithy.api#documentation": "

An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to\n\t\t\tverify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns\n\t\t\tthe key pairs is the same account that owns the CloudFront distribution, the value of this\n\t\t\tfield is self.

" } }, "KeyPairIds": { @@ -14138,7 +14223,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to\n\t\t\tverify the signatures of signed URLs and signed cookies.

" + "smithy.api#documentation": "

A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can\n\t\t\tuse to verify the signatures of signed URLs and signed cookies.

" } }, "com.amazonaws.cloudfront#SignerList": { @@ -14265,7 +14350,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex data type for the status codes that you specify that, when returned by a primary origin, trigger\n\t\tCloudFront to failover to a second origin.

" + "smithy.api#documentation": "

A complex data type for the status codes that you specify that, when returned by a\n\t\t\tprimary origin, trigger CloudFront to failover to a second origin.

" } }, "com.amazonaws.cloudfront#StreamingDistribution": { @@ -14274,41 +14359,41 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier for the RTMP distribution. For example: \n\t\t\tEGTXBD79EXAMPLE.

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

The identifier for the RTMP distribution. For example:\n\t\t\tEGTXBD79EXAMPLE.

", "smithy.api#required": {} } }, "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the distribution. For example: \n\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where \n\t\t\t123456789012 is your Amazon Web Services account ID.

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

The ARN (Amazon Resource Name) for the distribution. For example:\n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where\n\t\t\t\t123456789012 is your Amazon Web Services account ID.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current status of the RTMP distribution. When the status is Deployed, \n\t\t\tthe distribution's information is propagated to all CloudFront edge locations.

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

The current status of the RTMP distribution. When the status is Deployed,\n\t\t\tthe distribution's information is propagated to all CloudFront edge locations.

", "smithy.api#required": {} } }, "LastModifiedTime": { "target": "com.amazonaws.cloudfront#timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the distribution was last modified.

" + "smithy.api#documentation": "

The date and time that the distribution was last modified.

" } }, "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

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

The domain name that corresponds to the streaming distribution, for example,\n\t\t\t\ts5c39gqb8ow64r.cloudfront.net.

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

A complex type that lists the Amazon Web Services accounts, if any, that you included in the \n\t\t\t\tTrustedSigners complex type for this distribution. These are the accounts that \n\t\t\tyou want to allow to create signed URLs for private content.

\n\t\t

The Signer complex type lists the Amazon Web Services account number of the trusted \n\t\t\tsigner or self if the signer is the Amazon Web Services account that created the distribution. \n\t\t\tThe Signer element also includes the IDs of any active CloudFront key pairs that are \n\t\t\tassociated with the trusted signer's Amazon Web Services account. If no KeyPairId element \n\t\t\tappears for a Signer, that signer can't create signed URLs.

\n\t\t

For more information, see Serving Private \n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

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

A complex type that lists the Amazon Web Services accounts, if any, that you included in the\n\t\t\t\tTrustedSigners complex type for this distribution. These are the\n\t\t\taccounts that you want to allow to create signed URLs for private content.

\n

The Signer complex type lists the Amazon Web Services account number of the trusted\n\t\t\tsigner or self if the signer is the Amazon Web Services account that created the\n\t\t\tdistribution. The Signer element also includes the IDs of any active CloudFront\n\t\t\tkey pairs that are associated with the trusted signer's Amazon Web Services account. If no\n\t\t\t\tKeyPairId element appears for a Signer, that signer can't\n\t\t\tcreate signed URLs.

\n

For more information, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

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

A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to \n\t\t\ttrack and manage content delivery.

" + "smithy.api#documentation": "

A streaming distribution tells CloudFront where you want RTMP content to be delivered from,\n\t\t\tand the details about how to track and manage content delivery.

" } }, "com.amazonaws.cloudfront#StreamingDistributionAlreadyExists": { @@ -14332,7 +14417,7 @@ } }, "traits": { - "smithy.api#documentation": "

The caller reference you attempted to create the streaming distribution with \n\t\t\tis associated with another distribution

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

The caller reference you attempted to create the streaming distribution with is\n\t\t\tassociated with another distribution

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -14343,53 +14428,53 @@ "CallerReference": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A unique value (for example, a date-time stamp) that ensures that the request can't be \n\t\t\treplayed.

\n\t\t

If the value of CallerReference is new (regardless of the content of the \n\t\t\tStreamingDistributionConfig object), CloudFront creates a new distribution.

\n\t\t

If CallerReference is a value that you already sent in a previous request to \n\t\t\tcreate a distribution, CloudFront returns a DistributionAlreadyExists error.

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

A unique value (for example, a date-time stamp) that ensures that the request can't be\n\t\t\treplayed.

\n

If the value of CallerReference is new (regardless of the content of the\n\t\t\t\tStreamingDistributionConfig object), CloudFront creates a new\n\t\t\tdistribution.

\n

If CallerReference is a value that you already sent in a previous request\n\t\t\tto create a distribution, CloudFront returns a DistributionAlreadyExists\n\t\t\terror.

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

A complex type that contains information about the Amazon S3 bucket from which you want \n\t\t\tCloudFront to get your media files for distribution.

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

A complex type that contains information about the Amazon S3 bucket from which you want\n\t\t\tCloudFront to get your media files for distribution.

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

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this streaming distribution.

" + "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this streaming distribution.

" } }, "Comment": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Any comments you want to include about the streaming distribution.

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

Any comments you want to include about the streaming distribution.

", "smithy.api#required": {} } }, "Logging": { "target": "com.amazonaws.cloudfront#StreamingLoggingConfig", "traits": { - "smithy.api#documentation": "

A complex type that controls whether access logs are written for the streaming \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A complex type that controls whether access logs are written for the streaming\n\t\t\tdistribution.

" } }, "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "

A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed \n\t\t\tURLs for private content. If you want the distribution to use signed URLs, include this \n\t\t\telement; if you want the distribution to use public URLs, remove this element. For more \n\t\t\tinformation, see Serving Private Content through \n\t\t\t\tCloudFront in the Amazon CloudFront Developer Guide.

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

A complex type that specifies any Amazon Web Services accounts that you want to permit to create\n\t\t\tsigned URLs for private content. If you want the distribution to use signed URLs,\n\t\t\tinclude this element; if you want the distribution to use public URLs, remove this\n\t\t\telement. For more information, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

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

A complex type that contains information about price class for this streaming \n\t\t\tdistribution.

" + "smithy.api#documentation": "

A complex type that contains information about price class for this streaming\n\t\t\tdistribution.

" } }, "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Whether the streaming distribution is enabled to accept user requests for \n\t\t\tcontent.

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

Whether the streaming distribution is enabled to accept user requests for\n\t\t\tcontent.

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

A streaming distribution Configuration and a list of tags to be associated with the \n\t\t\tstreaming distribution.

" + "smithy.api#documentation": "

A streaming distribution Configuration and a list of tags to be associated with the\n\t\t\tstreaming distribution.

" } }, "com.amazonaws.cloudfront#StreamingDistributionList": { @@ -14426,46 +14511,46 @@ "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value you provided for the Marker request parameter.

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

The value you provided for the Marker request parameter.

", "smithy.api#required": {} } }, "NextMarker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains \n\t\t\tthe value you can use for the Marker request parameter to continue listing your \n\t\t\tRTMP distributions where they left off.

" + "smithy.api#documentation": "

If IsTruncated is true, this element is present and contains\n\t\t\tthe value you can use for the Marker request parameter to continue listing\n\t\t\tyour RTMP distributions where they left off.

" } }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The value you provided for the MaxItems request parameter.

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

The value you provided for the MaxItems request parameter.

", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more streaming distributions remain to be listed. If your \n\t\t\tresults were truncated, you can make a follow-up pagination request using the \n\t\t\t\tMarker request parameter to retrieve more distributions in the list.

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

A flag that indicates whether more streaming distributions remain to be listed. If\n\t\t\tyour results were truncated, you can make a follow-up pagination request using the\n\t\t\t\tMarker request parameter to retrieve more distributions in the list.\n\t\t

", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

The number of streaming distributions that were created by the current Amazon Web Services account. \n\t\t

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

The number of streaming distributions that were created by the current Amazon Web Services account.\n\t\t

", "smithy.api#required": {} } }, "Items": { "target": "com.amazonaws.cloudfront#StreamingDistributionSummaryList", "traits": { - "smithy.api#documentation": "

A complex type that contains one StreamingDistributionSummary element for \n\t\t\teach distribution that was created by the current Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains one StreamingDistributionSummary element for\n\t\t\teach distribution that was created by the current Amazon Web Services account.

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

A streaming distribution list.

" + "smithy.api#documentation": "

A streaming distribution list.

" } }, "com.amazonaws.cloudfront#StreamingDistributionNotDisabled": { @@ -14476,7 +14561,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified CloudFront distribution is not disabled. You must disable \n\t\t\tthe distribution before you can delete it.

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

The specified CloudFront distribution is not disabled. You must disable the distribution\n\t\t\tbefore you can delete it.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -14494,14 +14579,14 @@ "ARN": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) for the streaming distribution. For example: \n\t\t\t\tarn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where \n\t\t\t\t123456789012 is your Amazon Web Services account ID.

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

The ARN (Amazon Resource Name) for the streaming distribution. For example:\n\t\t\t\tarn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5,\n\t\t\twhere 123456789012 is your Amazon Web Services account ID.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

Indicates the current status of the distribution. When the status is \n\t\t\tDeployed, the distribution's information is fully propagated throughout the \n\t\t\tAmazon CloudFront system.

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

Indicates the current status of the distribution. When the status is\n\t\t\t\tDeployed, the distribution's information is fully propagated throughout\n\t\t\tthe Amazon CloudFront system.

", "smithy.api#required": {} } }, @@ -14515,28 +14600,28 @@ "DomainName": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

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

The domain name corresponding to the distribution, for example,\n\t\t\t\td111111abcdef8.cloudfront.net.

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

A complex type that contains information about the Amazon S3 bucket from which you want \n\t\t\tCloudFront to get your media files for distribution.

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

A complex type that contains information about the Amazon S3 bucket from which you want\n\t\t\tCloudFront to get your media files for distribution.

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

A complex type that contains information about CNAMEs (alternate domain names), if any, \n\t\t\tfor this streaming distribution.

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

A complex type that contains information about CNAMEs (alternate domain names), if\n\t\t\tany, for this streaming distribution.

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

A complex type that specifies the Amazon Web Services accounts, if any, that you want to allow to \n\t\t\tcreate signed URLs for private content. If you want to require signed URLs in requests for \n\t\t\tobjects in the target origin that match the PathPattern for this cache behavior, \n\t\t\tspecify true for Enabled, and specify the applicable values for \n\t\t\t\tQuantity and Items.If you don't want to require signed URLs in \n\t\t\trequests for objects that match PathPattern, specify false for \n\t\t\t\tEnabled and 0 for Quantity. Omit Items. \n\t\t\tTo add, change, or remove one or more trusted signers, change Enabled to \n\t\t\t\ttrue (if it's currently false), change Quantity as \n\t\t\tapplicable, and specify all of the trusted signers that you want to include in the updated \n\t\t\tdistribution.

\n\t\t

For more information, see Serving Private \n\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

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

A complex type that specifies the Amazon Web Services accounts, if any, that you want to allow to\n\t\t\tcreate signed URLs for private content. If you want to require signed URLs in requests\n\t\t\tfor objects in the target origin that match the PathPattern for this cache\n\t\t\tbehavior, specify true for Enabled, and specify the applicable\n\t\t\tvalues for Quantity and Items.If you don't want to require\n\t\t\tsigned URLs in requests for objects that match PathPattern, specify\n\t\t\t\tfalse for Enabled and 0 for\n\t\t\t\tQuantity. Omit Items. To add, change, or remove one or\n\t\t\tmore trusted signers, change Enabled to true (if it's\n\t\t\tcurrently false), change Quantity as applicable, and specify\n\t\t\tall of the trusted signers that you want to include in the updated distribution.

\n

For more information, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } }, @@ -14550,7 +14635,7 @@ "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "

A complex type that contains information about price class for this streaming \n\t\t\tdistribution.

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

A complex type that contains information about price class for this streaming\n\t\t\tdistribution.

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

A summary of the information for a CloudFront streaming distribution.

" + "smithy.api#documentation": "

A summary of the information for a CloudFront streaming distribution.

" } }, "com.amazonaws.cloudfront#StreamingDistributionSummaryList": { @@ -14581,27 +14666,27 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't \n\t\t\twant to enable logging when you create a streaming distribution or if you want to disable \n\t\t\tlogging for an existing streaming distribution, specify false for \n\t\t\t\tEnabled, and specify empty Bucket and Prefix \n\t\t\telements. If you specify false for Enabled but you specify values \n\t\t\tfor Bucket and Prefix, the values are automatically deleted. \n\t\t

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

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't\n\t\t\twant to enable logging when you create a streaming distribution or if you want to\n\t\t\tdisable logging for an existing streaming distribution, specify false for\n\t\t\t\tEnabled, and specify empty Bucket and Prefix\n\t\t\telements. If you specify false for Enabled but you specify\n\t\t\tvalues for Bucket and Prefix, the values are automatically\n\t\t\tdeleted.

", "smithy.api#required": {} } }, "Bucket": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

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

The Amazon S3 bucket to store the access logs in, for example,\n\t\t\t\tmyawslogbucket.s3.amazonaws.com.

", "smithy.api#required": {} } }, "Prefix": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, \n\t\t\tmyprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include \n\t\t\tan empty Prefix element in the Logging element.

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

An optional string that you want CloudFront to prefix to the access log filenames for this\n\t\t\tstreaming distribution, for example, myprefix/. If you want to enable\n\t\t\tlogging, but you don't want to specify a prefix, you still must include an empty\n\t\t\t\tPrefix element in the Logging element.

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

A complex type that controls whether access logs are written for this streaming distribution.

" + "smithy.api#documentation": "

A complex type that controls whether access logs are written for this streaming\n\t\t\tdistribution.

" } }, "com.amazonaws.cloudfront#Tag": { @@ -14610,25 +14695,25 @@ "Key": { "target": "com.amazonaws.cloudfront#TagKey", "traits": { - "smithy.api#documentation": "

A string that contains Tag key.

\n\t\t

The string length should be between 1 and 128 characters. Valid characters include \n\t\t\t\ta-z, A-Z, 0-9, space, and the special characters \n\t\t\t\t_ - . : / = + @.

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

A string that contains Tag key.

\n

The string length should be between 1 and 128 characters. Valid characters include\n\t\t\t\ta-z, A-Z, 0-9, space, and the special\n\t\t\tcharacters _ - . : / = + @.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.cloudfront#TagValue", "traits": { - "smithy.api#documentation": "

A string that contains an optional Tag value.

\n\t\t

The string length should be between 0 and 256 characters. Valid characters include \n\t\t\t\ta-z, A-Z, 0-9, space, and the special characters \n\t\t\t\t_ - . : / = + @.

" + "smithy.api#documentation": "

A string that contains an optional Tag value.

\n

The string length should be between 0 and 256 characters. Valid characters include\n\t\t\t\ta-z, A-Z, 0-9, space, and the special\n\t\t\tcharacters _ - . : / = + @.

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

A complex type that contains Tag key and Tag value.

" + "smithy.api#documentation": "

A complex type that contains Tag key and Tag value.

" } }, "com.amazonaws.cloudfront#TagKey": { "type": "string", "traits": { - "smithy.api#documentation": "

A string that contains Tag key.

\n\t\t

The string length should be between 1 and 128 characters. Valid characters include \n\t\t\t\ta-z, A-Z, 0-9, space, and the special characters \n\t\t\t\t_ - . : / = + @.

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

A string that contains Tag key.

\n

The string length should be between 1 and 128 characters. Valid characters include\n\t\t\t\ta-z, A-Z, 0-9, space, and the special\n\t\t\tcharacters _ - . : / = + @.

", "smithy.api#length": { "min": 1, "max": 128 @@ -14651,12 +14736,12 @@ "Items": { "target": "com.amazonaws.cloudfront#TagKeyList", "traits": { - "smithy.api#documentation": "

A complex type that contains Tag key elements.

" + "smithy.api#documentation": "

A complex type that contains Tag key elements.

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

A complex type that contains zero or more Tag elements.

" + "smithy.api#documentation": "

A complex type that contains zero or more Tag elements.

" } }, "com.amazonaws.cloudfront#TagList": { @@ -14705,7 +14790,7 @@ "Resource": { "target": "com.amazonaws.cloudfront#ResourceARN", "traits": { - "smithy.api#documentation": "

An ARN of a CloudFront resource.

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

An ARN of a CloudFront resource.

", "smithy.api#httpQuery": "Resource", "smithy.api#required": {} } @@ -14713,7 +14798,7 @@ "Tags": { "target": "com.amazonaws.cloudfront#Tags", "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more Tag elements.

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

A complex type that contains zero or more Tag elements.

", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "Tags" @@ -14721,7 +14806,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request to add tags to a CloudFront resource.

" + "smithy.api#documentation": "

The request to add tags to a CloudFront resource.

" } }, "com.amazonaws.cloudfront#TagValue": { @@ -14740,12 +14825,12 @@ "Items": { "target": "com.amazonaws.cloudfront#TagList", "traits": { - "smithy.api#documentation": "

A complex type that contains Tag elements.

" + "smithy.api#documentation": "

A complex type that contains Tag elements.

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

A complex type that contains zero or more Tag elements.

" + "smithy.api#documentation": "

A complex type that contains zero or more Tag elements.

" } }, "com.amazonaws.cloudfront#TestFunction": { @@ -14774,7 +14859,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tests a CloudFront function.

\n\t\t

To test a function, you provide an event object that represents an HTTP\n\t\t\trequest or response that your CloudFront distribution could receive in production. CloudFront runs\n\t\t\tthe function, passing it the event object that you provided, and returns the function’s\n\t\t\tresult (the modified event object) in the response. The response also contains function\n\t\t\tlogs and error messages, if any exist. For more information about testing functions, see\n\t\t\tTesting functions in the Amazon CloudFront Developer Guide.

\n\t\t

To test a function, you provide the function’s name and version (ETag value)\n\t\t\talong with the event object. To get the function’s name and version, you can use\n\t\t\tListFunctions and DescribeFunction.

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

Tests a CloudFront function.

\n

To test a function, you provide an event object that represents\n\t\t\tan HTTP request or response that your CloudFront distribution could receive in production.\n\t\t\tCloudFront runs the function, passing it the event object that you provided, and returns the\n\t\t\tfunction's result (the modified event object) in the response. The response also\n\t\t\tcontains function logs and error messages, if any exist. For more information about\n\t\t\ttesting functions, see Testing functions in the Amazon CloudFront Developer Guide.

\n

To test a function, you provide the function's name and version (ETag\n\t\t\tvalue) along with the event object. To get the function's name and version, you can use\n\t\t\t\tListFunctions and DescribeFunction.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/function/{Name}/test", @@ -14809,7 +14894,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version (ETag value) of the function that you are testing, which\n\t\t\tyou can get using DescribeFunction.

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

The current version (ETag value) of the function that you are testing,\n\t\t\twhich you can get using DescribeFunction.

", "smithy.api#httpHeader": "If-Match", "smithy.api#required": {} } @@ -14817,13 +14902,13 @@ "Stage": { "target": "com.amazonaws.cloudfront#FunctionStage", "traits": { - "smithy.api#documentation": "

The stage of the function that you are testing, either DEVELOPMENT or\n\t\t\tLIVE.

" + "smithy.api#documentation": "

The stage of the function that you are testing, either DEVELOPMENT or\n\t\t\t\tLIVE.

" } }, "EventObject": { "target": "com.amazonaws.cloudfront#FunctionEventObject", "traits": { - "smithy.api#documentation": "

The event object to test the function with. For more information about the structure of the\n\t\t\tevent object, see Testing functions in the Amazon CloudFront Developer Guide.

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

The event object to test the function with. For more information about the structure\n\t\t\tof the event object, see Testing functions in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } } @@ -14871,7 +14956,7 @@ "FunctionOutput": { "target": "com.amazonaws.cloudfront#sensitiveStringType", "traits": { - "smithy.api#documentation": "

The event object returned by the function. For more information about the structure of the\n\t\t\tevent object, see Event object\n\t\t\tstructure in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

The event object returned by the function. For more information about the structure of\n\t\t\tthe event object, see Event\n\t\t\t\tobject structure in the Amazon CloudFront Developer Guide.

" } } }, @@ -14887,7 +14972,7 @@ } }, "traits": { - "smithy.api#documentation": "

The length of the Content-Security-Policy header value in the response headers\n\t\t\tpolicy exceeds the maximum.

\n\t\t

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

The length of the Content-Security-Policy header value in the response\n\t\t\theaders policy exceeds the maximum.

\n

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

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

You have reached the maximum number of cache policies for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

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

You have reached the maximum number of cache policies for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14939,7 +15024,20 @@ } }, "traits": { - "smithy.api#documentation": "

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", + "smithy.api#documentation": "

Processing your request would cause you to exceed the maximum number of origin access\n\t\t\tidentities allowed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudfront#TooManyContinuousDeploymentPolicies": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "

You have reached the maximum number of continuous deployment policies for this\n\t\t\tAmazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14952,7 +15050,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", + "smithy.api#documentation": "

Your request contains more cookie names in the whitelist than are allowed per cache\n\t\t\tbehavior.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14965,7 +15063,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of cookies in the cache policy exceeds the maximum. For more information,\n\t\t\tsee Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of cookies in the cache policy exceeds the maximum. For more information,\n\t\t\tsee Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14978,7 +15076,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of cookies in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of cookies in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14991,7 +15089,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of custom headers in the response headers policy exceeds the maximum.

\n\t\t

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of custom headers in the response headers policy exceeds the\n\t\t\tmaximum.

\n

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15017,7 +15115,7 @@ } }, "traits": { - "smithy.api#documentation": "

Processing your request would cause you to exceed the maximum number of distributions allowed.

", + "smithy.api#documentation": "

Processing your request would cause you to exceed the maximum number of distributions\n\t\t\tallowed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15030,7 +15128,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified cache\n\t\t\tpolicy. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified cache\n\t\t\tpolicy. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15043,7 +15141,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified configuration for field-level encryption.

", + "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified\n\t\t\tconfiguration for field-level encryption.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15056,7 +15154,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of distributions that reference this key group is more than the maximum\n\t\t\tallowed. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of distributions that reference this key group is more than the maximum\n\t\t\tallowed. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15069,7 +15167,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified origin\n\t\t\taccess control.

\n\t\t

For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified origin\n\t\t\taccess control.

\n

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15082,7 +15180,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified origin\n\t\t\trequest policy. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified origin\n\t\t\trequest policy. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15095,7 +15193,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified response headers\n\t\t\tpolicy.

\n\t\t

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified response\n\t\t\theaders policy.

\n

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15108,7 +15206,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have reached the maximum number of distributions that are associated with a CloudFront\n\t\t\tfunction. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

You have reached the maximum number of distributions that are associated with a CloudFront\n\t\t\tfunction. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15121,7 +15219,7 @@ } }, "traits": { - "smithy.api#documentation": "

Processing your request would cause the maximum number of distributions with Lambda@Edge function associations per owner \n\t\t\tto be exceeded.

", + "smithy.api#documentation": "

Processing your request would cause the maximum number of distributions with\n\t\t\tLambda@Edge function associations per owner to be exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15134,7 +15232,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified Lambda@Edge\n\t\t\tfunction.

", + "smithy.api#documentation": "

The maximum number of distributions have been associated with the specified\n\t\t\tLambda@Edge function.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15147,7 +15245,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of configurations for field-level encryption have been created.

", + "smithy.api#documentation": "

The maximum number of configurations for field-level encryption have been\n\t\t\tcreated.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15160,7 +15258,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of content type profiles for field-level encryption have been created.

", + "smithy.api#documentation": "

The maximum number of content type profiles for field-level encryption have been\n\t\t\tcreated.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15173,7 +15271,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of encryption entities for field-level encryption have been created.

", + "smithy.api#documentation": "

The maximum number of encryption entities for field-level encryption have been\n\t\t\tcreated.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15186,7 +15284,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of field patterns for field-level encryption have been created.

", + "smithy.api#documentation": "

The maximum number of field patterns for field-level encryption have been\n\t\t\tcreated.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15212,7 +15310,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of query arg profiles for field-level encryption have been created.

", + "smithy.api#documentation": "

The maximum number of query arg profiles for field-level encryption have been\n\t\t\tcreated.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15225,7 +15323,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have reached the maximum number of CloudFront function associations for this\n\t\t\tdistribution. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

You have reached the maximum number of CloudFront function associations for this\n\t\t\tdistribution. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15238,7 +15336,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

You have reached the maximum number of CloudFront functions for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15251,7 +15349,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of headers in the cache policy exceeds the maximum. For more information,\n\t\t\tsee Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of headers in the cache policy exceeds the maximum. For more information,\n\t\t\tsee Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15277,7 +15375,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of headers in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of headers in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15290,7 +15388,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", + "smithy.api#documentation": "

You have exceeded the maximum number of allowable InProgress invalidation batch\n\t\t\trequests, or invalidation objects.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15303,7 +15401,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have reached the maximum number of key groups for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

You have reached the maximum number of key groups for this Amazon Web Services account. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15316,7 +15414,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of key groups referenced by this distribution is more than the maximum\n\t\t\tallowed. For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of key groups referenced by this distribution is more than the maximum\n\t\t\tallowed. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15329,7 +15427,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your request contains more Lambda@Edge function associations than are allowed per distribution.

", + "smithy.api#documentation": "

Your request contains more Lambda@Edge function associations than are allowed per\n\t\t\tdistribution.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15342,7 +15440,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of origin access controls in your Amazon Web Services account exceeds the maximum\n\t\t\tallowed.

\n\t\t

For more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of origin access controls in your Amazon Web Services account exceeds the maximum\n\t\t\tallowed.

\n

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15368,7 +15466,7 @@ } }, "traits": { - "smithy.api#documentation": "

Processing your request would cause you to exceed the maximum number of origin groups allowed.

", + "smithy.api#documentation": "

Processing your request would cause you to exceed the maximum number of origin groups\n\t\t\tallowed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15381,7 +15479,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have reached the maximum number of origin request policies for this Amazon Web Services account.\n\t\t\tFor more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

You have reached the maximum number of origin request policies for this Amazon Web Services account.\n\t\t\tFor more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15407,7 +15505,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.

", + "smithy.api#documentation": "

The maximum number of public keys for field-level encryption have been created. To\n\t\t\tcreate a new public key, delete one of the existing keys.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15420,7 +15518,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of public keys in this key group is more than the maximum allowed. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of public keys in this key group is more than the maximum allowed. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15446,7 +15544,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of query strings in the cache policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of query strings in the cache policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15459,7 +15557,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of query strings in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The number of query strings in the origin request policy exceeds the maximum. For more\n\t\t\tinformation, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15472,7 +15570,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have reached the maximum number of real-time log configurations for this Amazon Web Services account.\n\t\t\tFor more information, see Quotas (formerly known as limits) in the\n\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

You have reached the maximum number of real-time log configurations for this\n\t\t\tAmazon Web Services account. For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15485,7 +15583,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have reached the maximum number of response headers policies for this\n\t\t\tAmazon Web Services account.

\n\t\t

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

You have reached the maximum number of response headers policies for this\n\t\t\tAmazon Web Services account.

\n

For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15511,7 +15609,7 @@ } }, "traits": { - "smithy.api#documentation": "

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", + "smithy.api#documentation": "

Processing your request would cause you to exceed the maximum number of streaming\n\t\t\tdistributions allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15584,7 +15682,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

This field is true if any of the key groups in the list have public keys that\n\t\t\tCloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this\n\t\t\tfield is false.

", + "smithy.api#documentation": "

This field is true if any of the key groups in the list have public keys\n\t\t\tthat CloudFront can use to verify the signatures of signed URLs and signed cookies. If not,\n\t\t\tthis field is false.

", "smithy.api#required": {} } }, @@ -15625,7 +15723,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

This field is true if any of the Amazon Web Services accounts have public keys that CloudFront can\n\t\t\tuse to verify the signatures of signed URLs and signed cookies. If not, this field is\n\t\t\tfalse.

", + "smithy.api#documentation": "

This field is true if any of the Amazon Web Services accounts have public keys that\n\t\t\tCloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this\n\t\t\tfield is false.

", "smithy.api#required": {} } }, @@ -15644,7 +15742,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of signed\n\t\t\tURLs and signed cookies.

" + "smithy.api#documentation": "

A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of\n\t\t\tsigned URLs and signed cookies.

" } }, "com.amazonaws.cloudfront#UnsupportedOperation": { @@ -15697,7 +15795,7 @@ "Resource": { "target": "com.amazonaws.cloudfront#ResourceARN", "traits": { - "smithy.api#documentation": "

An ARN of a CloudFront resource.

", + "smithy.api#documentation": "

An ARN of a CloudFront resource.

", "smithy.api#httpQuery": "Resource", "smithy.api#required": {} } @@ -15705,7 +15803,7 @@ "TagKeys": { "target": "com.amazonaws.cloudfront#TagKeys", "traits": { - "smithy.api#documentation": "

A complex type that contains zero or more Tag key elements.

", + "smithy.api#documentation": "

A complex type that contains zero or more Tag key elements.

", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "TagKeys" @@ -15713,7 +15811,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request to remove tags from a CloudFront resource.

" + "smithy.api#documentation": "

The request to remove tags from a CloudFront resource.

" } }, "com.amazonaws.cloudfront#UpdateCachePolicy": { @@ -15760,7 +15858,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a cache policy configuration.

\n\t\t

When you update a cache policy configuration, all the fields are updated with the\n\t\t\tvalues provided in the request. You cannot update some fields independent of others. To\n\t\t\tupdate a cache policy configuration:

\n\t\t
    \n
  1. \n\t\t\t\t

    Use GetCachePolicyConfig to get the current configuration.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Locally modify the fields in the cache policy configuration that you want to\n\t\t\t\t\tupdate.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Call UpdateCachePolicy by providing the entire cache policy\n\t\t\t\t\tconfiguration, including the fields that you modified and those that you\n\t\t\t\t\tdidn’t.

    \n\t\t\t
    4. \n
", + "smithy.api#documentation": "

Updates a cache policy configuration.

\n

When you update a cache policy configuration, all the fields are updated with the\n\t\t\tvalues provided in the request. You cannot update some fields independent of others. To\n\t\t\tupdate a cache policy configuration:

\n
    \n
  1. \n

    Use GetCachePolicyConfig to get the current configuration.

    \n
    2. \n
  2. \n

    Locally modify the fields in the cache policy configuration that you want to\n\t\t\t\t\tupdate.

    \n
    3. \n
  3. \n

    Call UpdateCachePolicy by providing the entire cache policy\n\t\t\t\t\tconfiguration, including the fields that you modified and those that you\n\t\t\t\t\tdidn't.

    \n
    4. \n
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/cache-policy/{Id}", @@ -15783,7 +15881,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier for the cache policy that you are updating. The identifier is returned\n\t\t\tin a cache behavior’s CachePolicyId field in the response to\n\t\t\tGetDistributionConfig.

", + "smithy.api#documentation": "

The unique identifier for the cache policy that you are updating. The identifier is\n\t\t\treturned in a cache behavior's CachePolicyId field in the response to\n\t\t\t\tGetDistributionConfig.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15791,7 +15889,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version of the cache policy that you are updating. The version is returned in the cache\n\t\t\tpolicy’s ETag field in the response to\n\t\t\tGetCachePolicyConfig.

", + "smithy.api#documentation": "

The version of the cache policy that you are updating. The version is returned in the\n\t\t\tcache policy's ETag field in the response to\n\t\t\t\tGetCachePolicyConfig.

", "smithy.api#httpHeader": "If-Match" } } @@ -15851,7 +15949,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update an origin access identity.

", + "smithy.api#documentation": "

Update an origin access identity.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}/config", @@ -15882,7 +15980,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tidentity's configuration. For example: E2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the\n\t\t\tidentity's configuration. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -15904,7 +16002,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -15934,6 +16032,9 @@ { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" + }, { "target": "com.amazonaws.cloudfront#PreconditionFailed" }, @@ -15942,7 +16043,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a continuous deployment policy. You can update a continuous deployment policy to\n\t\t\tenable or disable it, to change the percentage of traffic that it sends to the staging\n\t\t\tdistribution, or to change the staging distribution that it sends traffic to.

\n\t\t

When you update a continuous deployment policy configuration, all the fields are\n\t\t\tupdated with the values that are provided in the request. You cannot update some fields\n\t\t\tindependent of others. To update a continuous deployment policy configuration:

\n\t\t
    \n
  1. \n\t\t\t\t

    Use GetContinuousDeploymentPolicyConfig to get the current\n\t\t\t\t\tconfiguration.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Locally modify the fields in the continuous deployment policy configuration\n\t\t\t\t\tthat you want to update.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Use UpdateContinuousDeploymentPolicy, providing the entire\n\t\t\t\t\tcontinuous deployment policy configuration, including the fields that you\n\t\t\t\t\tmodified and those that you didn’t.

    \n\t\t\t
    4. \n
", + "smithy.api#documentation": "

Updates a continuous deployment policy. You can update a continuous deployment policy\n\t\t\tto enable or disable it, to change the percentage of traffic that it sends to the\n\t\t\tstaging distribution, or to change the staging distribution that it sends traffic\n\t\t\tto.

\n

When you update a continuous deployment policy configuration, all the fields are\n\t\t\tupdated with the values that are provided in the request. You cannot update some fields\n\t\t\tindependent of others. To update a continuous deployment policy configuration:

\n
    \n
  1. \n

    Use GetContinuousDeploymentPolicyConfig to get the current\n\t\t\t\t\tconfiguration.

    \n
    2. \n
  2. \n

    Locally modify the fields in the continuous deployment policy configuration\n\t\t\t\t\tthat you want to update.

    \n
    3. \n
  3. \n

    Use UpdateContinuousDeploymentPolicy, providing the entire\n\t\t\t\t\tcontinuous deployment policy configuration, including the fields that you\n\t\t\t\t\tmodified and those that you didn't.

    \n
    4. \n
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/continuous-deployment-policy/{Id}", @@ -15973,7 +16074,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version (ETag value) of the continuous deployment policy that you\n\t\t\tare updating.

", + "smithy.api#documentation": "

The current version (ETag value) of the continuous deployment policy that\n\t\t\tyou are updating.

", "smithy.api#httpHeader": "If-Match" } } @@ -15992,7 +16093,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version identifier for the current version of the continuous deployment policy.

", + "smithy.api#documentation": "

The version identifier for the current version of the continuous deployment\n\t\t\tpolicy.

", "smithy.api#httpHeader": "ETag" } } @@ -16013,6 +16114,9 @@ { "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, + { + "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyInUse" + }, { "target": "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" }, @@ -16100,6 +16204,9 @@ { "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" + }, { "target": "com.amazonaws.cloudfront#NoSuchDistribution" }, @@ -16198,7 +16305,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration for a CloudFront distribution.

\n\t\t

The update process includes getting the current distribution configuration, updating it to\n\t\t\tmake your changes, and then submitting an UpdateDistribution request to\n\t\t\tmake the updates.

\n\t\t \n\t\t

\n To update a web distribution using the CloudFront API\n

\n\t\t
    \n
  1. \n

    Use GetDistributionConfig to get the current configuration, including the version\n\t\t\t\t\tidentifier (ETag).

    \n\t\t\t
    2. \n
  2. \n

    Update the distribution configuration that was returned in the response. Note the following\n\t\t\t\t\timportant requirements and restrictions:

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      You must rename the ETag field to IfMatch,\n\t\t\t\t\t\t\tleaving the value unchanged. (Set the value of IfMatch to\n\t\t\t\t\t\t\tthe value of ETag, then remove the ETag\n\t\t\t\t\t\t\tfield.)

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      You can’t change the value of CallerReference.

      \n\t\t\t\t\t
      • \n
    \n\t\t\t
    3. \n
  3. \n

    Submit an UpdateDistribution request, providing the distribution configuration.\n\t\t\t\t\tThe new configuration replaces the existing configuration. The values that you\n\t\t\t\t\tspecify in an UpdateDistribution request are not merged into your\n\t\t\t\t\texisting configuration. Make sure to include all fields: the ones that you\n\t\t\t\t\tmodified and also the ones that you didn’t.

    \n\t\t\t
    4. \n
", + "smithy.api#documentation": "

Updates the configuration for a CloudFront distribution.

\n

The update process includes getting the current distribution configuration, updating\n\t\t\tit to make your changes, and then submitting an UpdateDistribution request\n\t\t\tto make the updates.

\n

\n To update a web distribution using the CloudFront\n\t\t\tAPI\n

\n
    \n
  1. \n

    Use GetDistributionConfig to get the current configuration,\n\t\t\t\t\tincluding the version identifier (ETag).

    \n
    2. \n
  2. \n

    Update the distribution configuration that was returned in the response. Note\n\t\t\t\t\tthe following important requirements and restrictions:

    \n
      \n
    • \n

      You must rename the ETag field to IfMatch,\n\t\t\t\t\t\t\tleaving the value unchanged. (Set the value of IfMatch to\n\t\t\t\t\t\t\tthe value of ETag, then remove the ETag\n\t\t\t\t\t\t\tfield.)

      \n
      • \n
    • \n

      You can't change the value of CallerReference.

      \n
      • \n
    \n
    3. \n
  3. \n

    Submit an UpdateDistribution request, providing the distribution\n\t\t\t\t\tconfiguration. The new configuration replaces the existing configuration. The\n\t\t\t\t\tvalues that you specify in an UpdateDistribution request are not\n\t\t\t\t\tmerged into your existing configuration. Make sure to include all fields: the\n\t\t\t\t\tones that you modified and also the ones that you didn't.

    \n
    4. \n
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/distribution/{Id}/config", @@ -16229,7 +16336,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tdistribution's configuration. For example: E2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the\n\t\t\tdistribution's configuration. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -16251,7 +16358,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -16260,6 +16367,250 @@ "smithy.api#documentation": "

The returned result of the corresponding request.

" } }, + "com.amazonaws.cloudfront#UpdateDistributionWithStagingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#UpdateDistributionWithStagingConfigRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#UpdateDistributionWithStagingConfigResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" + }, + { + "target": "com.amazonaws.cloudfront#IllegalUpdate" + }, + { + "target": "com.amazonaws.cloudfront#InconsistentQuantities" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidDefaultRootObject" + }, + { + "target": "com.amazonaws.cloudfront#InvalidErrorCode" + }, + { + "target": "com.amazonaws.cloudfront#InvalidForwardCookies" + }, + { + "target": "com.amazonaws.cloudfront#InvalidFunctionAssociation" + }, + { + "target": "com.amazonaws.cloudfront#InvalidGeoRestrictionParameter" + }, + { + "target": "com.amazonaws.cloudfront#InvalidHeadersForS3Origin" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#InvalidLambdaFunctionAssociation" + }, + { + "target": "com.amazonaws.cloudfront#InvalidLocationCode" + }, + { + "target": "com.amazonaws.cloudfront#InvalidMinimumProtocolVersion" + }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessControl" + }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginAccessIdentity" + }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginKeepaliveTimeout" + }, + { + "target": "com.amazonaws.cloudfront#InvalidOriginReadTimeout" + }, + { + "target": "com.amazonaws.cloudfront#InvalidQueryStringParameters" + }, + { + "target": "com.amazonaws.cloudfront#InvalidRelativePath" + }, + { + "target": "com.amazonaws.cloudfront#InvalidRequiredProtocol" + }, + { + "target": "com.amazonaws.cloudfront#InvalidResponseCode" + }, + { + "target": "com.amazonaws.cloudfront#InvalidTTLOrder" + }, + { + "target": "com.amazonaws.cloudfront#InvalidViewerCertificate" + }, + { + "target": "com.amazonaws.cloudfront#InvalidWebACLId" + }, + { + "target": "com.amazonaws.cloudfront#MissingBody" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchCachePolicy" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchDistribution" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchOrigin" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchOriginRequestPolicy" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchRealtimeLogConfig" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchResponseHeadersPolicy" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + }, + { + "target": "com.amazonaws.cloudfront#RealtimeLogConfigOwnerMismatch" + }, + { + "target": "com.amazonaws.cloudfront#TooManyCacheBehaviors" + }, + { + "target": "com.amazonaws.cloudfront#TooManyCertificates" + }, + { + "target": "com.amazonaws.cloudfront#TooManyCookieNamesInWhiteList" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionCNAMEs" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToCachePolicy" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToFieldLevelEncryptionConfig" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToResponseHeadersPolicy" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsWithFunctionAssociations" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsWithLambdaAssociations" + }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsWithSingleFunctionARN" + }, + { + "target": "com.amazonaws.cloudfront#TooManyFunctionAssociations" + }, + { + "target": "com.amazonaws.cloudfront#TooManyHeadersInForwardedValues" + }, + { + "target": "com.amazonaws.cloudfront#TooManyKeyGroupsAssociatedToDistribution" + }, + { + "target": "com.amazonaws.cloudfront#TooManyLambdaFunctionAssociations" + }, + { + "target": "com.amazonaws.cloudfront#TooManyOriginCustomHeaders" + }, + { + "target": "com.amazonaws.cloudfront#TooManyOriginGroupsPerDistribution" + }, + { + "target": "com.amazonaws.cloudfront#TooManyOrigins" + }, + { + "target": "com.amazonaws.cloudfront#TooManyQueryStringParameters" + }, + { + "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" + }, + { + "target": "com.amazonaws.cloudfront#TrustedKeyGroupDoesNotExist" + }, + { + "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the staging distribution's configuration to its corresponding primary\n\t\t\tdistribution. The primary distribution retains its Aliases (also known as\n\t\t\talternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value,\n\t\t\tbut otherwise its configuration is overwritten to match the staging distribution.

\n

You can use this operation in a continuous deployment workflow after you have tested\n\t\t\tconfiguration changes on the staging distribution. After using a continuous deployment\n\t\t\tpolicy to move a portion of your domain name's traffic to the staging distribution and\n\t\t\tverifying that it works as intended, you can use this operation to copy the staging\n\t\t\tdistribution's configuration to the primary distribution. This action will disable the\n\t\t\tcontinuous deployment policy and move your domain's traffic back to the primary distribution.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-05-31/distribution/{Id}/promote-staging-config", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#UpdateDistributionWithStagingConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The identifier of the primary distribution to which you are copying a staging distribution's\n\t\t\tconfiguration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StagingDistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The identifier of the staging distribution whose configuration you are copying to the primary distribution.

", + "smithy.api#httpQuery": "StagingDistributionId" + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current versions (ETag values) of both primary and staging distributions.\n\t\t\tProvide these in the following format:

\n

\n , \n

", + "smithy.api#httpHeader": "If-Match" + } + } + } + }, + "com.amazonaws.cloudfront#UpdateDistributionWithStagingConfigResult": { + "type": "structure", + "members": { + "Distribution": { + "target": "com.amazonaws.cloudfront#Distribution", + "traits": { + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "

The current version of the primary distribution (after it's updated).

", + "smithy.api#httpHeader": "ETag" + } + } + } + }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfig": { "type": "operation", "input": { @@ -16304,7 +16655,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update a field-level encryption configuration.

", + "smithy.api#documentation": "

Update a field-level encryption configuration.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/field-level-encryption/{Id}/config", @@ -16318,7 +16669,7 @@ "FieldLevelEncryptionConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfig", "traits": { - "smithy.api#documentation": "

Request to update a field-level encryption configuration.

", + "smithy.api#documentation": "

Request to update a field-level encryption configuration.

", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "FieldLevelEncryptionConfig" @@ -16335,7 +16686,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the configuration identity to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the\n\t\t\tconfiguration identity to update. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -16354,7 +16705,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when updating the configuration. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The value of the ETag header that you received when updating the\n\t\t\tconfiguration. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -16407,7 +16758,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update a field-level encryption profile.

", + "smithy.api#documentation": "

Update a field-level encryption profile.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/field-level-encryption-profile/{Id}/config", @@ -16421,7 +16772,7 @@ "FieldLevelEncryptionProfileConfig": { "target": "com.amazonaws.cloudfront#FieldLevelEncryptionProfileConfig", "traits": { - "smithy.api#documentation": "

Request to update a field-level encryption profile.

", + "smithy.api#documentation": "

Request to update a field-level encryption profile.

", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "FieldLevelEncryptionProfileConfig" @@ -16430,7 +16781,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ID of the field-level encryption profile request.

", + "smithy.api#documentation": "

The ID of the field-level encryption profile request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16438,7 +16789,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the profile identity to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the\n\t\t\tprofile identity to update. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -16457,7 +16808,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The result of the field-level encryption profile request.

", + "smithy.api#documentation": "

The result of the field-level encryption profile request.

", "smithy.api#httpHeader": "ETag" } } @@ -16492,7 +16843,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a CloudFront function.

\n\t\t

You can update a function’s code or the comment that describes the function. You\n\t\t\tcannot update a function’s name.

\n\t\t

To update a function, you provide the function’s name and version (ETag value)\n\t\t\talong with the updated function code. To get the name and version, you can use\n\t\t\tListFunctions and DescribeFunction.

", + "smithy.api#documentation": "

Updates a CloudFront function.

\n

You can update a function's code or the comment that describes the function. You\n\t\t\tcannot update a function's name.

\n

To update a function, you provide the function's name and version (ETag\n\t\t\tvalue) along with the updated function code. To get the name and version, you can use\n\t\t\t\tListFunctions and DescribeFunction.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/function/{Name}", @@ -16514,7 +16865,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version (ETag value) of the function that you are updating, which\n\t\t\tyou can get using DescribeFunction.

", + "smithy.api#documentation": "

The current version (ETag value) of the function that you are updating,\n\t\t\twhich you can get using DescribeFunction.

", "smithy.api#httpHeader": "If-Match", "smithy.api#required": {} } @@ -16529,7 +16880,7 @@ "FunctionCode": { "target": "com.amazonaws.cloudfront#FunctionBlob", "traits": { - "smithy.api#documentation": "

The function code. For more information about writing a CloudFront function, see Writing function\n\t\t\tcode for CloudFront Functions in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The function code. For more information about writing a CloudFront function, see Writing\n\t\t\t\tfunction code for CloudFront Functions in the\n\t\t\tAmazon CloudFront Developer Guide.

", "smithy.api#required": {} } } @@ -16583,7 +16934,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a key group.

\n\t\t

When you update a key group, all the fields are updated with the values provided in\n\t\t\tthe request. You cannot update some fields independent of others. To update a key\n\t\t\tgroup:

\n\t\t
    \n
  1. \n\t\t\t\t

    Get the current key group with GetKeyGroup or\n\t\t\t\t\tGetKeyGroupConfig.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Locally modify the fields in the key group that you want to update. For\n\t\t\t\t\texample, add or remove public key IDs.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Call UpdateKeyGroup with the entire key group object, including\n\t\t\t\t\tthe fields that you modified and those that you didn’t.

    \n\t\t\t
    4. \n
", + "smithy.api#documentation": "

Updates a key group.

\n

When you update a key group, all the fields are updated with the values provided in\n\t\t\tthe request. You cannot update some fields independent of others. To update a key\n\t\t\tgroup:

\n
    \n
  1. \n

    Get the current key group with GetKeyGroup or\n\t\t\t\t\t\tGetKeyGroupConfig.

    \n
    2. \n
  2. \n

    Locally modify the fields in the key group that you want to update. For\n\t\t\t\t\texample, add or remove public key IDs.

    \n
    3. \n
  3. \n

    Call UpdateKeyGroup with the entire key group object, including\n\t\t\t\t\tthe fields that you modified and those that you didn't.

    \n
    4. \n
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/key-group/{Id}", @@ -16614,7 +16965,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version of the key group that you are updating. The version is the key group’s\n\t\t\tETag value.

", + "smithy.api#documentation": "

The version of the key group that you are updating. The version is the key group's\n\t\t\t\tETag value.

", "smithy.api#httpHeader": "If-Match" } } @@ -16702,7 +17053,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version (ETag value) of the origin access control that you are\n\t\t\tupdating.

", + "smithy.api#documentation": "

The current version (ETag value) of the origin access control that you\n\t\t\tare updating.

", "smithy.api#httpHeader": "If-Match" } } @@ -16771,7 +17122,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an origin request policy configuration.

\n\t\t

When you update an origin request policy configuration, all the fields are updated\n\t\t\twith the values provided in the request. You cannot update some fields independent of\n\t\t\tothers. To update an origin request policy configuration:

\n\t\t
    \n
  1. \n\t\t\t\t

    Use GetOriginRequestPolicyConfig to get the current configuration.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Locally modify the fields in the origin request policy configuration that you\n\t\t\t\t\twant to update.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Call UpdateOriginRequestPolicy by providing the entire origin\n\t\t\t\t\trequest policy configuration, including the fields that you modified and those\n\t\t\t\t\tthat you didn’t.

    \n\t\t\t
    4. \n
", + "smithy.api#documentation": "

Updates an origin request policy configuration.

\n

When you update an origin request policy configuration, all the fields are updated\n\t\t\twith the values provided in the request. You cannot update some fields independent of\n\t\t\tothers. To update an origin request policy configuration:

\n
    \n
  1. \n

    Use GetOriginRequestPolicyConfig to get the current\n\t\t\t\t\tconfiguration.

    \n
    2. \n
  2. \n

    Locally modify the fields in the origin request policy configuration that you\n\t\t\t\t\twant to update.

    \n
    3. \n
  3. \n

    Call UpdateOriginRequestPolicy by providing the entire origin\n\t\t\t\t\trequest policy configuration, including the fields that you modified and those\n\t\t\t\t\tthat you didn't.

    \n
    4. \n
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/origin-request-policy/{Id}", @@ -16794,7 +17145,7 @@ "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The unique identifier for the origin request policy that you are updating. The identifier is\n\t\t\treturned in a cache behavior’s OriginRequestPolicyId field in the response\n\t\t\tto GetDistributionConfig.

", + "smithy.api#documentation": "

The unique identifier for the origin request policy that you are updating. The\n\t\t\tidentifier is returned in a cache behavior's OriginRequestPolicyId field in\n\t\t\tthe response to GetDistributionConfig.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16802,7 +17153,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version of the origin request policy that you are updating. The version is returned in\n\t\t\tthe origin request policy’s ETag field in the response to\n\t\t\tGetOriginRequestPolicyConfig.

", + "smithy.api#documentation": "

The version of the origin request policy that you are updating. The version is\n\t\t\treturned in the origin request policy's ETag field in the response to\n\t\t\t\tGetOriginRequestPolicyConfig.

", "smithy.api#httpHeader": "If-Match" } } @@ -16859,7 +17210,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update public key information. Note that the only value you can change is the comment.

", + "smithy.api#documentation": "

Update public key information. Note that the only value you can change is the\n\t\t\tcomment.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/public-key/{Id}/config", @@ -16890,7 +17241,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the public key to update. \n\t\t\tFor example: E2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the public\n\t\t\tkey to update. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -16935,7 +17286,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a real-time log configuration.

\n\t\t

When you update a real-time log configuration, all the parameters are updated with the\n\t\t\tvalues provided in the request. You cannot update some parameters independent of others.\n\t\t\tTo update a real-time log configuration:

\n\t\t
    \n
  1. \n\t\t\t\t

    Call GetRealtimeLogConfig to get the current real-time log\n\t\t\t\t\tconfiguration.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Locally modify the parameters in the real-time log configuration that you want\n\t\t\t\t\tto update.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Call this API (UpdateRealtimeLogConfig) by providing the entire\n\t\t\t\t\treal-time log configuration, including the parameters that you modified and\n\t\t\t\t\tthose that you didn’t.

    \n\t\t\t
    4. \n
\n\t\t

You cannot update a real-time log configuration’s Name or\n\t\t\tARN.

", + "smithy.api#documentation": "

Updates a real-time log configuration.

\n

When you update a real-time log configuration, all the parameters are updated with the\n\t\t\tvalues provided in the request. You cannot update some parameters independent of others.\n\t\t\tTo update a real-time log configuration:

\n
    \n
  1. \n

    Call GetRealtimeLogConfig to get the current real-time log\n\t\t\t\t\tconfiguration.

    \n
    2. \n
  2. \n

    Locally modify the parameters in the real-time log configuration that you want\n\t\t\t\t\tto update.

    \n
    3. \n
  3. \n

    Call this API (UpdateRealtimeLogConfig) by providing the entire\n\t\t\t\t\treal-time log configuration, including the parameters that you modified and\n\t\t\t\t\tthose that you didn't.

    \n
    4. \n
\n

You cannot update a real-time log configuration's Name or\n\t\t\t\tARN.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/realtime-log-config", @@ -16955,7 +17306,7 @@ "Fields": { "target": "com.amazonaws.cloudfront#FieldList", "traits": { - "smithy.api#documentation": "

A list of fields to include in each real-time log record.

\n\t\t

For more information about fields, see Real-time log configuration fields in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A list of fields to include in each real-time log record.

\n

For more information about fields, see Real-time log configuration fields in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "Name": { @@ -16973,7 +17324,7 @@ "SamplingRate": { "target": "com.amazonaws.cloudfront#long", "traits": { - "smithy.api#documentation": "

The sampling rate for this real-time log configuration. The sampling rate determines the\n\t\t\tpercentage of viewer requests that are represented in the real-time log data. You must\n\t\t\tprovide an integer between 1 and 100, inclusive.

" + "smithy.api#documentation": "

The sampling rate for this real-time log configuration. The sampling rate determines\n\t\t\tthe percentage of viewer requests that are represented in the real-time log data. You\n\t\t\tmust provide an integer between 1 and 100, inclusive.

" } } } @@ -17030,7 +17381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a response headers policy.

\n\t\t

When you update a response headers policy, the entire policy is replaced. You cannot\n\t\t\tupdate some policy fields independent of others. To update a response headers policy\n\t\t\tconfiguration:

\n\t\t
    \n
  1. \n\t\t\t\t

    Use GetResponseHeadersPolicyConfig to get the current policy’s\n\t\t\t\t\tconfiguration.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Modify the fields in the response headers policy configuration that you want\n\t\t\t\t\tto update.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Call UpdateResponseHeadersPolicy, providing the entire response\n\t\t\t\t\theaders policy configuration, including the fields that you modified and those\n\t\t\t\t\tthat you didn’t.

    \n\t\t\t
    4. \n
", + "smithy.api#documentation": "

Updates a response headers policy.

\n

When you update a response headers policy, the entire policy is replaced. You cannot\n\t\t\tupdate some policy fields independent of others. To update a response headers policy\n\t\t\tconfiguration:

\n
    \n
  1. \n

    Use GetResponseHeadersPolicyConfig to get the current policy's\n\t\t\t\t\tconfiguration.

    \n
    2. \n
  2. \n

    Modify the fields in the response headers policy configuration that you want\n\t\t\t\t\tto update.

    \n
    3. \n
  3. \n

    Call UpdateResponseHeadersPolicy, providing the entire response\n\t\t\t\t\theaders policy configuration, including the fields that you modified and those\n\t\t\t\t\tthat you didn't.

    \n
    4. \n
", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/response-headers-policy/{Id}", @@ -17061,7 +17412,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The version of the response headers policy that you are updating.

\n\t\t

The version is returned in the cache policy’s ETag field in the response\n\t\t\tto GetResponseHeadersPolicyConfig.

", + "smithy.api#documentation": "

The version of the response headers policy that you are updating.

\n

The version is returned in the cache policy's ETag field in the response\n\t\t\tto GetResponseHeadersPolicyConfig.

", "smithy.api#httpHeader": "If-Match" } } @@ -17139,7 +17490,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update a streaming distribution.

", + "smithy.api#documentation": "

Update a streaming distribution.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/streaming-distribution/{Id}/config", @@ -17170,7 +17521,7 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the \n\t\t\tstreaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The value of the ETag header that you received when retrieving the\n\t\t\tstreaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "If-Match" } } @@ -17192,7 +17543,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the configuration. For example: \n\t\t\tE2QWRUHAPOMQZL.

", + "smithy.api#documentation": "

The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.

", "smithy.api#httpHeader": "ETag" } } @@ -17207,50 +17558,50 @@ "CloudFrontDefaultCertificate": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net, set this field to true.

\n\t\t

If the distribution uses Aliases (alternate domain names or CNAMEs), set\n\t\t\tthis field to false and specify values for the following fields:

\n\t\t " + "smithy.api#documentation": "

If the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net, set this field to\n\t\t\ttrue.

\n

If the distribution uses Aliases (alternate domain names or CNAMEs), set\n\t\t\tthis field to false and specify values for the following fields:

\n " } }, "IAMCertificateId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM\n\t\t\tcertificate.

\n\t\t

If you specify an IAM certificate ID, you must also specify values for\n\t\t\tMinimumProtocolVersion and SSLSupportMethod.

" + "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.

\n

If you specify an IAM certificate ID, you must also specify values for\n\t\t\t\tMinimumProtocolVersion and SSLSupportMethod.

" } }, "ACMCertificateArn": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource\n\t\t\tName (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US\n\t\t\tEast (N. Virginia) Region (us-east-1).

\n\t\t

If you specify an ACM certificate ARN, you must also specify values for\n\t\t\tMinimumProtocolVersion and SSLSupportMethod.

" + "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs) and\n\t\t\tthe SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource Name\n\t\t\t(ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East\n\t\t\t(N. Virginia) Region (us-east-1).

\n

If you specify an ACM certificate ARN, you must also specify values for\n\t\t\t\tMinimumProtocolVersion and SSLSupportMethod.

" } }, "SSLSupportMethod": { "target": "com.amazonaws.cloudfront#SSLSupportMethod", "traits": { - "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs), specify\n\t\t\twhich viewers the distribution accepts HTTPS connections from.

\n\t\t \n\t\t

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net, don’t set a value for this field.

" + "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify which viewers the distribution accepts HTTPS connections from.

\n \n

If the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net, don't set a value for this field.

" } }, "MinimumProtocolVersion": { "target": "com.amazonaws.cloudfront#MinimumProtocolVersion", "traits": { - "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify the security policy that you want CloudFront to use for HTTPS connections with\n\t\t\tviewers. The security policy determines two settings:

\n\t\t \n\t\t

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and\n\t\t\tCloudFront in the Amazon CloudFront Developer Guide.

\n\t\t \n\t\t\t

On the CloudFront console, this setting is called Security\n\t\t\t\tPolicy.

\n\t\t \n\t\t

When you’re using SNI only (you set SSLSupportMethod to sni-only),\n\t\t\tyou must specify TLSv1 or higher.

\n\t\t

If the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net (you set\n\t\t\tCloudFrontDefaultCertificate to true), CloudFront automatically sets\n\t\t\tthe security policy to TLSv1 regardless of the value that you set\n\t\t\there.

" + "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify the security policy that you want CloudFront to use for HTTPS connections with\n\t\t\tviewers. The security policy determines two settings:

\n \n

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and\n\t\t\t\tCloudFront in the Amazon CloudFront Developer Guide.

\n \n

On the CloudFront console, this setting is called Security\n\t\t\t\t\tPolicy.

\n \n

When you're using SNI only (you set SSLSupportMethod to\n\t\t\t\tsni-only), you must specify TLSv1 or higher.

\n

If the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net (you set\n\t\t\t\tCloudFrontDefaultCertificate to true), CloudFront automatically\n\t\t\tsets the security policy to TLSv1 regardless of the value that you set\n\t\t\there.

" } }, "Certificate": { "target": "com.amazonaws.cloudfront#string", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. Use one of the following fields instead:

\n\t\t " + "smithy.api#documentation": "

This field is deprecated. Use one of the following fields instead:

\n " } }, "CertificateSource": { "target": "com.amazonaws.cloudfront#CertificateSource", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. Use one of the following fields instead:

\n\t\t " + "smithy.api#documentation": "

This field is deprecated. Use one of the following fields instead:

\n " } } }, "traits": { - "smithy.api#documentation": "

A complex type that determines the distribution’s SSL/TLS configuration for communicating\n\t\t\twith viewers.

\n\t\t

If the distribution doesn’t use Aliases (also known as alternate domain\n\t\t\tnames or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as\n\t\t\td111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate\n\t\t\tto true and leave all other fields empty.

\n\t\t

If the distribution uses Aliases (alternate domain names or CNAMEs), use\n\t\t\tthe fields in this type to specify the following settings:

\n\t\t \n\t\t

All distributions support HTTPS connections from viewers. To require viewers to use\n\t\t\tHTTPS only, or to redirect them from HTTP to HTTPS, use\n\t\t\tViewerProtocolPolicy in the CacheBehavior or\n\t\t\tDefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to\n\t\t\tcommunicate with your custom origin, use CustomOriginConfig.

\n\t\t

For more information, see Using\n\t\t\tHTTPS with CloudFront and \n\t\t\tUsing Alternate Domain Names and HTTPS in the\n\t\t\tAmazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A complex type that determines the distribution's SSL/TLS configuration for\n\t\t\tcommunicating with viewers.

\n

If the distribution doesn't use Aliases (also known as alternate domain\n\t\t\tnames or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net—set\n\t\t\t\tCloudFrontDefaultCertificate to true and leave all other\n\t\t\tfields empty.

\n

If the distribution uses Aliases (alternate domain names or CNAMEs), use\n\t\t\tthe fields in this type to specify the following settings:

\n \n

All distributions support HTTPS connections from viewers. To require viewers to use\n\t\t\tHTTPS only, or to redirect them from HTTP to HTTPS, use\n\t\t\t\tViewerProtocolPolicy in the CacheBehavior or\n\t\t\t\tDefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to\n\t\t\tcommunicate with your custom origin, use CustomOriginConfig.

\n

For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the\n\t\t\t\tAmazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#ViewerProtocolPolicy": { diff --git a/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json b/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json index 6038f3a3759..9dd093830c3 100644 --- a/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json +++ b/codegen/sdk-codegen/aws-models/cloudtrail.2013-11-01.json @@ -235,7 +235,7 @@ "Field": { "target": "com.amazonaws.cloudtrail#SelectorField", "traits": { - "smithy.api#documentation": "

\n A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, \n eventSource (for management events), eventName, resources.type, and resources.ARN.\n

\n ", + "smithy.api#documentation": "

\n A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, \n eventSource (for management events), eventName, resources.type, and resources.ARN.\n

\n ", "smithy.api#required": {} } }, @@ -679,7 +679,7 @@ "name": "cloudtrail" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "CloudTrail\n

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

\n

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. \n The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

\n \n \n

As an alternative to the API,\n you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs\n provide programmatic access to CloudTrail. For example, the SDKs\n handle cryptographically signing requests, managing errors, and retrying requests\n automatically. For more information about the Amazon Web Services SDKs, including how to download and install\n them, see Tools to Build on Amazon Web Services.

\n \n

See the CloudTrail User \n Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

", + "smithy.api#documentation": "CloudTrail\n

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

\n

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. \n The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

\n \n

As an alternative to the API,\n you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs\n provide programmatic access to CloudTrail. For example, the SDKs\n handle cryptographically signing requests, managing errors, and retrying requests\n automatically. For more information about the Amazon Web Services SDKs, including how to download and install\n them, see Tools to Build on Amazon Web Services.

\n \n

See the CloudTrail User \n Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

", "smithy.api#title": "AWS CloudTrail", "smithy.api#xmlNamespace": { "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" @@ -689,7 +689,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -738,15 +738,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -922,12 +913,12 @@ { "ref": "Region" }, - "us-gov-west-1" + "us-gov-east-1" ] } ], "endpoint": { - "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", + "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", "properties": {}, "headers": {} }, @@ -941,12 +932,12 @@ { "ref": "Region" }, - "us-gov-east-1" + "us-gov-west-1" ] } ], "endpoint": { - "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", "properties": {}, "headers": {} }, @@ -1048,8 +1039,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-south-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-south-2" } }, { @@ -1061,8 +1052,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-south-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-south-2" } }, { @@ -1074,8 +1065,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-south-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-south-2" } }, { @@ -1087,8 +1078,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-south-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-south-2" } }, { @@ -1100,8 +1091,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-south-1" } }, { @@ -1113,8 +1104,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-south-1" } }, { @@ -1126,8 +1117,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-south-1" } }, { @@ -1139,8 +1130,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-south-1" } }, { @@ -1152,8 +1143,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-south-1" } }, { @@ -1165,8 +1156,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-south-1" } }, { @@ -1178,8 +1169,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-south-1" } }, { @@ -1191,8 +1182,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-south-1" } }, { @@ -1204,8 +1195,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-south-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-south-2" } }, { @@ -1217,8 +1208,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-south-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-south-2" } }, { @@ -1230,8 +1221,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-south-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-south-2" } }, { @@ -1243,8 +1234,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-south-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-south-2" } }, { @@ -1256,8 +1247,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { @@ -1269,8 +1260,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { @@ -1282,8 +1273,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { @@ -1295,8 +1286,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { @@ -1308,8 +1299,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-central-1" } }, { @@ -1321,8 +1312,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-central-1" } }, { @@ -1334,8 +1325,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-central-1" } }, { @@ -1347,8 +1338,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-central-1" } }, { @@ -1360,8 +1351,8 @@ }, "params": { "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ca-central-1" } }, { @@ -1373,8 +1364,8 @@ }, "params": { "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ca-central-1" } }, { @@ -1386,8 +1377,8 @@ }, "params": { "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ca-central-1" } }, { @@ -1399,8 +1390,8 @@ }, "params": { "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ca-central-1" } }, { @@ -1412,8 +1403,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -1425,8 +1416,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -1438,8 +1429,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -1451,8 +1442,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -1462,8 +1453,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-iso-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-iso-west-1" } }, { @@ -1475,8 +1466,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-iso-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-iso-west-1" } }, { @@ -1486,8 +1477,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-iso-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-iso-west-1" } }, { @@ -1499,8 +1490,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-iso-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-iso-west-1" } }, { @@ -1512,8 +1503,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-2" } }, { @@ -1525,8 +1516,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-2" } }, { @@ -1538,8 +1529,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-2" } }, { @@ -1551,8 +1542,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-2" } }, { @@ -1564,8 +1555,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-1" } }, { @@ -1577,8 +1568,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-1" } }, { @@ -1590,8 +1581,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-1" } }, { @@ -1603,8 +1594,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-1" } }, { @@ -1616,8 +1607,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -1629,8 +1620,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -1642,8 +1633,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -1655,8 +1646,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -1668,8 +1659,8 @@ }, "params": { "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "af-south-1" } }, { @@ -1681,8 +1672,8 @@ }, "params": { "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "af-south-1" } }, { @@ -1694,8 +1685,8 @@ }, "params": { "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "af-south-1" } }, { @@ -1707,8 +1698,8 @@ }, "params": { "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "af-south-1" } }, { @@ -1720,8 +1711,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-north-1" } }, { @@ -1733,8 +1724,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-north-1" } }, { @@ -1746,8 +1737,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-north-1" } }, { @@ -1759,8 +1750,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-north-1" } }, { @@ -1772,8 +1763,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-3" } }, { @@ -1785,8 +1776,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-3" } }, { @@ -1798,8 +1789,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-3" } }, { @@ -1811,8 +1802,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-3" } }, { @@ -1824,8 +1815,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-2" } }, { @@ -1837,8 +1828,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-2" } }, { @@ -1850,8 +1841,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-2" } }, { @@ -1863,8 +1854,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-2" } }, { @@ -1876,8 +1867,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-1" } }, { @@ -1889,8 +1880,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-1" } }, { @@ -1902,8 +1893,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-1" } }, { @@ -1915,8 +1906,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-1" } }, { @@ -1928,8 +1919,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-3" } }, { @@ -1941,8 +1932,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-3" } }, { @@ -1954,8 +1945,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-3" } }, { @@ -1967,8 +1958,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-3" } }, { @@ -1980,8 +1971,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-2" } }, { @@ -1993,8 +1984,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-2" } }, { @@ -2006,8 +1997,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-2" } }, { @@ -2019,8 +2010,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-2" } }, { @@ -2032,8 +2023,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-1" } }, { @@ -2045,8 +2036,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { @@ -2058,8 +2049,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-1" } }, { @@ -2071,8 +2062,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { @@ -2084,8 +2075,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-south-1" } }, { @@ -2097,8 +2088,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-south-1" } }, { @@ -2110,8 +2101,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-south-1" } }, { @@ -2123,8 +2114,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-south-1" } }, { @@ -2136,8 +2127,8 @@ }, "params": { "UseFIPS": true, - "Region": "sa-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "sa-east-1" } }, { @@ -2149,8 +2140,8 @@ }, "params": { "UseFIPS": true, - "Region": "sa-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "sa-east-1" } }, { @@ -2162,8 +2153,8 @@ }, "params": { "UseFIPS": false, - "Region": "sa-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "sa-east-1" } }, { @@ -2175,8 +2166,8 @@ }, "params": { "UseFIPS": false, - "Region": "sa-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "sa-east-1" } }, { @@ -2188,8 +2179,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-east-1" } }, { @@ -2201,8 +2192,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-east-1" } }, { @@ -2214,8 +2205,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-east-1" } }, { @@ -2227,8 +2218,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-east-1" } }, { @@ -2240,8 +2231,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-north-1" } }, { @@ -2253,8 +2244,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { @@ -2266,8 +2257,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-north-1" } }, { @@ -2279,8 +2270,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { @@ -2292,8 +2283,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-west-1" } }, { @@ -2305,8 +2296,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-west-1" } }, { @@ -2318,8 +2309,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-west-1" } }, { @@ -2331,8 +2322,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-west-1" } }, { @@ -2344,8 +2335,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -2357,8 +2348,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -2370,8 +2361,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -2383,8 +2374,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -2396,8 +2387,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -2409,8 +2400,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -2422,8 +2413,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -2435,8 +2426,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -2446,8 +2437,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-iso-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { @@ -2459,8 +2450,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-iso-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { @@ -2470,8 +2461,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-iso-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { @@ -2483,8 +2474,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-iso-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { @@ -2496,8 +2487,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-3" } }, { @@ -2509,8 +2500,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-3" } }, { @@ -2522,8 +2513,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-3" } }, { @@ -2535,8 +2526,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-3" } }, { @@ -2548,8 +2539,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-4", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-4" } }, { @@ -2561,8 +2552,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-4", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-4" } }, { @@ -2574,8 +2565,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-4", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-4" } }, { @@ -2587,8 +2578,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-4", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-4" } }, { @@ -2600,8 +2591,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -2613,8 +2604,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -2626,8 +2617,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -2639,8 +2630,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -2652,8 +2643,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-2" } }, { @@ -2665,8 +2656,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-2" } }, { @@ -2678,8 +2669,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-2" } }, { @@ -2691,8 +2682,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-2" } }, { @@ -2704,8 +2695,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-northwest-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-northwest-1" } }, { @@ -2717,8 +2708,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-northwest-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-northwest-1" } }, { @@ -2730,8 +2721,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-northwest-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-northwest-1" } }, { @@ -2743,8 +2734,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-northwest-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-northwest-1" } }, { @@ -2754,8 +2745,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-isob-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { @@ -2767,8 +2758,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-isob-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { @@ -2778,8 +2769,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-isob-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { @@ -2791,8 +2782,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-isob-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { @@ -2804,8 +2795,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -2816,8 +2807,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -2828,8 +2819,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -2905,6 +2896,9 @@ { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, { "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" }, @@ -3158,6 +3152,9 @@ { "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" }, + { + "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + }, { "target": "com.amazonaws.cloudtrail#TrailAlreadyExistsException" }, @@ -3345,13 +3342,13 @@ "Type": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify\n the following basic event selector resource types:

\n \n\n

The following resource types are also available through advanced event selectors.\n Basic event selector resource types are valid in advanced event selectors, but\n advanced event selector resource types are not valid in basic event selectors.\n For more information, see AdvancedFieldSelector$Field.

\n " + "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify\n the following basic event selector resource types:

\n \n

The following resource types are also available through advanced event selectors.\n Basic event selector resource types are valid in advanced event selectors, but\n advanced event selector resource types are not valid in basic event selectors.\n For more information, see AdvancedFieldSelector$Field.

\n " } }, "Values": { "target": "com.amazonaws.cloudtrail#DataResourceValues", "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

\n " + "smithy.api#documentation": "

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

\n " } } }, @@ -3415,6 +3412,9 @@ { "target": "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException" }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, @@ -3463,6 +3463,9 @@ "target": "com.amazonaws.cloudtrail#DeleteTrailResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#ConflictException" }, @@ -3794,7 +3797,7 @@ "trailNameList": { "target": "com.amazonaws.cloudtrail#TrailNameList", "traits": { - "smithy.api#documentation": "

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n \n

If an empty list is specified, information for the trail in the current region is returned.

\n \n \n

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.

\n " + "smithy.api#documentation": "

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

If an empty list is specified, information for the trail in the current region is returned.

\n \n \n

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.

\n " } }, "includeShadowTrails": { @@ -4239,7 +4242,7 @@ "IncludeManagementEvents": { "target": "com.amazonaws.cloudtrail#Boolean", "traits": { - "smithy.api#documentation": "

Specify if you want your event selector to include management events for your trail.

\n

\n For more information, see Management Events in the CloudTrail User Guide.

\n \n

By default, the value is true.

\n

The first copy of management events is free. You are charged for additional copies of management \n events that you are logging on any subsequent trail in the same region. For more information about \n CloudTrail pricing, see CloudTrail Pricing.

" + "smithy.api#documentation": "

Specify if you want your event selector to include management events for your trail.

\n

\n For more information, see Management Events in the CloudTrail User Guide.

\n

By default, the value is true.

\n

The first copy of management events is free. You are charged for additional copies of management \n events that you are logging on any subsequent trail in the same region. For more information about \n CloudTrail pricing, see CloudTrail Pricing.

" } }, "DataResources": { @@ -4476,6 +4479,9 @@ "target": "com.amazonaws.cloudtrail#GetEventSelectorsResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, @@ -4493,7 +4499,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the settings for the event selectors that you configured for your trail.\n The information returned for your event selectors includes the following:

\n \n

For more information about logging management and data events, see the following topics in the CloudTrail User Guide:

\n ", + "smithy.api#documentation": "

Describes the settings for the event selectors that you configured for your trail.\n The information returned for your event selectors includes the following:

\n \n

For more information about logging management and data events, see the following topics in the CloudTrail User Guide:

\n ", "smithy.api#idempotent": {} } }, @@ -4638,6 +4644,9 @@ "target": "com.amazonaws.cloudtrail#GetInsightSelectorsResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InsightNotEnabledException" }, @@ -4819,6 +4828,9 @@ "target": "com.amazonaws.cloudtrail#GetTrailResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, @@ -4866,6 +4878,9 @@ "target": "com.amazonaws.cloudtrail#GetTrailStatusResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" }, @@ -4890,7 +4905,7 @@ "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a \n shadow trail (a replication of the trail in another region), you must specify its ARN. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a \n shadow trail (a replication of the trail in another region), you must specify its ARN. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", "smithy.api#required": {} } } @@ -6670,7 +6685,7 @@ } }, "AttributeValue": { - "target": "com.amazonaws.cloudtrail#String", + "target": "com.amazonaws.cloudtrail#LookupAttributeValue", "traits": { "smithy.api#documentation": "

Specifies a value for the specified AttributeKey.

", "smithy.api#required": {} @@ -6734,6 +6749,15 @@ } } }, + "com.amazonaws.cloudtrail#LookupAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, "com.amazonaws.cloudtrail#LookupAttributesList": { "type": "list", "member": { @@ -7105,6 +7129,9 @@ "target": "com.amazonaws.cloudtrail#PutEventSelectorsResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, @@ -7194,6 +7221,9 @@ "target": "com.amazonaws.cloudtrail#PutInsightSelectorsResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, @@ -8128,6 +8158,9 @@ "target": "com.amazonaws.cloudtrail#StartLoggingResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, @@ -8164,7 +8197,7 @@ "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. \n The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. \n The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", "smithy.api#required": {} } } @@ -8372,6 +8405,9 @@ "target": "com.amazonaws.cloudtrail#StopLoggingResponse" }, "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, @@ -8408,7 +8444,7 @@ "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services \n API calls. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services \n API calls. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", "smithy.api#required": {} } } @@ -8533,7 +8569,7 @@ "SnsTopicARN": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications\n when log files are delivered. The following is the format of a topic ARN.

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications\n when log files are delivered. The following is the format of a topic ARN.

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" } }, "IncludeGlobalServiceEvents": { @@ -8771,6 +8807,9 @@ { "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, { "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" }, @@ -8944,6 +8983,9 @@ { "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, { "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" }, @@ -9043,7 +9085,7 @@ "Name": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If Name is a trail name, the\n string must meet the following requirements:

\n \n

If Name is a trail ARN, it must be in the following format.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If Name is a trail name, the\n string must meet the following requirements:

\n \n

If Name is a trail ARN, it must be in the following format.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", "smithy.api#required": {} } }, @@ -9185,7 +9227,7 @@ "KmsKeyId": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

\n \n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" } }, "IsOrganizationTrail": { diff --git a/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json b/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json index 4bcbd0a7255..68958601e7b 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch-logs.2014-03-28.json @@ -297,7 +297,7 @@ "tags": { "target": "com.amazonaws.cloudwatchlogs#Tags", "traits": { - "smithy.api#documentation": "

The key-value pairs to use for the tags.

\n

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified\n tags to log groups using the aws:Resource/key-name\n or\n aws:TagKeys condition keys. For more information about using tags to control\n access, see Controlling access to Amazon Web Services resources using tags.

" + "smithy.api#documentation": "

The key-value pairs to use for the tags.

\n

You can grant users access to certain log groups while preventing them from accessing other log groups.\n To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when \n you create a log group, you must have either the logs:TagResource or logs:TagLogGroup\n permission. For more information about tagging, see \n Tagging Amazon Web Services resources.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.

" } } } @@ -2987,15 +2987,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -3296,9 +3287,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-south-2", - "UseFIPS": true + "Region": "ap-south-2" } }, { @@ -3309,9 +3300,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-south-2", - "UseFIPS": true + "Region": "ap-south-2" } }, { @@ -3322,9 +3313,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-south-2", - "UseFIPS": false + "Region": "ap-south-2" } }, { @@ -3335,9 +3326,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-south-2", - "UseFIPS": false + "Region": "ap-south-2" } }, { @@ -3348,9 +3339,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-south-1", - "UseFIPS": true + "Region": "ap-south-1" } }, { @@ -3361,9 +3352,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-south-1", - "UseFIPS": true + "Region": "ap-south-1" } }, { @@ -3374,9 +3365,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-south-1", - "UseFIPS": false + "Region": "ap-south-1" } }, { @@ -3387,9 +3378,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-south-1", - "UseFIPS": false + "Region": "ap-south-1" } }, { @@ -3400,9 +3391,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "eu-south-1", - "UseFIPS": true + "Region": "eu-south-1" } }, { @@ -3413,9 +3404,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-south-1", - "UseFIPS": true + "Region": "eu-south-1" } }, { @@ -3426,9 +3417,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "eu-south-1", - "UseFIPS": false + "Region": "eu-south-1" } }, { @@ -3439,9 +3430,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-south-1", - "UseFIPS": false + "Region": "eu-south-1" } }, { @@ -3452,9 +3443,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "eu-south-2", - "UseFIPS": true + "Region": "eu-south-2" } }, { @@ -3465,9 +3456,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-south-2", - "UseFIPS": true + "Region": "eu-south-2" } }, { @@ -3478,9 +3469,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "eu-south-2", - "UseFIPS": false + "Region": "eu-south-2" } }, { @@ -3491,9 +3482,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-south-2", - "UseFIPS": false + "Region": "eu-south-2" } }, { @@ -3504,9 +3495,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": true + "Region": "us-gov-east-1" } }, { @@ -3517,9 +3508,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": true + "Region": "us-gov-east-1" } }, { @@ -3530,9 +3521,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": false + "Region": "us-gov-east-1" } }, { @@ -3543,9 +3534,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": false + "Region": "us-gov-east-1" } }, { @@ -3556,9 +3547,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "me-central-1", - "UseFIPS": true + "Region": "me-central-1" } }, { @@ -3569,9 +3560,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "me-central-1", - "UseFIPS": true + "Region": "me-central-1" } }, { @@ -3582,9 +3573,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "me-central-1", - "UseFIPS": false + "Region": "me-central-1" } }, { @@ -3595,9 +3586,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "me-central-1", - "UseFIPS": false + "Region": "me-central-1" } }, { @@ -3608,9 +3599,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ca-central-1", - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -3621,9 +3612,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ca-central-1", - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -3634,9 +3625,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ca-central-1", - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -3647,9 +3638,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ca-central-1", - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -3660,9 +3651,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "eu-central-1", - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -3673,9 +3664,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-central-1", - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -3686,9 +3677,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "eu-central-1", - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -3699,9 +3690,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-central-1", - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -3710,9 +3701,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-iso-west-1", - "UseFIPS": true + "Region": "us-iso-west-1" } }, { @@ -3723,9 +3714,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-iso-west-1", - "UseFIPS": true + "Region": "us-iso-west-1" } }, { @@ -3734,9 +3725,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-iso-west-1", - "UseFIPS": false + "Region": "us-iso-west-1" } }, { @@ -3747,9 +3738,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-iso-west-1", - "UseFIPS": false + "Region": "us-iso-west-1" } }, { @@ -3760,9 +3751,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "eu-central-2", - "UseFIPS": true + "Region": "eu-central-2" } }, { @@ -3773,9 +3764,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-central-2", - "UseFIPS": true + "Region": "eu-central-2" } }, { @@ -3786,9 +3777,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "eu-central-2", - "UseFIPS": false + "Region": "eu-central-2" } }, { @@ -3799,9 +3790,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-central-2", - "UseFIPS": false + "Region": "eu-central-2" } }, { @@ -3812,9 +3803,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-west-1", - "UseFIPS": true + "Region": "us-west-1" } }, { @@ -3825,9 +3816,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-west-1", - "UseFIPS": true + "Region": "us-west-1" } }, { @@ -3838,9 +3829,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-west-1", - "UseFIPS": false + "Region": "us-west-1" } }, { @@ -3851,9 +3842,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-west-1", - "UseFIPS": false + "Region": "us-west-1" } }, { @@ -3864,9 +3855,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-west-2", - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -3877,9 +3868,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-west-2", - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -3890,9 +3881,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-west-2", - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -3903,9 +3894,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-west-2", - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -3916,9 +3907,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "af-south-1", - "UseFIPS": true + "Region": "af-south-1" } }, { @@ -3929,9 +3920,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "af-south-1", - "UseFIPS": true + "Region": "af-south-1" } }, { @@ -3942,9 +3933,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "af-south-1", - "UseFIPS": false + "Region": "af-south-1" } }, { @@ -3955,9 +3946,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "af-south-1", - "UseFIPS": false + "Region": "af-south-1" } }, { @@ -3968,9 +3959,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "eu-north-1", - "UseFIPS": true + "Region": "eu-north-1" } }, { @@ -3981,9 +3972,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-north-1", - "UseFIPS": true + "Region": "eu-north-1" } }, { @@ -3994,9 +3985,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "eu-north-1", - "UseFIPS": false + "Region": "eu-north-1" } }, { @@ -4007,9 +3998,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-north-1", - "UseFIPS": false + "Region": "eu-north-1" } }, { @@ -4020,9 +4011,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "eu-west-3", - "UseFIPS": true + "Region": "eu-west-3" } }, { @@ -4033,9 +4024,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-west-3", - "UseFIPS": true + "Region": "eu-west-3" } }, { @@ -4046,9 +4037,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "eu-west-3", - "UseFIPS": false + "Region": "eu-west-3" } }, { @@ -4059,9 +4050,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-west-3", - "UseFIPS": false + "Region": "eu-west-3" } }, { @@ -4072,9 +4063,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "eu-west-2", - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -4085,9 +4076,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-west-2", - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -4098,9 +4089,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "eu-west-2", - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -4111,9 +4102,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-west-2", - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -4124,9 +4115,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "eu-west-1", - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -4137,9 +4128,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "eu-west-1", - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -4150,9 +4141,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "eu-west-1", - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -4163,9 +4154,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "eu-west-1", - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -4176,9 +4167,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-northeast-3", - "UseFIPS": true + "Region": "ap-northeast-3" } }, { @@ -4189,9 +4180,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-northeast-3", - "UseFIPS": true + "Region": "ap-northeast-3" } }, { @@ -4202,9 +4193,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-northeast-3", - "UseFIPS": false + "Region": "ap-northeast-3" } }, { @@ -4215,9 +4206,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-northeast-3", - "UseFIPS": false + "Region": "ap-northeast-3" } }, { @@ -4228,9 +4219,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-northeast-2", - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -4241,9 +4232,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-northeast-2", - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -4254,9 +4245,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-northeast-2", - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -4267,9 +4258,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-northeast-2", - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -4280,9 +4271,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-northeast-1", - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -4293,9 +4284,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-northeast-1", - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -4306,9 +4297,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-northeast-1", - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -4319,9 +4310,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-northeast-1", - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -4332,9 +4323,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "me-south-1", - "UseFIPS": true + "Region": "me-south-1" } }, { @@ -4345,9 +4336,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "me-south-1", - "UseFIPS": true + "Region": "me-south-1" } }, { @@ -4358,9 +4349,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "me-south-1", - "UseFIPS": false + "Region": "me-south-1" } }, { @@ -4371,9 +4362,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "me-south-1", - "UseFIPS": false + "Region": "me-south-1" } }, { @@ -4384,9 +4375,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "sa-east-1", - "UseFIPS": true + "Region": "sa-east-1" } }, { @@ -4397,9 +4388,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "sa-east-1", - "UseFIPS": true + "Region": "sa-east-1" } }, { @@ -4410,9 +4401,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "sa-east-1", - "UseFIPS": false + "Region": "sa-east-1" } }, { @@ -4423,9 +4414,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "sa-east-1", - "UseFIPS": false + "Region": "sa-east-1" } }, { @@ -4436,9 +4427,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-east-1", - "UseFIPS": true + "Region": "ap-east-1" } }, { @@ -4449,9 +4440,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-east-1", - "UseFIPS": true + "Region": "ap-east-1" } }, { @@ -4462,9 +4453,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-east-1", - "UseFIPS": false + "Region": "ap-east-1" } }, { @@ -4475,9 +4466,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-east-1", - "UseFIPS": false + "Region": "ap-east-1" } }, { @@ -4488,9 +4479,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "cn-north-1", - "UseFIPS": true + "Region": "cn-north-1" } }, { @@ -4501,9 +4492,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "cn-north-1", - "UseFIPS": true + "Region": "cn-north-1" } }, { @@ -4514,9 +4505,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "cn-north-1", - "UseFIPS": false + "Region": "cn-north-1" } }, { @@ -4527,9 +4518,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "cn-north-1", - "UseFIPS": false + "Region": "cn-north-1" } }, { @@ -4540,9 +4531,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-gov-west-1", - "UseFIPS": true + "Region": "us-gov-west-1" } }, { @@ -4553,9 +4544,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-gov-west-1", - "UseFIPS": true + "Region": "us-gov-west-1" } }, { @@ -4566,9 +4557,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-gov-west-1", - "UseFIPS": false + "Region": "us-gov-west-1" } }, { @@ -4579,9 +4570,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-gov-west-1", - "UseFIPS": false + "Region": "us-gov-west-1" } }, { @@ -4592,9 +4583,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-southeast-1", - "UseFIPS": true + "Region": "ap-southeast-1" } }, { @@ -4605,9 +4596,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-southeast-1", - "UseFIPS": true + "Region": "ap-southeast-1" } }, { @@ -4618,9 +4609,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-southeast-1", - "UseFIPS": false + "Region": "ap-southeast-1" } }, { @@ -4631,9 +4622,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-1", - "UseFIPS": false + "Region": "ap-southeast-1" } }, { @@ -4644,9 +4635,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-southeast-2", - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -4657,9 +4648,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-southeast-2", - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -4670,9 +4661,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-southeast-2", - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -4683,9 +4674,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-2", - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -4694,9 +4685,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": true + "Region": "us-iso-east-1" } }, { @@ -4707,9 +4698,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": true + "Region": "us-iso-east-1" } }, { @@ -4718,9 +4709,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": false + "Region": "us-iso-east-1" } }, { @@ -4731,9 +4722,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": false + "Region": "us-iso-east-1" } }, { @@ -4744,9 +4735,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-southeast-3", - "UseFIPS": true + "Region": "ap-southeast-3" } }, { @@ -4757,9 +4748,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-southeast-3", - "UseFIPS": true + "Region": "ap-southeast-3" } }, { @@ -4770,9 +4761,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-southeast-3", - "UseFIPS": false + "Region": "ap-southeast-3" } }, { @@ -4783,9 +4774,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-3", - "UseFIPS": false + "Region": "ap-southeast-3" } }, { @@ -4796,9 +4787,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "ap-southeast-4", - "UseFIPS": true + "Region": "ap-southeast-4" } }, { @@ -4809,9 +4800,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "ap-southeast-4", - "UseFIPS": true + "Region": "ap-southeast-4" } }, { @@ -4822,9 +4813,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "ap-southeast-4", - "UseFIPS": false + "Region": "ap-southeast-4" } }, { @@ -4835,9 +4826,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "ap-southeast-4", - "UseFIPS": false + "Region": "ap-southeast-4" } }, { @@ -4848,9 +4839,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -4861,9 +4852,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -4874,9 +4865,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -4887,9 +4878,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -4900,9 +4891,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-east-2", - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -4913,9 +4904,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-2", - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -4926,9 +4917,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-2", - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -4939,9 +4930,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-2", - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -4952,9 +4943,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "cn-northwest-1", - "UseFIPS": true + "Region": "cn-northwest-1" } }, { @@ -4965,9 +4956,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "cn-northwest-1", - "UseFIPS": true + "Region": "cn-northwest-1" } }, { @@ -4978,9 +4969,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "cn-northwest-1", - "UseFIPS": false + "Region": "cn-northwest-1" } }, { @@ -4991,9 +4982,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "cn-northwest-1", - "UseFIPS": false + "Region": "cn-northwest-1" } }, { @@ -5002,9 +4993,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "UseFIPS": true, "UseDualStack": true, - "Region": "us-isob-east-1", - "UseFIPS": true + "Region": "us-isob-east-1" } }, { @@ -5015,9 +5006,9 @@ } }, "params": { + "UseFIPS": true, "UseDualStack": false, - "Region": "us-isob-east-1", - "UseFIPS": true + "Region": "us-isob-east-1" } }, { @@ -5026,9 +5017,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "UseFIPS": false, "UseDualStack": true, - "Region": "us-isob-east-1", - "UseFIPS": false + "Region": "us-isob-east-1" } }, { @@ -5039,9 +5030,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, - "Region": "us-isob-east-1", - "UseFIPS": false + "Region": "us-isob-east-1" } }, { @@ -5052,9 +5043,9 @@ } }, "params": { + "UseFIPS": false, "UseDualStack": false, "Region": "us-east-1", - "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -5064,9 +5055,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseFIPS": true, "UseDualStack": false, "Region": "us-east-1", - "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -5076,9 +5067,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseFIPS": false, "UseDualStack": true, "Region": "us-east-1", - "UseFIPS": false, "Endpoint": "https://example.com" } } diff --git a/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json b/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json index f8739e1c446..78af32f5a7c 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch.2010-08-01.json @@ -301,7 +301,7 @@ "MetricTimezone": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone", "traits": { - "smithy.api#documentation": "

The time zone to use for the metric. This is useful to enable the model to automatically\n\t\t\taccount for daylight savings time changes if the metric is sensitive to such time\n\t\t\tchanges.

\n\t\t

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, \n\t\t\tsee tz database.

" + "smithy.api#documentation": "

The time zone to use for the metric. This is useful to enable the model to automatically\n\t\t\taccount for daylight savings time changes if the metric is sensitive to such time\n\t\t\tchanges.

\n

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, \n\t\t\tsee tz database.

" } } }, @@ -557,13 +557,13 @@ "ActionsSuppressorWaitPeriod": { "target": "com.amazonaws.cloudwatch#SuppressorPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n\t\t \n\t\t\t

\n\t\t\t\t WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n \n

\n WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n " } }, "ActionsSuppressorExtensionPeriod": { "target": "com.amazonaws.cloudwatch#SuppressorPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n\t\t \n\t\t\t

\n\t\t\t\t ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n \n

\n ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n " } } }, @@ -828,7 +828,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more\n\t\t\tthan one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't\n\t\t\tdelete two composite alarms with one operation.

\n\t\t

\n\t\t\tIn the event of an error, no alarms are\n\t\t\tdeleted.

\n\t\t \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n\t\t\t

To get out of such a situation, you must\n\t\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to false.

\n\t\t\t

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t\t

\n " + "smithy.api#documentation": "

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more\n\t\t\tthan one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't\n\t\t\tdelete two composite alarms with one operation.

\n

\n\t\t\tIn the event of an error, no alarms are\n\t\t\tdeleted.

\n \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n

To get out of such a situation, you must\n\t\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to false.

\n

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t\t

\n " } }, "com.amazonaws.cloudwatch#DeleteAlarmsInput": { @@ -914,13 +914,13 @@ "SingleMetricAnomalyDetector": { "target": "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector", "traits": { - "smithy.api#documentation": "

A single metric anomaly detector to be deleted.

\n\t\t

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the single metric anomaly detector attributes \n\t\t\tas part of the SingleMetricAnomalyDetector property.

" + "smithy.api#documentation": "

A single metric anomaly detector to be deleted.

\n

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n \n

Instead, specify the single metric anomaly detector attributes \n\t\t\tas part of the SingleMetricAnomalyDetector property.

" } }, "MetricMathAnomalyDetector": { "target": "com.amazonaws.cloudwatch#MetricMathAnomalyDetector", "traits": { - "smithy.api#documentation": "

The metric math anomaly detector to be deleted.

\n\t\t

When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the metric math anomaly detector attributes as part of the\n\t\t\tMetricMathAnomalyDetector property.

" + "smithy.api#documentation": "

The metric math anomaly detector to be deleted.

\n

When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:

\n \n

Instead, specify the metric math anomaly detector attributes as part of the\n\t\t\tMetricMathAnomalyDetector property.

" } } } @@ -985,7 +985,7 @@ } ], "traits": { - "smithy.api#documentation": "

Permanently deletes the specified Contributor Insights rules.

\n\t\t

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might\n\t\t\tnot be available.

" + "smithy.api#documentation": "

Permanently deletes the specified Contributor Insights rules.

\n

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might\n\t\t\tnot be available.

" } }, "com.amazonaws.cloudwatch#DeleteInsightRulesInput": { @@ -1064,7 +1064,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type.\n\t\t\tIf an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

\n\t\t

CloudWatch retains the history of an alarm even if you delete the alarm.

\n\t\t

To use this operation and return information about a composite alarm, you must be signed on with \n\t\t\tthe cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

", + "smithy.api#documentation": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type.\n\t\t\tIf an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

\n

CloudWatch retains the history of an alarm even if you delete the alarm.

\n

To use this operation and return information about a composite alarm, you must be signed on with \n\t\t\tthe cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1157,7 +1157,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm\n\t\t\tname, the alarm state, or a prefix for any action.

\n\t\t

To use this operation and return information about composite alarms, you must be signed on with \n\t\tthe cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

", + "smithy.api#documentation": "

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm\n\t\t\tname, the alarm state, or a prefix for any action.

\n

To use this operation and return information about composite alarms, you must be signed on with \n\t\tthe cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1206,7 +1206,7 @@ "target": "com.amazonaws.cloudwatch#DescribeAlarmsForMetricOutput" }, "traits": { - "smithy.api#documentation": "

Retrieves the alarms for the specified metric. To\n\t\t\tfilter the results, specify a statistic, period, or unit.

\n\t\t

This operation retrieves only standard alarms that are based on\n\t\tthe specified metric. It does not return alarms based on math expressions that\n\t\tuse the specified metric, or composite alarms that use the specified metric.

" + "smithy.api#documentation": "

Retrieves the alarms for the specified metric. To\n\t\t\tfilter the results, specify a statistic, period, or unit.

\n

This operation retrieves only standard alarms that are based on\n\t\tthe specified metric. It does not return alarms based on math expressions that\n\t\tuse the specified metric, or composite alarms that use the specified metric.

" } }, "com.amazonaws.cloudwatch#DescribeAlarmsForMetricInput": { @@ -1281,7 +1281,7 @@ "AlarmNamePrefix": { "target": "com.amazonaws.cloudwatch#AlarmNamePrefix", "traits": { - "smithy.api#documentation": "

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names\n\t\t\tthat start with this prefix.

\n\t\t

If this parameter\n\t\t\tis specified, you cannot specify AlarmNames.

" + "smithy.api#documentation": "

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names\n\t\t\tthat start with this prefix.

\n

If this parameter\n\t\t\tis specified, you cannot specify AlarmNames.

" } }, "AlarmTypes": { @@ -1293,13 +1293,13 @@ "ChildrenOfAlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { - "smithy.api#documentation": "

If you use this parameter and specify the name of a composite alarm, the operation returns \n\t\t\tinformation about the \"children\" alarms\n\t\t\tof the alarm you specify. These are the metric alarms and composite alarms referenced in the \n\t\t\tAlarmRule field of the composite alarm that you specify in \n\t\t\tChildrenOfAlarmName. Information about the composite alarm that you name in \n\t\t\tChildrenOfAlarmName is not returned.

\n\t\t

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you\n\t\t\treceive a validation\n\t\t\terror.

\n\t\t \n

Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp \n\t\t\tinformation are returned by this operation \n\t\t\twhen you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " + "smithy.api#documentation": "

If you use this parameter and specify the name of a composite alarm, the operation returns \n\t\t\tinformation about the \"children\" alarms\n\t\t\tof the alarm you specify. These are the metric alarms and composite alarms referenced in the \n\t\t\tAlarmRule field of the composite alarm that you specify in \n\t\t\tChildrenOfAlarmName. Information about the composite alarm that you name in \n\t\t\tChildrenOfAlarmName is not returned.

\n

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you\n\t\t\treceive a validation\n\t\t\terror.

\n \n

Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp \n\t\t\tinformation are returned by this operation \n\t\t\twhen you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " } }, "ParentsOfAlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { - "smithy.api#documentation": "

If you use this parameter and specify the name of a metric or composite alarm, the operation returns \n\t\t\tinformation about the \"parent\" alarms\n\t\t\tof the alarm you specify. These are the composite alarms that have AlarmRule\n\t\t\tparameters that reference \n\t\t\tthe alarm named in ParentsOfAlarmName. Information about the alarm that you specify in\n\t\t\tParentsOfAlarmName is not returned.

\n\t\t

If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you receive a validation\n\t\t\terror.

\n\t\t \n

Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " + "smithy.api#documentation": "

If you use this parameter and specify the name of a metric or composite alarm, the operation returns \n\t\t\tinformation about the \"parent\" alarms\n\t\t\tof the alarm you specify. These are the composite alarms that have AlarmRule\n\t\t\tparameters that reference \n\t\t\tthe alarm named in ParentsOfAlarmName. Information about the alarm that you specify in\n\t\t\tParentsOfAlarmName is not returned.

\n

If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you receive a validation\n\t\t\terror.

\n \n

Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " } }, "StateValue": { @@ -1395,7 +1395,7 @@ "MaxResults": { "target": "com.amazonaws.cloudwatch#MaxReturnedResultsCount", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in one operation. The maximum\n\t\t\tvalue that you can specify is 100.

\n\t\t\t

To retrieve the remaining results, make another call with the returned \n\t\t\tNextToken value.

" + "smithy.api#documentation": "

The maximum number of results to return in one operation. The maximum\n\t\t\tvalue that you can specify is 100.

\n

To retrieve the remaining results, make another call with the returned \n\t\t\tNextToken value.

" } }, "Namespace": { @@ -1455,7 +1455,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all the Contributor Insights rules in your account.

\n\t\t\n\t\t

For more information about Contributor Insights, see \n\t\tUsing Contributor Insights to Analyze High-Cardinality Data.

", + "smithy.api#documentation": "

Returns a list of all the Contributor Insights rules in your account.

\n

For more information about Contributor Insights, see \n\t\tUsing Contributor Insights to Analyze High-Cardinality Data.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1516,7 +1516,7 @@ } }, "traits": { - "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n\t\t

You \n\t\tcan assign up to 30 dimensions to a metric.

" + "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n

You \n\t\tcan assign up to 30 dimensions to a metric.

" } }, "com.amazonaws.cloudwatch#DimensionFilter": { @@ -1745,6 +1745,17 @@ } } }, + "com.amazonaws.cloudwatch#EvaluationState": { + "type": "enum", + "members": { + "PARTIAL_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL_DATA" + } + } + } + }, "com.amazonaws.cloudwatch#ExceptionType": { "type": "string" }, @@ -1795,7 +1806,7 @@ } ], "traits": { - "smithy.api#documentation": "

Displays the details of the dashboard that you specify.

\n\t\t

To copy an existing dashboard, use GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard to create\n\t\t\tthe copy.

" + "smithy.api#documentation": "

Displays the details of the dashboard that you specify.

\n

To copy an existing dashboard, use GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard to create\n\t\t\tthe copy.

" } }, "com.amazonaws.cloudwatch#GetDashboardInput": { @@ -1853,7 +1864,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of \n\t\tcontributors to the log group.

\n\t\t

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

\n\t\t " + "smithy.api#documentation": "

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of \n\t\tcontributors to the log group.

\n

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

\n " } }, "com.amazonaws.cloudwatch#GetInsightRuleReportInput": { @@ -1896,7 +1907,7 @@ "Metrics": { "target": "com.amazonaws.cloudwatch#InsightRuleMetricList", "traits": { - "smithy.api#documentation": "

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more\n\t\tof the following metrics:

\n\t\t " + "smithy.api#documentation": "

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more\n\t\tof the following metrics:

\n " } }, "OrderBy": { @@ -1962,7 +1973,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can use the GetMetricData API to retrieve CloudWatch metric values. The operation \n\t\t\tcan also include a CloudWatch Metrics Insights query, and one or more metric math functions.

\n\t\t

A GetMetricData operation that does not include a query can retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform metric math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\t\tGuide.

\n\t\t\n\t\t\t\t\n\t\t

If you include a Metrics Insights query, each GetMetricData operation can include only one\n\t\t\tquery. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries\n\t\tcan query only the most recent three hours of metric data. For more information about Metrics Insights, \n\t\tsee Query your metrics with CloudWatch Metrics Insights.

\n\t\t\n\t\t

Calls to the GetMetricData API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.

\n\n\t\t

Amazon CloudWatch retains metric data as follows:

\n\t\t \n\t\t

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.

\n\t\t\n\t\t

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

\n\t\n\t\t

\n Using Metrics Insights queries with metric math\n

\n\t\t

You can't mix a Metric Insights query and metric math syntax in the same expression, but \n\t\t\tyou can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights \n\t\t\tquery without a GROUP BY clause returns a single time-series (TS), \n\t\t\tand can be used as input for a metric math expression that expects a single time series. A Metrics Insights \n\t\t\tquery with a GROUP BY clause returns an array of time-series (TS[]), \n\t\t\tand can be used as input for a metric math expression that expects an array of time series.

", + "smithy.api#documentation": "

You can use the GetMetricData API to retrieve CloudWatch metric values. The operation \n\t\t\tcan also include a CloudWatch Metrics Insights query, and one or more metric math functions.

\n

A GetMetricData operation that does not include a query can retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform metric math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\t\tGuide.

\n

If you include a Metrics Insights query, each GetMetricData operation can include only one\n\t\t\tquery. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries\n\t\tcan query only the most recent three hours of metric data. For more information about Metrics Insights, \n\t\tsee Query your metrics with CloudWatch Metrics Insights.

\n

Calls to the GetMetricData API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.

\n

Amazon CloudWatch retains metric data as follows:

\n \n

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.

\n

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

\n

\n Using Metrics Insights queries with metric math\n

\n

You can't mix a Metric Insights query and metric math syntax in the same expression, but \n\t\t\tyou can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights \n\t\t\tquery without a GROUP BY clause returns a single time-series (TS), \n\t\t\tand can be used as input for a metric math expression that expects a single time series. A Metrics Insights \n\t\t\tquery with a GROUP BY clause returns an array of time-series (TS[]), \n\t\t\tand can be used as input for a metric math expression that expects an array of time series.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1976,21 +1987,21 @@ "MetricDataQueries": { "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,\n\t\tor a math expression to perform on retrieved data.

", + "smithy.api#documentation": "

The metric queries to be returned. A single GetMetricData call can \n\t\t\tinclude as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,\n\t\tor a math expression to perform on retrieved data.

", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp indicating the earliest data to be returned.

\n\t\t

The value specified is inclusive; results include data points with the specified time stamp.

\n\t\t

CloudWatch rounds the specified time stamp as follows:

\n\t\t \n\t\t

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

\n\t\t

For better performance, specify StartTime and EndTime\n\t\tvalues that align with the value of the metric's Period and sync up with\n\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\tis 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the StartTime.

", + "smithy.api#documentation": "

The time stamp indicating the earliest data to be returned.

\n

The value specified is inclusive; results include data points with the specified time stamp.

\n

CloudWatch rounds the specified time stamp as follows:

\n \n

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

\n

For better performance, specify StartTime and EndTime\n\t\tvalues that align with the value of the metric's Period and sync up with\n\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\tis 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the StartTime.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp indicating the latest data to be returned.

\n\t\t

The value specified is exclusive; results include data points up to the specified time stamp.

\n\t\t

For better performance, specify StartTime and EndTime\n\t\t\tvalues that align with the value of the metric's Period and sync up with\n\t\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\t\tis 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the EndTime.

", + "smithy.api#documentation": "

The time stamp indicating the latest data to be returned.

\n

The value specified is exclusive; results include data points up to the specified time stamp.

\n

For better performance, specify StartTime and EndTime\n\t\t\tvalues that align with the value of the metric's Period and sync up with\n\t\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\t\tis 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the EndTime.

", "smithy.api#required": {} } }, @@ -2044,7 +2055,7 @@ "Messages": { "target": "com.amazonaws.cloudwatch#MetricDataResultMessages", "traits": { - "smithy.api#documentation": "

Contains a message about this GetMetricData operation, if the operation results in such a message.\n\t\t\tAn example of a message that\n\t\t\tmight be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the\n\t\t\toperation as possible is still executed.

\n\t\t

A message appears here only if it is related to the global GetMetricData operation. Any message\n\t\t\tabout a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

" + "smithy.api#documentation": "

Contains a message about this GetMetricData operation, if the operation results in such a message.\n\t\t\tAn example of a message that\n\t\t\tmight be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the\n\t\t\toperation as possible is still executed.

\n

A message appears here only if it is related to the global GetMetricData operation. Any message\n\t\t\tabout a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

" } } } @@ -2072,7 +2083,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets statistics for the specified metric.

\n\n\n\n\t\t

The maximum number of data points returned from a single call is 1,440. If \n\t\t\tyou request more than 1,440 data points, CloudWatch returns an error. \n\t\t\tTo reduce the number of data points, you can narrow the specified time range and make \n\t\t\tmultiple requests across adjacent time ranges, or you can increase the specified period. \n\t\t\tData points are not returned in chronological order.

\n\n\t\t

CloudWatch aggregates data points based on the length of the period\n\t\t\tthat you specify. For example, if you request statistics with a one-hour period, \n\t\t\tCloudWatch aggregates all data points with time stamps that fall within each \n\t\t\tone-hour period. Therefore, the number of values aggregated by CloudWatch is larger than\n\t\t\tthe number of data points returned.

\n\t\t

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n\t\t \n\t\t

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

\n\t\t

Amazon CloudWatch retains metric data as follows:

\n\t\t \n\t\t

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\ta resolution of 1 hour.

\n\t\t

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

\t\n\n\t\t

For information about metrics and dimensions supported by Amazon Web Services services, see the \n\t\t\tAmazon CloudWatch Metrics and Dimensions Reference in the\n\t\t\tAmazon CloudWatch User Guide.

" + "smithy.api#documentation": "

Gets statistics for the specified metric.

\n

The maximum number of data points returned from a single call is 1,440. If \n\t\t\tyou request more than 1,440 data points, CloudWatch returns an error. \n\t\t\tTo reduce the number of data points, you can narrow the specified time range and make \n\t\t\tmultiple requests across adjacent time ranges, or you can increase the specified period. \n\t\t\tData points are not returned in chronological order.

\n

CloudWatch aggregates data points based on the length of the period\n\t\t\tthat you specify. For example, if you request statistics with a one-hour period, \n\t\t\tCloudWatch aggregates all data points with time stamps that fall within each \n\t\t\tone-hour period. Therefore, the number of values aggregated by CloudWatch is larger than\n\t\t\tthe number of data points returned.

\n

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n \n

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

\n

Amazon CloudWatch retains metric data as follows:

\n \n

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\ta resolution of 1 hour.

\n

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

\n

For information about metrics and dimensions supported by Amazon Web Services services, see the \n\t\t\tAmazon CloudWatch Metrics and Dimensions Reference in the\n\t\t\tAmazon CloudWatch User Guide.

" } }, "com.amazonaws.cloudwatch#GetMetricStatisticsInput": { @@ -2101,21 +2112,21 @@ "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp that determines the first data point to return. Start times are \n\t\t\tevaluated relative to the time that CloudWatch receives the request.

\n\t

The value specified is inclusive; results include data points with the specified time stamp. \n\t \tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

\n\t\t

CloudWatch rounds the specified time stamp as follows:

\n\t\t \n\t\t

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

", + "smithy.api#documentation": "

The time stamp that determines the first data point to return. Start times are \n\t\t\tevaluated relative to the time that CloudWatch receives the request.

\n

The value specified is inclusive; results include data points with the specified time stamp. \n\t \tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

\n

CloudWatch rounds the specified time stamp as follows:

\n \n

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp that determines the last data point to return.

\n\t\t

The value specified is exclusive; results include data points up to the specified time stamp.\n\t\t\tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

", + "smithy.api#documentation": "

The time stamp that determines the last data point to return.

\n

The value specified is exclusive; results include data points up to the specified time stamp.\n\t\t\tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

", "smithy.api#required": {} } }, "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n\t\t

If the StartTime parameter specifies a time stamp that is greater than\n\t\t 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n\t\t ", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n\t\t 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n ", "smithy.api#required": {} } }, @@ -2277,7 +2288,7 @@ "target": "com.amazonaws.cloudwatch#GetMetricWidgetImageOutput" }, "traits": { - "smithy.api#documentation": "

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of \n\t\t\tone or more Amazon CloudWatch metrics as a bitmap image. You can then embed this \n\t\t\timage into your services and products, such as wiki pages, reports, and documents. \n\t\t\tYou could also retrieve images regularly, such as every minute, and create your own \n\t\t\tcustom live dashboard.

\n\t\t\n\t\t

The graph you retrieve can include all CloudWatch metric graph features, including metric math\n\t\tand horizontal and vertical annotations.

\n\t\t\n\t\t

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

\n\t\t " + "smithy.api#documentation": "

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of \n\t\t\tone or more Amazon CloudWatch metrics as a bitmap image. You can then embed this \n\t\t\timage into your services and products, such as wiki pages, reports, and documents. \n\t\t\tYou could also retrieve images regularly, such as every minute, and create your own \n\t\t\tcustom live dashboard.

\n

The graph you retrieve can include all CloudWatch metric graph features, including metric math\n\t\tand horizontal and vertical annotations.

\n

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

\n " } }, "com.amazonaws.cloudwatch#GetMetricWidgetImageInput": { @@ -2286,14 +2297,14 @@ "MetricWidget": { "target": "com.amazonaws.cloudwatch#MetricWidget", "traits": { - "smithy.api#documentation": "

A JSON string that defines the bitmap graph to be retrieved. The string includes the \n\t\t\tmetrics to include in the graph, statistics, annotations, title, axis limits, and so on. \n\t\t\tYou can include only one MetricWidget parameter in each GetMetricWidgetImage call.

\n\t\t

For more information about the syntax of MetricWidget see \n\t\t\tGetMetricWidgetImage: Metric Widget Structure and Syntax.

\n\t\t\n\t\t

If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation\n\t\t\tpoint appears next to the graph legend.

", + "smithy.api#documentation": "

A JSON string that defines the bitmap graph to be retrieved. The string includes the \n\t\t\tmetrics to include in the graph, statistics, annotations, title, axis limits, and so on. \n\t\t\tYou can include only one MetricWidget parameter in each GetMetricWidgetImage call.

\n

For more information about the syntax of MetricWidget see \n\t\t\tGetMetricWidgetImage: Metric Widget Structure and Syntax.

\n

If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation\n\t\t\tpoint appears next to the graph legend.

", "smithy.api#required": {} } }, "OutputFormat": { "target": "com.amazonaws.cloudwatch#OutputFormat", "traits": { - "smithy.api#documentation": "

The format of the resulting image. Only PNG images are supported.

\n\n\t\t

The default is png. If you specify png, the API returns an HTTP response with the \n\t\t\tcontent-type set to text/xml. The image data is in a MetricWidgetImage \n\t\t\tfield. For example:

\n\t\t\n\t\t

\n \n\t\t\t>\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n 6f0d4192-4d42-11e8-82c1-f539a07e0e3b\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t\n\t\t

The image/png setting is intended only for custom HTTP requests. For most\n\t\t\tuse cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify \n\t\t\timage/png, the HTTP response has a content-type set to image/png, \n\t\t\tand the body of the response is a PNG image.

" + "smithy.api#documentation": "

The format of the resulting image. Only PNG images are supported.

\n

The default is png. If you specify png, the API returns an HTTP response with the \n\t\t\tcontent-type set to text/xml. The image data is in a MetricWidgetImage \n\t\t\tfield. For example:

\n

\n \n\t\t\t>\n

\n

\n \n

\n

\n \n

\n

\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n

\n

\n \n

\n

\n \n

\n

\n \n

\n

\n 6f0d4192-4d42-11e8-82c1-f539a07e0e3b\n

\n

\n \n

\n

\n \n

\n

The image/png setting is intended only for custom HTTP requests. For most\n\t\t\tuse cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify \n\t\t\timage/png, the HTTP response has a content-type set to image/png, \n\t\t\tand the body of the response is a PNG image.

" } } } @@ -2440,7 +2451,7 @@ "name": "monitoring" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the\n\t\t\tapplications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track\n\t\t\tmetrics, which are the variables you want to measure for your resources and\n\t\t\tapplications.

\n\n\t\t

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules\n\t\t\tthat you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2\n\t\t\tinstances. Then, use this data to determine whether you should launch\n\t\t\tadditional instances to handle increased load. You can also use this data to stop\n\t\t\tunder-used instances to save\n\t\t\tmoney.

\n\n\t\t

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor\n\t\t\tyour own custom metrics. With CloudWatch, you gain system-wide visibility into resource\n\t\t\tutilization, application performance, and operational health.

", + "smithy.api#documentation": "

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the\n\t\t\tapplications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track\n\t\t\tmetrics, which are the variables you want to measure for your resources and\n\t\t\tapplications.

\n

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules\n\t\t\tthat you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2\n\t\t\tinstances. Then, use this data to determine whether you should launch\n\t\t\tadditional instances to handle increased load. You can also use this data to stop\n\t\t\tunder-used instances to save\n\t\t\tmoney.

\n

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor\n\t\t\tyour own custom metrics. With CloudWatch, you gain system-wide visibility into resource\n\t\t\tutilization, application performance, and operational health.

", "smithy.api#title": "Amazon CloudWatch", "smithy.api#xmlNamespace": { "uri": "http://monitoring.amazonaws.com/doc/2010-08-01/" @@ -2450,7 +2461,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -2499,15 +2510,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -4757,7 +4759,7 @@ } }, "traits": { - "smithy.api#documentation": "

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then\n\t\t\ta unique contributor is a unique combination of values from all the keys in the rule.

\n\t\t

If the rule contains a single key, then each unique contributor is each unique value for this key.

\n\t\t

For more information, see GetInsightRuleReport.

" + "smithy.api#documentation": "

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then\n\t\t\ta unique contributor is a unique combination of values from all the keys in the rule.

\n

If the rule contains a single key, then each unique contributor is each unique value for this key.

\n

For more information, see GetInsightRuleReport.

" } }, "com.amazonaws.cloudwatch#InsightRuleContributorDatapoint": { @@ -4779,7 +4781,7 @@ } }, "traits": { - "smithy.api#documentation": "

One data point related to one contributor.

\n\t\t

For more information, see GetInsightRuleReport and \n\t\t\tInsightRuleContributor.

" + "smithy.api#documentation": "

One data point related to one contributor.

\n

For more information, see GetInsightRuleReport and \n\t\t\tInsightRuleContributor.

" } }, "com.amazonaws.cloudwatch#InsightRuleContributorDatapoints": { @@ -4850,48 +4852,48 @@ "UniqueContributors": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The number of unique contributors who published data during this timestamp.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The number of unique contributors who published data during this timestamp.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "MaxContributorValue": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, \n\t\t\tso the identity of the max contributor\n\t\tcould be different for each timestamp.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, \n\t\t\tso the identity of the max contributor\n\t\tcould be different for each timestamp.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "SampleCount": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The number of occurrences that matched the rule during this data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The number of occurrences that matched the rule during this data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "Average": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The average value from all contributors during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The average value from all contributors during the time period represented by that data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "Sum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The sum of the values from all contributors during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The sum of the values from all contributors during the time period represented by that data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "Minimum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The minimum value from a single contributor during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The minimum value from a single contributor during the time period represented by that data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "Maximum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The maximum value from a single occurence from a single contributor during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The maximum value from a single occurence from a single contributor during the time period represented by that data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } } }, "traits": { - "smithy.api#documentation": "

One data point from the metric time series returned in a Contributor Insights rule report.

\n\t\t

For more information, see GetInsightRuleReport.

" + "smithy.api#documentation": "

One data point from the metric time series returned in a Contributor Insights rule report.

\n

For more information, see GetInsightRuleReport.

" } }, "com.amazonaws.cloudwatch#InsightRuleMetricDatapoints": { @@ -5081,7 +5083,7 @@ } }, "traits": { - "smithy.api#documentation": "

This structure includes the Timezone parameter, which you can use\n\t\t\tto specify your time zone so that the labels that are associated with returned metrics display the \n\t\t\tcorrect time\n\t\t\tfor your time zone.

\n\t\t

The Timezone value affects a label only if you have a time-based\n\t\tdynamic expression in the label. For more information about dynamic expressions in labels, \n\t\tsee Using Dynamic Labels.

" + "smithy.api#documentation": "

This structure includes the Timezone parameter, which you can use\n\t\t\tto specify your time zone so that the labels that are associated with returned metrics display the \n\t\t\tcorrect time\n\t\t\tfor your time zone.

\n

The Timezone value affects a label only if you have a time-based\n\t\tdynamic expression in the label. For more information about dynamic expressions in labels, \n\t\tsee Using Dynamic Labels.

" } }, "com.amazonaws.cloudwatch#LastModified": { @@ -5141,7 +5143,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only\n\t\t\tthose dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are\n\t\t\tlisted.\n\t

\n\t\t

\n ListDashboards returns up to 1000 results on one page. If there\n\t\t\tare more than 1000 dashboards, you can call ListDashboards again and\n\t\tinclude the value you received for NextToken in the first call, to receive\n\t\tthe next 1000 results.

", + "smithy.api#documentation": "

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only\n\t\t\tthose dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are\n\t\t\tlisted.\n\t

\n

\n ListDashboards returns up to 1000 results on one page. If there\n\t\t\tare more than 1000 dashboards, you can call ListDashboards again and\n\t\tinclude the value you received for NextToken in the first call, to receive\n\t\tthe next 1000 results.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5343,7 +5345,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.

\n\t\t

Up to 500 results are returned for any one call. To retrieve additional results,\n\t\t\tuse the returned token with subsequent calls.

\n\t\t

After you create a metric, allow up to 15 minutes for the metric to appear. To see metric\n\t\t\tstatistics sooner, use GetMetricData or GetMetricStatistics.

\n\t\t\n\t\t

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n\t\t\tview metrics from the linked source accounts. For more information, see \n\t\t\tCloudWatch cross-account observability.

\n\n\t

\n ListMetrics doesn't return information about metrics if those metrics haven't \n\treported data in the past two weeks. To retrieve those metrics, use \n\t\tGetMetricData or \n\t\tGetMetricStatistics.

", + "smithy.api#documentation": "

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.

\n

Up to 500 results are returned for any one call. To retrieve additional results,\n\t\t\tuse the returned token with subsequent calls.

\n

After you create a metric, allow up to 15 minutes for the metric to appear. To see metric\n\t\t\tstatistics sooner, use GetMetricData or GetMetricStatistics.

\n

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n\t\t\tview metrics from the linked source accounts. For more information, see \n\t\t\tCloudWatch cross-account observability.

\n

\n ListMetrics doesn't return information about metrics if those metrics haven't \n\treported data in the past two weeks. To retrieve those metrics, use \n\t\tGetMetricData or \n\t\tGetMetricStatistics.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken" @@ -5380,14 +5382,14 @@ "RecentlyActive": { "target": "com.amazonaws.cloudwatch#RecentlyActive", "traits": { - "smithy.api#documentation": "

To filter the results to show only metrics that have had data points published\n\t\t\tin the past three hours, specify this parameter\n\t\t\twith a value of PT3H. This is the only valid value\n\t\t\tfor this parameter.

\n\t\t

The results that are returned are an approximation of the value you specify. There\n\t\tis a low probability that the returned results include metrics with last published\n\t\tdata as much as 40 minutes more than the specified time interval.

" + "smithy.api#documentation": "

To filter the results to show only metrics that have had data points published\n\t\t\tin the past three hours, specify this parameter\n\t\t\twith a value of PT3H. This is the only valid value\n\t\t\tfor this parameter.

\n

The results that are returned are an approximation of the value you specify. There\n\t\tis a low probability that the returned results include metrics with last published\n\t\tdata as much as 40 minutes more than the specified time interval.

" } }, "IncludeLinkedAccounts": { "target": "com.amazonaws.cloudwatch#IncludeLinkedAccounts", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If you are using this operation in a monitoring account, \n\t\t\tspecify true to include metrics from source accounts in the returned data.

\n\t\t

The default is false.

" + "smithy.api#documentation": "

If you are using this operation in a monitoring account, \n\t\t\tspecify true to include metrics from source accounts in the returned data.

\n

The default is false.

" } }, "OwningAccount": { @@ -5416,7 +5418,7 @@ "OwningAccounts": { "target": "com.amazonaws.cloudwatch#OwningAccounts", "traits": { - "smithy.api#documentation": "

If you are using this operation in a monitoring account, this array contains the account IDs of the source \n\t\t\taccounts where the metrics in the returned data\n\t\tare from.

\n\t\t

This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.

" + "smithy.api#documentation": "

If you are using this operation in a monitoring account, this array contains the account IDs of the source \n\t\t\taccounts where the metrics in the returned data\n\t\tare from.

\n

This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.

" } } } @@ -5450,7 +5452,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch resource that you want to view tags for.

\n\t\t

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n\t\t

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n\t

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#documentation": "

The ARN of the CloudWatch resource that you want to view tags for.

\n

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", "smithy.api#required": {} } } @@ -5592,7 +5594,7 @@ } }, "traits": { - "smithy.api#documentation": "

A message returned by the GetMetricDataAPI, including a code and a description.

\n\t\t

If a cross-Region GetMetricData operation fails with a code of Forbidden and a \n\t\t\tvalue of Authentication too complex to \n\t\t\tretrieve cross region data, you can correct the problem by running the GetMetricData\n\t\toperation in the same Region where the metric data is.

" + "smithy.api#documentation": "

A message returned by the GetMetricDataAPI, including a code and a description.

\n

If a cross-Region GetMetricData operation fails with a code of Forbidden and a \n\t\t\tvalue of Authentication too complex to \n\t\t\tretrieve cross region data, you can correct the problem by running the GetMetricData\n\t\toperation in the same Region where the metric data is.

" } }, "com.amazonaws.cloudwatch#MessageDataCode": { @@ -5699,7 +5701,7 @@ "StateUpdatedTimestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp of the last update to the alarm state.

" + "smithy.api#documentation": "

The time stamp of the last update to the value of either the \n\t\t\tStateValue or EvaluationState parameters.

" } }, "MetricName": { @@ -5771,7 +5773,7 @@ "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. The valid values\n \tare breaching, notBreaching, ignore, and \n \tmissing. For more information, see\n \tConfiguring how CloudWatch alarms treat missing data.

\n\t\t

If this parameter is omitted, the default \n \tbehavior of missing is used.

" + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. The valid values\n \tare breaching, notBreaching, ignore, and \n \tmissing. For more information, see\n \tConfiguring how CloudWatch alarms treat missing data.

\n

If this parameter is omitted, the default \n \tbehavior of missing is used.

" } }, "EvaluateLowSampleCountPercentile": { @@ -5791,6 +5793,18 @@ "traits": { "smithy.api#documentation": "

In an alarm based on an anomaly detection model, this is the ID of the \n\t\t\tANOMALY_DETECTION_BAND function \n\t\t\tused as the threshold for the alarm.

" } + }, + "EvaluationState": { + "target": "com.amazonaws.cloudwatch#EvaluationState", + "traits": { + "smithy.api#documentation": "

If the value of this field is\n\tPARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the\n\tquery used for the alarm returns more than 10,000 metrics. For \n\tmore information, see \n\t\tCreate alarms on Metrics Insights queries.

" + } + }, + "StateTransitionedTimestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the alarm's StateValue most recently changed.

" + } } }, "traits": { @@ -5828,25 +5842,25 @@ "MetricStat": { "target": "com.amazonaws.cloudwatch#MetricStat", "traits": { - "smithy.api#documentation": "

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric \n\t\t\tand not performing a math expression on returned data.

\n\t\t

Within one MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" + "smithy.api#documentation": "

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric \n\t\t\tand not performing a math expression on returned data.

\n

Within one MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" } }, "Expression": { "target": "com.amazonaws.cloudwatch#MetricExpression", "traits": { - "smithy.api#documentation": "

This field can contain either a Metrics Insights query, or a metric math expression to be performed on the \n\t\t\treturned data. For more information about Metrics Insights queries, see \n\t\t\tMetrics Insights query components and syntax in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

A math expression\n\t\t\tcan use the Id of the other metrics or queries to refer to those metrics, and can also use \n\t\t\tthe Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" + "smithy.api#documentation": "

This field can contain either a Metrics Insights query, or a metric math expression to be performed on the \n\t\t\treturned data. For more information about Metrics Insights queries, see \n\t\t\tMetrics Insights query components and syntax in the\n\t\t\tAmazon CloudWatch User Guide.

\n

A math expression\n\t\t\tcan use the Id of the other metrics or queries to refer to those metrics, and can also use \n\t\t\tthe Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.

\n

Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" } }, "Label": { "target": "com.amazonaws.cloudwatch#MetricLabel", "traits": { - "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful \n\t\t\tif this is an expression, so that you know\n\t\t\twhat the value represents. If the metric or expression is shown in a \n\t\t\tCloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n\t\t\tgenerates a default.

\n\t\t

You can put dynamic expressions into a label, so that it is more descriptive. \n\t\t\tFor more information, see Using Dynamic Labels.

" + "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful \n\t\t\tif this is an expression, so that you know\n\t\t\twhat the value represents. If the metric or expression is shown in a \n\t\t\tCloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n\t\t\tgenerates a default.

\n

You can put dynamic expressions into a label, so that it is more descriptive. \n\t\t\tFor more information, see Using Dynamic Labels.

" } }, "ReturnData": { "target": "com.amazonaws.cloudwatch#ReturnData", "traits": { - "smithy.api#documentation": "

When used in GetMetricData, this option indicates whether to return the\n\t\t\ttimestamps and raw data values of this metric. If you are performing this call just to\n\t\t\tdo math expressions and do not also need the raw data returned, you can specify\n\t\t\t\tfalse. If you omit this, the default of true is\n\t\t\tused.

\n\t\t

When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all \n\t\tother metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

" + "smithy.api#documentation": "

When used in GetMetricData, this option indicates whether to return the\n\t\t\ttimestamps and raw data values of this metric. If you are performing this call just to\n\t\t\tdo math expressions and do not also need the raw data returned, you can specify\n\t\t\t\tfalse. If you omit this, the default of true is\n\t\t\tused.

\n

When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all \n\t\tother metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

" } }, "Period": { @@ -5858,12 +5872,12 @@ "AccountId": { "target": "com.amazonaws.cloudwatch#AccountId", "traits": { - "smithy.api#documentation": "

The ID of the account where the metrics are located.

\n\t\t

If you are performing a GetMetricData operation in a monitoring account, use this to specify \n\t\t\twhich account to retrieve this metric from.

\n\t\t

If you are performing a PutMetricAlarm operation, use this to specify \n\t\t\twhich account contains the metric that the alarm is watching.

" + "smithy.api#documentation": "

The ID of the account where the metrics are located.

\n

If you are performing a GetMetricData operation in a monitoring account, use this to specify \n\t\t\twhich account to retrieve this metric from.

\n

If you are performing a PutMetricAlarm operation, use this to specify \n\t\t\twhich account contains the metric that the alarm is watching.

" } } }, "traits": { - "smithy.api#documentation": "

This structure is used in both GetMetricData and PutMetricAlarm. The supported\n\t\t\tuse of this structure is different for those two operations.

\n\t\t

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A\n\t\t\tsingle GetMetricData call can include up to 500 MetricDataQuery\n\t\t\tstructures.

\n\t\t

When used in PutMetricAlarm, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm call can include up to 20\n\t\t\t\tMetricDataQuery structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression parameter\n\t\t\tto perform a math expression. Of those Expression structures, one must have true\n\t\tas the value for ReturnData. The result of this expression is the value the alarm watches.

\n\n\t\t

Any expression used in a PutMetricAlarm\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.

\n\n\t\t

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData\n\t\t\toperation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

" + "smithy.api#documentation": "

This structure is used in both GetMetricData and PutMetricAlarm. The supported\n\t\t\tuse of this structure is different for those two operations.

\n

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A\n\t\t\tsingle GetMetricData call can include up to 500 MetricDataQuery\n\t\t\tstructures.

\n

When used in PutMetricAlarm, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm call can include up to 20\n\t\t\t\tMetricDataQuery structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression parameter\n\t\t\tto perform a math expression. Of those Expression structures, one must have true\n\t\tas the value for ReturnData. The result of this expression is the value the alarm watches.

\n

Any expression used in a PutMetricAlarm\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.

\n

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData\n\t\t\toperation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

" } }, "com.amazonaws.cloudwatch#MetricDataResult": { @@ -5947,7 +5961,7 @@ "Value": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The value for the metric.

\n\t\t

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or\n\t\t\ttoo large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)\n\t\t\tare not supported.

" + "smithy.api#documentation": "

The value for the metric.

\n

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or\n\t\t\ttoo large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)\n\t\t\tare not supported.

" } }, "StatisticValues": { @@ -5959,25 +5973,25 @@ "Values": { "target": "com.amazonaws.cloudwatch#Values", "traits": { - "smithy.api#documentation": "

Array of numbers representing the values for the metric during the period. Each unique value is listed just once\n\t\tin this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period.\n\t\tYou can include up to 150 unique values in each PutMetricData action that specifies a Values array.

\n\t\t

Although the Values array accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

" + "smithy.api#documentation": "

Array of numbers representing the values for the metric during the period. Each unique value is listed just once\n\t\tin this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period.\n\t\tYou can include up to 150 unique values in each PutMetricData action that specifies a Values array.

\n

Although the Values array accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

" } }, "Counts": { "target": "com.amazonaws.cloudwatch#Counts", "traits": { - "smithy.api#documentation": "

Array of numbers that is used along with the Values array. Each number in the Count array \n\t\t\tis the number of times the corresponding value in the Values array occurred during the period.

\n\t\t

If you omit the Counts array, the default of 1 is used as the value for each count. If you\n\t\tinclude a Counts array, it must include the same amount of values as the Values array.

" + "smithy.api#documentation": "

Array of numbers that is used along with the Values array. Each number in the Count array \n\t\t\tis the number of times the corresponding value in the Values array occurred during the period.

\n

If you omit the Counts array, the default of 1 is used as the value for each count. If you\n\t\tinclude a Counts array, it must include the same amount of values as the Values array.

" } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n\t\t

In \n\t\ta Get operation, this displays the unit that is used for the metric.

" + "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n

In \n\t\ta Get operation, this displays the unit that is used for the metric.

" } }, "StorageResolution": { "target": "com.amazonaws.cloudwatch#StorageResolution", "traits": { - "smithy.api#documentation": "

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with \n\t\t\tsub-minute resolution down to one second.\n\t\tSetting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available\n\t\tonly for custom metrics. For more information about high-resolution metrics, \n\t\t\tsee High-Resolution Metrics in the\n\t\t\tAmazon CloudWatch User Guide.\n\t\t

\n\t

This field is optional, if you do not specify it the default of 60 is used.

" + "smithy.api#documentation": "

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with \n\t\t\tsub-minute resolution down to one second.\n\t\tSetting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available\n\t\tonly for custom metrics. For more information about high-resolution metrics, \n\t\t\tsee High-Resolution Metrics in the\n\t\t\tAmazon CloudWatch User Guide.\n\t\t

\n

This field is optional, if you do not specify it the default of 60 is used.

" } } }, @@ -6042,7 +6056,7 @@ "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n\t\t\t

If the StartTime parameter specifies a time stamp that is greater than\n\t\t\t\t3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n\t\t\t ", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n\t\t\t\t3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n ", "smithy.api#required": {} } }, @@ -6056,7 +6070,7 @@ "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n\t\t

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" + "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" } } }, @@ -6196,14 +6210,14 @@ "IncludeMetrics": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsIncludeMetrics", "traits": { - "smithy.api#documentation": "

An array of metric name and namespace pairs that stream the additional statistics listed\n\t\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t\t100 pairs in the array.

\n\t\t

All metrics that match the combination of metric name and namespace will be streamed\n\t\t\twith the additional statistics, no matter their dimensions.

", + "smithy.api#documentation": "

An array of metric name and namespace pairs that stream the additional statistics listed\n\t\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t\t100 pairs in the array.

\n

All metrics that match the combination of metric name and namespace will be streamed\n\t\t\twith the additional statistics, no matter their dimensions.

", "smithy.api#required": {} } }, "AdditionalStatistics": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics", "traits": { - "smithy.api#documentation": "

The list of additional statistics that are to be streamed for the metrics listed\n\t\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n\t\t

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n\t\t

If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\t\ttm98, \n wm90, PR(:300), and so on.

", + "smithy.api#documentation": "

The list of additional statistics that are to be streamed for the metrics listed\n\t\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n

If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\t\ttm98, \n wm90, PR(:300), and so on.

", "smithy.api#required": {} } } @@ -6366,7 +6380,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an anomaly detection model for a CloudWatch metric. You can use the model\n\t\t\tto display a band of expected normal values when the metric is graphed.

\n\t\t

For more information, see CloudWatch Anomaly Detection.

" + "smithy.api#documentation": "

Creates an anomaly detection model for a CloudWatch metric. You can use the model\n\t\t\tto display a band of expected normal values when the metric is graphed.

\n

For more information, see CloudWatch Anomaly Detection.

" } }, "com.amazonaws.cloudwatch#PutAnomalyDetectorInput": { @@ -6411,19 +6425,19 @@ "Configuration": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration", "traits": { - "smithy.api#documentation": "

The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.

\n\t\t

The configuration can also include the time zone to use for \n\t\t\tthe metric.

" + "smithy.api#documentation": "

The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.

\n

The configuration can also include the time zone to use for \n\t\t\tthe metric.

" } }, "SingleMetricAnomalyDetector": { "target": "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector", "traits": { - "smithy.api#documentation": "

A single metric anomaly detector to be created.

\n\t\t

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the single metric anomaly detector attributes\n\t\t\tas part of the property SingleMetricAnomalyDetector.

" + "smithy.api#documentation": "

A single metric anomaly detector to be created.

\n

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n \n

Instead, specify the single metric anomaly detector attributes\n\t\t\tas part of the property SingleMetricAnomalyDetector.

" } }, "MetricMathAnomalyDetector": { "target": "com.amazonaws.cloudwatch#MetricMathAnomalyDetector", "traits": { - "smithy.api#documentation": "

The metric math anomaly detector to be created.

\n\t\t\n\t\t

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the metric math anomaly detector attributes\n\t\t\tas part of the property MetricMathAnomalyDetector.

" + "smithy.api#documentation": "

The metric math anomaly detector to be created.

\n

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

\n \n

Instead, specify the metric math anomaly detector attributes\n\t\t\tas part of the property MetricMathAnomalyDetector.

" } } } @@ -6446,7 +6460,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.

\n\t\t

The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. \n\t\t\tAny single alarm can be included in the rule expressions of as many as 150 composite alarms.

\n\t\t

Using composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.

\n\t\t

Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.

\n\t\t \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n\t\t\t

To get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to false.

\n\t\t\t

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t

\n \n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.

\n\t\t\n\t\t

To use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

\n\t\t\n\t\t

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.

" + "smithy.api#documentation": "

Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.

\n

The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. \n\t\t\tAny single alarm can be included in the rule expressions of as many as 150 composite alarms.

\n

Using composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.

\n

Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.

\n \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n

To get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to false.

\n

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t

\n \n

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.

\n

When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.

\n

To use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

\n

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.

" } }, "com.amazonaws.cloudwatch#PutCompositeAlarmInput": { @@ -6461,7 +6475,7 @@ "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n

" } }, "AlarmDescription": { @@ -6480,26 +6494,26 @@ "AlarmRule": { "target": "com.amazonaws.cloudwatch#AlarmRule", "traits": { - "smithy.api#documentation": "

An expression that specifies which other alarms are to be evaluated to determine this\n\t\t\tcomposite alarm's state. For each alarm that you reference, you\n\t\t\tdesignate a function that\n\t\t\tspecifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You\n\t\t\tcan use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the \n\t\t\tfunctions in your expression.

\n\t\t

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

\n\t\t

Functions can include the following:

\n\t\t \n\t\t

TRUE and FALSE are useful for testing a complex AlarmRule structure, and \n\t\tfor testing your alarm actions.

\n\t\t

Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.

\n\t\t

The following\n\t\t\tare some examples of AlarmRule:

\n\t\t \n\t\t

The AlarmRule can specify as many as 100\n\t\t\t\"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements\n\t\t\tare child alarms, TRUE or FALSE statements, and\n\t\t\tparentheses.

", + "smithy.api#documentation": "

An expression that specifies which other alarms are to be evaluated to determine this\n\t\t\tcomposite alarm's state. For each alarm that you reference, you\n\t\t\tdesignate a function that\n\t\t\tspecifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You\n\t\t\tcan use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the \n\t\t\tfunctions in your expression.

\n

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

\n

Functions can include the following:

\n \n

TRUE and FALSE are useful for testing a complex AlarmRule structure, and \n\t\tfor testing your alarm actions.

\n

Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.

\n

The following\n\t\t\tare some examples of AlarmRule:

\n \n

The AlarmRule can specify as many as 100\n\t\t\t\"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements\n\t\t\tare child alarms, TRUE or FALSE statements, and\n\t\t\tparentheses.

", "smithy.api#required": {} } }, "InsufficientDataActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" } }, "OKActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" } }, "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

\n\t\t

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with\n\t\t\tcertain tag values.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

\n

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with\n\t\t\tcertain tag values.

" } }, "ActionsSuppressor": { @@ -6511,13 +6525,13 @@ "ActionsSuppressorWaitPeriod": { "target": "com.amazonaws.cloudwatch#SuppressorPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n\t\t \n\t\t\t

\n\t\t\t\t WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n \n

\n WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n " } }, "ActionsSuppressorExtensionPeriod": { "target": "com.amazonaws.cloudwatch#SuppressorPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n\t\t \n\t\t\t

\n\t\t\t\t ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n \n

\n ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n " } } } @@ -6539,7 +6553,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,\n\t\tthe entire contents are replaced with what you specify here.

\n\t\t

All dashboards in your account are global, not region-specific.

\n\t\t

A simple way to create a dashboard using PutDashboard is to copy an \n\t\t\texisting dashboard. To copy an existing dashboard using the console, you can load the dashboard\n\t\t\tand then use the View/edit source command in the Actions menu to display the JSON block\n\t\t\tfor that dashboard. Another way to copy a dashboard is to \n\t\t\tuse GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard.

\n\t\t

When you create a dashboard with PutDashboard, a good practice is to \n\t\t\tadd a text widget at the top of the dashboard with a message that the dashboard was created by script and should\n\t\tnot be changed in the console. This message could also point console users to the location \n\t\tof the DashboardBody script or the CloudFormation template used to create the\n\t\tdashboard.

" + "smithy.api#documentation": "

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,\n\t\tthe entire contents are replaced with what you specify here.

\n

All dashboards in your account are global, not region-specific.

\n

A simple way to create a dashboard using PutDashboard is to copy an \n\t\t\texisting dashboard. To copy an existing dashboard using the console, you can load the dashboard\n\t\t\tand then use the View/edit source command in the Actions menu to display the JSON block\n\t\t\tfor that dashboard. Another way to copy a dashboard is to \n\t\t\tuse GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard.

\n

When you create a dashboard with PutDashboard, a good practice is to \n\t\t\tadd a text widget at the top of the dashboard with a message that the dashboard was created by script and should\n\t\tnot be changed in the console. This message could also point console users to the location \n\t\tof the DashboardBody script or the CloudFormation template used to create the\n\t\tdashboard.

" } }, "com.amazonaws.cloudwatch#PutDashboardInput": { @@ -6555,7 +6569,7 @@ "DashboardBody": { "target": "com.amazonaws.cloudwatch#DashboardBody", "traits": { - "smithy.api#documentation": "

The detailed information about the dashboard in JSON format, including the widgets to include and their location\n\t\t\ton the dashboard. This parameter is required.

\n\t\t

For more information about the syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.

", + "smithy.api#documentation": "

The detailed information about the dashboard in JSON format, including the widgets to include and their location\n\t\t\ton the dashboard. This parameter is required.

\n

For more information about the syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.

", "smithy.api#required": {} } } @@ -6567,7 +6581,7 @@ "DashboardValidationMessages": { "target": "com.amazonaws.cloudwatch#DashboardValidationMessages", "traits": { - "smithy.api#documentation": "

If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.

\n\t\t\t

If this result includes only warning messages, then the input was valid enough for the dashboard to be\n\t\t\tcreated or modified, but some elements of the dashboard\n\t\t\tmight not render.

\n\t\t\t\t

If this result includes error messages, the input was not valid and the operation failed.

" + "smithy.api#documentation": "

If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.

\n

If this result includes only warning messages, then the input was valid enough for the dashboard to be\n\t\t\tcreated or modified, but some elements of the dashboard\n\t\t\tmight not render.

\n

If this result includes error messages, the input was not valid and the operation failed.

" } } } @@ -6592,7 +6606,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Contributor Insights rule. Rules evaluate log events in a\n\t\tCloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, \n\t\tsee Using Contributor Insights to Analyze High-Cardinality Data.

\n\t\t

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might not be available.

" + "smithy.api#documentation": "

Creates a Contributor Insights rule. Rules evaluate log events in a\n\t\tCloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, \n\t\tsee Using Contributor Insights to Analyze High-Cardinality Data.

\n

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might not be available.

" } }, "com.amazonaws.cloudwatch#PutInsightRuleInput": { @@ -6621,7 +6635,7 @@ "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the Contributor Insights rule. \n\t\t\tYou can associate as many as 50 tags with a rule.

\n\t\t

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by \n\t\t\tgranting a user permission to access or change only the resources that have\n\t\t\tcertain tag values.

\n\t\t

To be able to associate tags with a rule, you must have the cloudwatch:TagResource\n\t\tpermission in addition to the cloudwatch:PutInsightRule permission.

\n\t\t

If you are using this operation to update an existing Contributor Insights rule, any tags\n\t\tyou specify in this parameter are ignored. To change the tags of an existing rule, use\n\t\t\tTagResource.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the Contributor Insights rule. \n\t\t\tYou can associate as many as 50 tags with a rule.

\n

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by \n\t\t\tgranting a user permission to access or change only the resources that have\n\t\t\tcertain tag values.

\n

To be able to associate tags with a rule, you must have the cloudwatch:TagResource\n\t\tpermission in addition to the cloudwatch:PutInsightRule permission.

\n

If you are using this operation to update an existing Contributor Insights rule, any tags\n\t\tyou specify in this parameter are ignored. To change the tags of an existing rule, use\n\t\t\tTagResource.

" } } } @@ -6687,7 +6701,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tor anomaly detection model.

\n\t\t\n\t\t\n\t\t

Alarms based on anomaly detection models cannot have Auto Scaling actions.

\n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.

\n\n\t\t

If you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:

\n\t\t \n\t\t\n\t\t\n\t\t\n\n\t\t\n\t\t\n\t\t

The first time you create an alarm in the \n\t\t\tAmazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.

\n\t\t\t\n\t\t

\n Cross-account alarms\n

\n\t\t\n\t\t

You can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:

\n\t\t " + "smithy.api#documentation": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tanomaly detection model, or Metrics Insights query. For more information about using \n\t\t\ta Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.

\n

Alarms based on anomaly detection models cannot have Auto Scaling actions.

\n

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.

\n

When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.

\n

If you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:

\n \n

The first time you create an alarm in the \n\t\t\tAmazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.

\n

\n Cross-account alarms\n

\n

You can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:

\n " } }, "com.amazonaws.cloudwatch#PutMetricAlarmInput": { @@ -6715,25 +6729,25 @@ "OKActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\t arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\t arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

" } }, "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n\t\t\t| arn:aws:ssm-incidents::account-id:response-plan:response-plan-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n\t\t\t| arn:aws:ssm-incidents::account-id:response-plan:response-plan-name\n \n

\n

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

" } }, "InsufficientDataActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\t>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n

Valid Values (for use with IAM roles):\n\t\t\t>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "

The name for the metric associated with the alarm. For each PutMetricAlarm\n\t\toperation, you must specify either MetricName or a Metrics array.

\n\t\t

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the \n\t\t\tDimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters. Instead, you specify \n\t\tall this information in the Metrics array.

" + "smithy.api#documentation": "

The name for the metric associated with the alarm. For each PutMetricAlarm\n\t\toperation, you must specify either MetricName or a Metrics array.

\n

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the \n\t\t\tDimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters. Instead, you specify \n\t\tall this information in the Metrics array.

" } }, "Namespace": { @@ -6763,19 +6777,19 @@ "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The length, in seconds, used each time the metric specified in MetricName is\n\t\t\tevaluated. Valid values are 10, 30, and any multiple of 60.

\n\t\t

\n Period is required for alarms based on static thresholds. If \n\t\tyou are creating an alarm based on a metric math expression, you specify the \n\t\tperiod for each metric within the objects in the Metrics array.

\n\t\t

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a\n\t\t\t\tStorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have\n\t\t\tsub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,\n\t\t\tit does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm\n\t\t\tmight often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,\n\t\t\twhich has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

\n\t\t

An alarm's total current evaluation period can\n\t\tbe no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

" + "smithy.api#documentation": "

The length, in seconds, used each time the metric specified in MetricName is\n\t\t\tevaluated. Valid values are 10, 30, and any multiple of 60.

\n

\n Period is required for alarms based on static thresholds. If \n\t\tyou are creating an alarm based on a metric math expression, you specify the \n\t\tperiod for each metric within the objects in the Metrics array.

\n

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a\n\t\t\t\tStorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have\n\t\t\tsub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,\n\t\t\tit does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm\n\t\t\tmight often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,\n\t\t\twhich has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

\n

An alarm's total current evaluation period can\n\t\tbe no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

" } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.

\n\t\t

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.

\n\t\t\t

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves unpredictably.

\n\t\t

We recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.

" + "smithy.api#documentation": "

The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.

\n

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.

\n

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves unpredictably.

\n

We recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.

" } }, "EvaluationPeriods": { "target": "com.amazonaws.cloudwatch#EvaluationPeriods", "traits": { - "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold. If you are\n\t\t\tsetting an alarm that requires that a number of consecutive data points be breaching to\n\t\t\ttrigger the alarm, this value specifies that number. If you are setting an \"M out of N\"\n\t\t\talarm, this value is the N.

\n\t\t

An alarm's total current evaluation period can\n\t\t\tbe no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

", + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold. If you are\n\t\t\tsetting an alarm that requires that a number of consecutive data points be breaching to\n\t\t\ttrigger the alarm, this value specifies that number. If you are setting an \"M out of N\"\n\t\t\talarm, this value is the N.

\n

An alarm's total current evaluation period can\n\t\t\tbe no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

", "smithy.api#required": {} } }, @@ -6788,44 +6802,44 @@ "Threshold": { "target": "com.amazonaws.cloudwatch#Threshold", "traits": { - "smithy.api#documentation": "

The value against which the specified statistic is compared.

\n\t\t

This parameter is required for alarms based on static thresholds, but should\n\t\tnot be used for alarms based on anomaly detection models.

" + "smithy.api#documentation": "

The value against which the specified statistic is compared.

\n

This parameter is required for alarms based on static thresholds, but should\n\t\tnot be used for alarms based on anomaly detection models.

" } }, "ComparisonOperator": { "target": "com.amazonaws.cloudwatch#ComparisonOperator", "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic and\n\t\t\tthreshold. The specified statistic value is used as the first operand.

\n\t\t

The values LessThanLowerOrGreaterThanUpperThreshold, \n\t\t\tLessThanLowerThreshold, and GreaterThanUpperThreshold\n\t\tare used only for alarms based on anomaly detection models.

", + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic and\n\t\t\tthreshold. The specified statistic value is used as the first operand.

\n

The values LessThanLowerOrGreaterThanUpperThreshold, \n\t\t\tLessThanLowerThreshold, and GreaterThanUpperThreshold\n\t\tare used only for alarms based on anomaly detection models.

", "smithy.api#required": {} } }, "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n\t\t

Valid Values: breaching | notBreaching | ignore | missing\n

\n\t\t \n

Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\n\t\t\tmissing data even if you choose a different option for TreatMissingData. When an \n\t\t\tAWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

\n\t\t " + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n

Valid Values: breaching | notBreaching | ignore | missing\n

\n \n

Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\n\t\t\tmissing data even if you choose a different option for TreatMissingData. When an \n\t\t\tAWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

\n " } }, "EvaluateLowSampleCountPercentile": { "target": "com.amazonaws.cloudwatch#EvaluateLowSampleCountPercentile", "traits": { - "smithy.api#documentation": "

Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be \n\t\t\tstatistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state\n\t\t\tno matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

\n\t\t

Valid Values: evaluate | ignore\n

" + "smithy.api#documentation": "

Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be \n\t\t\tstatistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state\n\t\t\tno matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

\n

Valid Values: evaluate | ignore\n

" } }, "Metrics": { "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a \n\t\t\tmetric math expression. For each PutMetricAlarm\n\t\t\toperation, you must specify either MetricName or a Metrics array.

\n\t\t

Each item in the Metrics array either retrieves a metric or performs a math expression.

\n\t\t

One item in the Metrics array is the expression that the alarm watches. You designate this expression \n\t\t\tby setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.

\n\t\t

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. \n\t\t\tInstead, you retrieve\n\t\tthe metrics you are using in your math expression as part of the Metrics array.

" + "smithy.api#documentation": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a \n\t\t\tmetric math expression. For each PutMetricAlarm\n\t\t\toperation, you must specify either MetricName or a Metrics array.

\n

Each item in the Metrics array either retrieves a metric or performs a math expression.

\n

One item in the Metrics array is the expression that the alarm watches. You designate this expression \n\t\t\tby setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.

\n

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. \n\t\t\tInstead, you retrieve\n\t\tthe metrics you are using in your math expression as part of the Metrics array.

" } }, "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n\t\t

If you are using this operation to update an existing alarm, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing alarm, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n

If you are using this operation to update an existing alarm, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing alarm, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" } }, "ThresholdMetricId": { "target": "com.amazonaws.cloudwatch#MetricId", "traits": { - "smithy.api#documentation": "

If this is an alarm based on an anomaly detection model, make this value match\n\t\t\tthe ID of\n\t\t\tthe ANOMALY_DETECTION_BAND function.

\n\t\t

For an example of how to use this parameter, see the \n\t\t\tAnomaly Detection\n\t\tModel Alarm example on this page.

\n\t\t

If your alarm uses this parameter, it cannot have Auto Scaling actions.

" + "smithy.api#documentation": "

If this is an alarm based on an anomaly detection model, make this value match\n\t\t\tthe ID of\n\t\t\tthe ANOMALY_DETECTION_BAND function.

\n

For an example of how to use this parameter, see the \n\t\t\tAnomaly Detection\n\t\tModel Alarm example on this page.

\n

If your alarm uses this parameter, it cannot have Auto Scaling actions.

" } } } @@ -6853,7 +6867,7 @@ } ], "traits": { - "smithy.api#documentation": "

Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.

\n\n\t\t

You can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.

\n\t\t

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 1000 different metrics.

\n\t\t

Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

\n\t\t

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

\n\n\t\t

You specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.

\n\t\t

Data points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.

\n\t\t

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n\t\t\t " + "smithy.api#documentation": "

Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.

\n

You can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.

\n

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 1000 different metrics.

\n

Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

\n

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

\n

You specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.

\n

Data points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.

\n

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n " } }, "com.amazonaws.cloudwatch#PutMetricDataInput": { @@ -6862,7 +6876,7 @@ "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The namespace for the metric data.

\n\t\t

To avoid conflicts\n\t\t\twith Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/\n

", + "smithy.api#documentation": "

The namespace for the metric data.

\n

To avoid conflicts\n\t\t\twith Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/\n

", "smithy.api#required": {} } }, @@ -6901,7 +6915,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch\n\t\t\tmetrics to Amazon Web Services destinations, including Amazon S3, and to many third-party\n\t\t\tsolutions.

\n\t\t

For more information, see \n\t\tUsing Metric Streams.

\n\t\t

To create a metric stream, you must be signed in to an account that has the\n\t\t\t\tiam:PassRole permission and either the\n\t\t\t\tCloudWatchFullAccess policy or the\n\t\t\t\tcloudwatch:PutMetricStream permission.

\n\t\t

When you create or update a metric stream, you choose one of the following:

\n\t\t \n\t\t\n\t\t

By default, a metric stream always sends the MAX, MIN,\n\t\t\t\tSUM, and SAMPLECOUNT statistics for each metric that is\n\t\t\tstreamed. You can use the StatisticsConfigurations parameter to have the\n\t\t\tmetric stream send additional statistics in the stream. Streaming additional statistics\n\t\t\tincurs additional costs. For more information, see Amazon CloudWatch Pricing.

\n\t\t\n\t\t

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" + "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch\n\t\t\tmetrics to Amazon Web Services destinations, including Amazon S3, and to many third-party\n\t\t\tsolutions.

\n

For more information, see \n\t\tUsing Metric Streams.

\n

To create a metric stream, you must be signed in to an account that has the\n\t\t\t\tiam:PassRole permission and either the\n\t\t\t\tCloudWatchFullAccess policy or the\n\t\t\t\tcloudwatch:PutMetricStream permission.

\n

When you create or update a metric stream, you choose one of the following:

\n \n

By default, a metric stream always sends the MAX, MIN,\n\t\t\t\tSUM, and SAMPLECOUNT statistics for each metric that is\n\t\t\tstreamed. You can use the StatisticsConfigurations parameter to have the\n\t\t\tmetric stream send additional statistics in the stream. Streaming additional statistics\n\t\t\tincurs additional costs. For more information, see Amazon CloudWatch Pricing.

\n

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" } }, "com.amazonaws.cloudwatch#PutMetricStreamInput": { @@ -6910,20 +6924,20 @@ "Name": { "target": "com.amazonaws.cloudwatch#MetricStreamName", "traits": { - "smithy.api#documentation": "

If you are creating a new metric stream, this is the name for the new stream. The name\n\t\tmust be different than the names of other metric streams in this account and Region.

\n\t\t

If you are updating a metric stream, specify the name of that stream here.

\n\t\t

Valid characters are A-Z, a-z, 0-9, \"-\" and \"_\".

", + "smithy.api#documentation": "

If you are creating a new metric stream, this is the name for the new stream. The name\n\t\tmust be different than the names of other metric streams in this account and Region.

\n

If you are updating a metric stream, specify the name of that stream here.

\n

Valid characters are A-Z, a-z, 0-9, \"-\" and \"_\".

", "smithy.api#required": {} } }, "IncludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { - "smithy.api#documentation": "

If you specify this parameter, the stream sends only the \n\t\tmetrics from the metric namespaces that you specify here.

\n\t\t

You cannot include IncludeFilters and ExcludeFilters\n\t\tin the same operation.

" + "smithy.api#documentation": "

If you specify this parameter, the stream sends only the \n\t\tmetrics from the metric namespaces that you specify here.

\n

You cannot include IncludeFilters and ExcludeFilters\n\t\tin the same operation.

" } }, "ExcludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { - "smithy.api#documentation": "

If you specify this parameter, the stream sends metrics from all\n\t\t\tmetric namespaces except for the namespaces that you specify here.

\n\t\t

You cannot include ExcludeFilters and IncludeFilters in \n\t\t\tthe same operation.

" + "smithy.api#documentation": "

If you specify this parameter, the stream sends metrics from all\n\t\t\tmetric namespaces except for the namespaces that you specify here.

\n

You cannot include ExcludeFilters and IncludeFilters in \n\t\t\tthe same operation.

" } }, "FirehoseArn": { @@ -6936,7 +6950,7 @@ "RoleArn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data\n\t\t\tFirehose resources. This IAM role must already exist and must be in the same account as\n\t\t\tthe metric stream. This IAM role must include the following permissions:

\n\t\t ", + "smithy.api#documentation": "

The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data\n\t\t\tFirehose resources. This IAM role must already exist and must be in the same account as\n\t\t\tthe metric stream. This IAM role must include the following permissions:

\n ", "smithy.api#required": {} } }, @@ -6950,13 +6964,13 @@ "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the metric stream. You can associate as \n\t\t\tmany as 50 tags with a metric stream.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n\t\t

You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing metric stream, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the metric stream. You can associate as \n\t\t\tmany as 50 tags with a metric stream.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n

You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing metric stream, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" } }, "StatisticsConfigurations": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations", "traits": { - "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. This \n\t\t\tarray can have up to 100 members.

\n\t\t

For each entry in this array, you specify one or more metrics and the list of additional\n\t\t\tstatistics to stream for those metrics. The additional statistics that you can stream\n\t\t\tdepend on the stream's OutputFormat. If the OutputFormat is\n\t\t\t\tjson, you can stream any additional statistic that is supported by\n\t\t\t\tCloudWatch, listed in \n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat\n\t\t\tis opentelemetry0.7, you can stream percentile statistics such as p95,\n\t\t\tp99.9, and so on.

" + "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. This \n\t\t\tarray can have up to 100 members.

\n

For each entry in this array, you specify one or more metrics and the list of additional\n\t\t\tstatistics to stream for those metrics. The additional statistics that you can stream\n\t\t\tdepend on the stream's OutputFormat. If the OutputFormat is\n\t\t\t\tjson, you can stream any additional statistic that is supported by\n\t\t\t\tCloudWatch, listed in \n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat\n\t\t\tis opentelemetry0.7, you can stream percentile statistics such as p95,\n\t\t\tp99.9, and so on.

" } } } @@ -7112,7 +7126,7 @@ } ], "traits": { - "smithy.api#documentation": "

Temporarily sets the state of an alarm for testing purposes. When the updated\n\t\t\tstate differs from the previous value, the action configured for\n\t\t\tthe appropriate state is invoked. For example, if your alarm is configured to send an\n\t\t\tAmazon SNS message when an alarm is triggered, temporarily changing the alarm state to\n\t\t\tALARM sends an SNS message.

\n\t\t

Metric alarms\n\t\t\treturns to their actual state quickly, often within seconds. Because the metric alarm state change\n\t\t\thappens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through\n\t\t\tDescribeAlarmHistory.

\n\t\t

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return\n\t\t\tto its actual state. It\n\t\t\treturns to its actual state only once any of its children alarms change state. It is also\n\t\t\treevaluated if you update its\n\t\t\tconfiguration.

\n\t\t

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include\n\t\tinformation in the StateReasonData parameter to enable the policy to take the correct action.

" + "smithy.api#documentation": "

Temporarily sets the state of an alarm for testing purposes. When the updated\n\t\t\tstate differs from the previous value, the action configured for\n\t\t\tthe appropriate state is invoked. For example, if your alarm is configured to send an\n\t\t\tAmazon SNS message when an alarm is triggered, temporarily changing the alarm state to\n\t\t\tALARM sends an SNS message.

\n

Metric alarms\n\t\t\treturns to their actual state quickly, often within seconds. Because the metric alarm state change\n\t\t\thappens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through\n\t\t\tDescribeAlarmHistory.

\n

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return\n\t\t\tto its actual state. It\n\t\t\treturns to its actual state only once any of its children alarms change state. It is also\n\t\t\treevaluated if you update its\n\t\t\tconfiguration.

\n

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include\n\t\tinformation in the StateReasonData parameter to enable the policy to take the correct action.

" } }, "com.amazonaws.cloudwatch#SetAlarmStateInput": { @@ -7142,7 +7156,7 @@ "StateReasonData": { "target": "com.amazonaws.cloudwatch#StateReasonData", "traits": { - "smithy.api#documentation": "

The reason that this alarm is set to this specific state, in JSON format.

\n\t\t

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling\n\t\talarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

" + "smithy.api#documentation": "

The reason that this alarm is set to this specific state, in JSON format.

\n

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling\n\t\talarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

" } } } @@ -7381,7 +7395,7 @@ "Names": { "target": "com.amazonaws.cloudwatch#MetricStreamNames", "traits": { - "smithy.api#documentation": "

The array of the names of metric streams to start streaming.

\n\t\t

This is an \"all or nothing\" operation. If you do not have \n\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\tin the operation will start streaming.

", + "smithy.api#documentation": "

The array of the names of metric streams to start streaming.

\n

This is an \"all or nothing\" operation. If you do not have \n\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\tin the operation will start streaming.

", "smithy.api#required": {} } } @@ -7576,7 +7590,7 @@ "Names": { "target": "com.amazonaws.cloudwatch#MetricStreamNames", "traits": { - "smithy.api#documentation": "

The array of the names of metric streams to stop streaming.

\n\t\t

This is an \"all or nothing\" operation. If you do not have \n\t\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\t\tin the operation will stop streaming.

", + "smithy.api#documentation": "

The array of the names of metric streams to stop streaming.

\n

This is an \"all or nothing\" operation. If you do not have \n\t\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\t\tin the operation will stop streaming.

", "smithy.api#required": {} } } @@ -7663,7 +7677,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that \n\t\t\tcan be tagged are alarms and Contributor Insights rules.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n\t\t

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

\n\t\t

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, \n\t\t\tthis tag is appended to the list of tags associated\n\t\t\twith the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n\t\t\tthe previous value for that tag.

\n\t\t

You can associate as many as 50 tags with a CloudWatch resource.

" + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that \n\t\t\tcan be tagged are alarms and Contributor Insights rules.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

\n

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, \n\t\t\tthis tag is appended to the list of tags associated\n\t\t\twith the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n\t\t\tthe previous value for that tag.

\n

You can associate as many as 50 tags with a CloudWatch resource.

" } }, "com.amazonaws.cloudwatch#TagResourceInput": { @@ -7672,7 +7686,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're adding tags to.

\n\t\t

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n\t\t

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n\t\t

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're adding tags to.

\n

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", "smithy.api#required": {} } }, @@ -7761,7 +7775,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're removing tags from.

\n\t\t

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n\t\t

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n\t

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're removing tags from.

\n

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/codecatalyst.2022-09-28.json b/codegen/sdk-codegen/aws-models/codecatalyst.2022-09-28.json index 515bd2b4006..4910cba4fe7 100644 --- a/codegen/sdk-codegen/aws-models/codecatalyst.2022-09-28.json +++ b/codegen/sdk-codegen/aws-models/codecatalyst.2022-09-28.json @@ -5516,4 +5516,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json index d6056e584fa..4d860f8adb1 100644 --- a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json +++ b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json @@ -49,6 +49,56 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.connect#ActionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ActionSummary" + } + }, + "com.amazonaws.connect#ActionSummary": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.connect#ActionType", + "traits": { + "smithy.api#documentation": "

The action type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an action.

" + } + }, + "com.amazonaws.connect#ActionType": { + "type": "enum", + "members": { + "CREATE_TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_TASK" + } + }, + "ASSIGN_CONTACT_CATEGORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSIGN_CONTACT_CATEGORY" + } + }, + "GENERATE_EVENTBRIDGE_EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATE_EVENTBRIDGE_EVENT" + } + }, + "SEND_NOTIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEND_NOTIFICATION" + } + } + } + }, "com.amazonaws.connect#AfterContactWorkTimeLimit": { "type": "integer", "traits": { @@ -463,6 +513,9 @@ { "target": "com.amazonaws.connect#CreateRoutingProfile" }, + { + "target": "com.amazonaws.connect#CreateRule" + }, { "target": "com.amazonaws.connect#CreateSecurityProfile" }, @@ -502,6 +555,9 @@ { "target": "com.amazonaws.connect#DeleteQuickConnect" }, + { + "target": "com.amazonaws.connect#DeleteRule" + }, { "target": "com.amazonaws.connect#DeleteSecurityProfile" }, @@ -559,6 +615,9 @@ { "target": "com.amazonaws.connect#DescribeRoutingProfile" }, + { + "target": "com.amazonaws.connect#DescribeRule" + }, { "target": "com.amazonaws.connect#DescribeSecurityProfile" }, @@ -694,6 +753,9 @@ { "target": "com.amazonaws.connect#ListRoutingProfiles" }, + { + "target": "com.amazonaws.connect#ListRules" + }, { "target": "com.amazonaws.connect#ListSecurityKeys" }, @@ -862,6 +924,9 @@ { "target": "com.amazonaws.connect#UpdateRoutingProfileQueues" }, + { + "target": "com.amazonaws.connect#UpdateRule" + }, { "target": "com.amazonaws.connect#UpdateSecurityProfile" }, @@ -905,14 +970,14 @@ "name": "connect" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Connect is a cloud-based contact center solution that you use to set up and\n manage a customer contact center and provide reliable customer engagement at any scale.

\n

Amazon Connect provides metrics and real-time reporting that enable you to optimize\n contact routing. You can also resolve customer issues more efficiently by getting customers in\n touch with the appropriate agents.

\n

There are limits to the number of Amazon Connect resources that you can create. There\n are also limits to the number of requests that you can make per second. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.

\n

You can connect programmatically to an Amazon Web Services service by using an endpoint. For\n a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

\n \n

Working with flows? Check out the Amazon Connect Flow\n language.

\n ", + "smithy.api#documentation": "

Amazon Connect is a cloud-based contact center solution that you use to set up and\n manage a customer contact center and provide reliable customer engagement at any scale.

\n

Amazon Connect provides metrics and real-time reporting that enable you to optimize\n contact routing. You can also resolve customer issues more efficiently by getting customers in\n touch with the appropriate agents.

\n

There are limits to the number of Amazon Connect resources that you can create. There\n are also limits to the number of requests that you can make per second. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.

\n

You can connect programmatically to an Amazon Web Services service by using an endpoint. For\n a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

", "smithy.api#title": "Amazon Connect Service", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -961,15 +1026,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -1232,8 +1288,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -1245,8 +1301,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -1258,8 +1314,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -1271,8 +1327,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -1284,8 +1340,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -1297,8 +1353,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -1310,8 +1366,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -1323,8 +1379,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -1336,8 +1392,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -1349,8 +1405,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -1362,8 +1418,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -1375,8 +1431,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -1388,8 +1444,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -1401,8 +1457,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -1414,8 +1470,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -1427,8 +1483,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -1440,8 +1496,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "af-south-1" } }, @@ -1453,8 +1509,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -1466,8 +1522,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "af-south-1" } }, @@ -1479,8 +1535,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -1492,8 +1548,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -1505,8 +1561,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -1518,8 +1574,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -1531,8 +1587,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -1544,8 +1600,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -1557,8 +1613,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -1570,8 +1626,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -1583,8 +1639,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -1596,8 +1652,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -1609,8 +1665,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -1622,8 +1678,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -1635,8 +1691,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -1648,8 +1704,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -1661,8 +1717,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -1674,8 +1730,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -1687,8 +1743,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -1700,8 +1756,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -1713,8 +1769,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -1726,8 +1782,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -1739,8 +1795,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -1752,8 +1808,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -1765,8 +1821,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -1778,8 +1834,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -1791,8 +1847,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -1804,8 +1860,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -1817,8 +1873,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -1830,8 +1886,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -1843,8 +1899,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -1856,8 +1912,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -1868,8 +1924,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -1880,8 +1936,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -1916,6 +1972,13 @@ "com.amazonaws.connect#ApproximateTotalCount": { "type": "long" }, + "com.amazonaws.connect#AssignContactCategoryActionDefinition": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

This action must be set if TriggerEventSource is one of the following values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable. Contact is categorized using the rule name.

\n

\n RuleName is used as ContactCategory.

" + } + }, "com.amazonaws.connect#AssociateApprovedOrigin": { "type": "operation", "input": { @@ -2872,7 +2935,7 @@ } ], "traits": { - "smithy.api#documentation": "

Claims an available phone number to your Amazon Connect instance or traffic distribution\n group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

\n \n

You can call the DescribePhoneNumber API\n to verify the status of a previous ClaimPhoneNumber\n operation.

\n ", + "smithy.api#documentation": "

Claims an available phone number to your Amazon Connect instance or traffic distribution\n group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

\n

For more information about how to use this operation, see Claim a phone number in your\n country and Claim phone\n numbers to traffic distribution groups in the Amazon Connect Administrator\n Guide.

\n \n

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API\n to verify the status of a previous ClaimPhoneNumber\n operation.

\n ", "smithy.api#http": { "method": "POST", "uri": "/phone-number/claim", @@ -2912,7 +2975,7 @@ "ClientToken": { "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

\n \n

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

\n

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n

", "smithy.api#idempotencyToken": {} } } @@ -3452,7 +3515,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains summary information about a flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

" + "smithy.api#documentation": "

Contains summary information about a flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

" } }, "com.amazonaws.connect#ContactFlowSummaryList": { @@ -3682,6 +3745,15 @@ } } }, + "com.amazonaws.connect#Content": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.connect#ControlPlaneTagFilter": { "type": "structure", "members": { @@ -3845,7 +3917,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a flow for the specified Amazon Connect instance.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", + "smithy.api#documentation": "

Creates a flow for the specified Amazon Connect instance.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", "smithy.api#http": { "method": "PUT", "uri": "/contact-flows/{InstanceId}", @@ -4649,6 +4721,120 @@ } } }, + "com.amazonaws.connect#CreateRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateRuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a rule for the specified Amazon Connect instance.

\n

Use the Rules Function language to code conditions for the rule.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/rules/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateRuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#RuleName", + "traits": { + "smithy.api#documentation": "

A unique name for the rule.

", + "smithy.api#required": {} + } + }, + "TriggerEventSource": { + "target": "com.amazonaws.connect#RuleTriggerEventSource", + "traits": { + "smithy.api#documentation": "

The event source to trigger the rule.

", + "smithy.api#required": {} + } + }, + "Function": { + "target": "com.amazonaws.connect#RuleFunction", + "traits": { + "smithy.api#documentation": "

The conditions of the rule.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.connect#RuleActions", + "traits": { + "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#CreateRuleResponse": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", + "smithy.api#required": {} + } + }, + "RuleId": { + "target": "com.amazonaws.connect#RuleId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#CreateSecurityProfile": { "type": "operation", "input": { @@ -4744,7 +4930,7 @@ "TagRestrictedResources": { "target": "com.amazonaws.connect#TagRestrictedResourceList", "traits": { - "smithy.api#documentation": "

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

" + "smithy.api#documentation": "

The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | \n RoutingProfile\n

" } } } @@ -5990,6 +6176,61 @@ } } }, + "com.amazonaws.connect#DeleteRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteRuleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a rule for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/rules/{InstanceId}/{RuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteRuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RuleId": { + "target": "com.amazonaws.connect#RuleId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#DeleteSecurityProfile": { "type": "operation", "input": { @@ -6136,7 +6377,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is\n created.

\n\n

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in\n the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is\n created.

\n

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in\n the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "DELETE", "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}", @@ -6547,7 +6788,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", + "smithy.api#documentation": "

Describes the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", "smithy.api#http": { "method": "GET", "uri": "/contact-flows/{InstanceId}/{ContactFlowId}", @@ -7202,6 +7443,73 @@ } } }, + "com.amazonaws.connect#DescribeRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeRuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a rule for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/rules/{InstanceId}/{RuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeRuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RuleId": { + "target": "com.amazonaws.connect#RuleId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeRuleResponse": { + "type": "structure", + "members": { + "Rule": { + "target": "com.amazonaws.connect#Rule", + "traits": { + "smithy.api#documentation": "

Information about the rule.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#DescribeSecurityProfile": { "type": "operation", "input": { @@ -8241,7 +8549,7 @@ } ], "traits": { - "smithy.api#documentation": "

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which\n allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a\n MISSED, ERROR, ENDED, or REJECTED state in\n the Agent\n Event Stream.

", + "smithy.api#documentation": "

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which\n allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a\n MISSED, ERROR, ENDED, or REJECTED state in\n the Agent\n Event Stream.

", "smithy.api#http": { "method": "POST", "uri": "/users/{InstanceId}/{UserId}/contact", @@ -8388,6 +8696,71 @@ } } }, + "com.amazonaws.connect#EventBridgeActionDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#EventBridgeActionName", + "traits": { + "smithy.api#documentation": "

The name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The EventBridge action definition.

" + } + }, + "com.amazonaws.connect#EventBridgeActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#EventSourceName": { + "type": "enum", + "members": { + "OnPostCallAnalysisAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnPostCallAnalysisAvailable" + } + }, + "OnRealTimeCallAnalysisAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnRealTimeCallAnalysisAvailable" + } + }, + "OnPostChatAnalysisAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnPostChatAnalysisAvailable" + } + }, + "OnZendeskTicketCreate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnZendeskTicketCreate" + } + }, + "OnZendeskTicketStatusUpdate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnZendeskTicketStatusUpdate" + } + }, + "OnSalesforceCaseCreate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnSalesforceCaseCreate" + } + } + } + }, "com.amazonaws.connect#Filters": { "type": "structure", "members": { @@ -8543,13 +8916,13 @@ "Groupings": { "target": "com.amazonaws.connect#Groupings", "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when grouped by\n QUEUE, the metrics returned apply to each queue rather than aggregated for all\n queues.

\n " + "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when grouped by\n QUEUE, the metrics returned apply to each queue rather than aggregated for all\n queues.

\n " } }, "CurrentMetrics": { "target": "com.amazonaws.connect#CurrentMetrics", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

\n
\n
AGENTS_AFTER_CONTACT_WORK
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: ACW\n

\n\n
\n
AGENTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Available\n

\n
\n
AGENTS_ERROR
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Error\n

\n
\n
AGENTS_NON_PRODUCTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: NPT (Non-Productive Time)\n

\n
\n
AGENTS_ON_CALL
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ON_CONTACT
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ONLINE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Online\n

\n
\n
AGENTS_STAFFED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Staffed\n

\n
\n
CONTACTS_IN_QUEUE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: In\n queue\n

\n
\n
CONTACTS_SCHEDULED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Scheduled\n

\n
\n
OLDEST_CONTACT_AGE
\n
\n

Unit: SECONDS

\n

When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

\n

When you do not use groupings, Unit says SECONDS but the Value is returned in\n MILLISECONDS. For example, if you get a response like this:

\n

\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }

\n

The actual OLDEST_CONTACT_AGE is 24 seconds.

\n\n

Name in real-time metrics report: Oldest\n

\n
\n
SLOTS_ACTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Active\n

\n
\n
SLOTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Availability\n

\n
\n
", + "smithy.api#documentation": "

The metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

\n
\n
AGENTS_AFTER_CONTACT_WORK
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: ACW\n

\n
\n
AGENTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Available\n

\n
\n
AGENTS_ERROR
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Error\n

\n
\n
AGENTS_NON_PRODUCTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: NPT (Non-Productive Time)\n

\n
\n
AGENTS_ON_CALL
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ON_CONTACT
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ONLINE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Online\n

\n
\n
AGENTS_STAFFED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Staffed\n

\n
\n
CONTACTS_IN_QUEUE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: In\n queue\n

\n
\n
CONTACTS_SCHEDULED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Scheduled\n

\n
\n
OLDEST_CONTACT_AGE
\n
\n

Unit: SECONDS

\n

When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

\n

When you do not use groupings, Unit says SECONDS but the Value is returned in\n MILLISECONDS. For example, if you get a response like this:

\n

\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }

\n

The actual OLDEST_CONTACT_AGE is 24 seconds.

\n

Name in real-time metrics report: Oldest\n

\n
\n
SLOTS_ACTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Active\n

\n
\n
SLOTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Availability\n

\n
\n
", "smithy.api#required": {} } }, @@ -8785,7 +9158,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets historical metric data from the specified Amazon Connect instance.

\n\n

For a description of each historical metric, see Historical Metrics\n Definitions in the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Gets historical metric data from the specified Amazon Connect instance.

\n

For a description of each historical metric, see Historical Metrics\n Definitions in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/metrics/historical/{InstanceId}", @@ -8833,13 +9206,13 @@ "Groupings": { "target": "com.amazonaws.connect#Groupings", "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when results are grouped by\n queue, the metrics returned are grouped by queue. The values returned apply to the metrics for\n each queue rather than aggregated for all queues.

\n\n

If no grouping is specified, a summary of metrics for all queues is returned.

" + "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when results are grouped by\n queue, the metrics returned are grouped by queue. The values returned apply to the metrics for\n each queue rather than aggregated for all queues.

\n

If no grouping is specified, a summary of metrics for all queues is returned.

" } }, "HistoricalMetrics": { "target": "com.amazonaws.connect#HistoricalMetrics", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

\n \n

This API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

\n \n\n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
", + "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

\n \n

This API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

\n \n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
", "smithy.api#required": {} } }, @@ -11115,7 +11488,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the flows for the specified Amazon Connect instance.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

\n

For more information about flows, see Flows in the\n Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Provides information about the flows for the specified Amazon Connect instance.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

\n

For more information about flows, see Flows in the\n Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "GET", "uri": "/contact-flows-summary/{InstanceId}", @@ -11556,7 +11929,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n\n

Returns a paginated list of storage configs for the identified instance and resource\n type.

", + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of storage configs for the identified instance and resource\n type.

", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/storage-configs", @@ -11976,7 +12349,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the phone numbers for the specified Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.

\n\n \n

The phone number Arn value that is returned from each of the items in the\n PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with\n a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API.\n It returns the new phone number ARN that can be used to tag phone number resources.

\n ", + "smithy.api#documentation": "

Provides information about the phone numbers for the specified Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.

\n \n

The phone number Arn value that is returned from each of the items in the\n PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with\n a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API.\n It returns the new phone number ARN that can be used to tag phone number resources.

\n ", "smithy.api#http": { "method": "GET", "uri": "/phone-numbers-summary/{InstanceId}", @@ -12738,6 +13111,106 @@ } } }, + "com.amazonaws.connect#ListRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListRulesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

List all rules for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/rules/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RuleSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListRulesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

", + "smithy.api#httpQuery": "publishStatus" + } + }, + "EventSourceName": { + "target": "com.amazonaws.connect#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the event source.

", + "smithy.api#httpQuery": "eventSourceName" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult200", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.connect#ListRulesResponse": { + "type": "structure", + "members": { + "RuleSummaryList": { + "target": "com.amazonaws.connect#RuleSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information about a rule.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, "com.amazonaws.connect#ListSecurityKeys": { "type": "operation", "input": { @@ -13545,6 +14018,16 @@ } } }, + "com.amazonaws.connect#MaxResult200": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.connect#MaxResult25": { "type": "integer", "traits": { @@ -13656,7 +14139,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by \n userId will be set to silent monitoring mode on the contact.

", + "smithy.api#documentation": "

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user\n specified by userId will be set to silent monitoring mode on the\n contact.

", "smithy.api#http": { "method": "POST", "uri": "/contact/monitor", @@ -13670,7 +14153,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the\n instance.

", "smithy.api#required": {} } }, @@ -13691,7 +14174,7 @@ "AllowedMonitorCapabilities": { "target": "com.amazonaws.connect#AllowedMonitorCapabilities", "traits": { - "smithy.api#documentation": "

Specify which monitoring actions the user is allowed to take. For example, whether the user is \n allowed to escalate from silent monitoring to barge.

" + "smithy.api#documentation": "

Specify which monitoring actions the user is allowed to take. For example, whether the user\n is allowed to escalate from silent monitoring to barge.

" } }, "ClientToken": { @@ -13751,6 +14234,48 @@ } } }, + "com.amazonaws.connect#NotificationContentType": { + "type": "enum", + "members": { + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + } + } + }, + "com.amazonaws.connect#NotificationDeliveryType": { + "type": "enum", + "members": { + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + } + } + }, + "com.amazonaws.connect#NotificationRecipientType": { + "type": "structure", + "members": { + "UserTags": { + "target": "com.amazonaws.connect#UserTagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }. Amazon Connect users with the specified tags will be notified.

" + } + }, + "UserIds": { + "target": "com.amazonaws.connect#UserIdList", + "traits": { + "smithy.api#documentation": "

A list of user IDs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of notification recipient.

" + } + }, "com.amazonaws.connect#NumberReference": { "type": "structure", "members": { @@ -16779,7 +17304,7 @@ } ], "traits": { - "smithy.api#documentation": "

When a contact is being recorded, and the recording has been suspended using\n SuspendContactRecording, this API resumes recording the call.

\n\n

Only voice recordings are supported at this time.

", + "smithy.api#documentation": "

When a contact is being recorded, and the recording has been suspended using\n SuspendContactRecording, this API resumes recording the call.

\n

Only voice recordings are supported at this time.

", "smithy.api#http": { "method": "POST", "uri": "/contact/resume-recording", @@ -17047,90 +17572,349 @@ "Id": { "target": "com.amazonaws.connect#RoutingProfileId", "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

" + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the routing profile assigned to the user.

" + } + }, + "com.amazonaws.connect#RoutingProfileSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileSearchCriteria" + } + }, + "com.amazonaws.connect#RoutingProfileSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition" + } + }, + "traits": { + "smithy.api#documentation": "

The search criteria to be used to return routing profiles.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " + } + }, + "com.amazonaws.connect#RoutingProfileSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "com.amazonaws.connect#RoutingProfileSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#RoutingProfileName", + "traits": { + "smithy.api#documentation": "

The name of the routing profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about a routing profile.

" + } + }, + "com.amazonaws.connect#RoutingProfileSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileSummary" + } + }, + "com.amazonaws.connect#Rule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "RuleId": { + "target": "com.amazonaws.connect#RuleId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#required": {} + } + }, + "RuleArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", + "smithy.api#required": {} + } + }, + "TriggerEventSource": { + "target": "com.amazonaws.connect#RuleTriggerEventSource", + "traits": { + "smithy.api#documentation": "

The event source to trigger the rule.

", + "smithy.api#required": {} + } + }, + "Function": { + "target": "com.amazonaws.connect#RuleFunction", + "traits": { + "smithy.api#documentation": "

The conditions of the rule.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.connect#RuleActions", + "traits": { + "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the rule was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for the when the rule was last updated.

", + "smithy.api#required": {} + } + }, + "LastUpdatedBy": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the rule.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a rule.

" + } + }, + "com.amazonaws.connect#RuleAction": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.connect#ActionType", + "traits": { + "smithy.api#documentation": "

The type of action that creates a rule.

", + "smithy.api#required": {} + } + }, + "TaskAction": { + "target": "com.amazonaws.connect#TaskActionDefinition", + "traits": { + "smithy.api#documentation": "

Information about the task action. This field is required if TriggerEventSource\n is one of the following values: OnZendeskTicketCreate |\n OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate\n

" + } + }, + "EventBridgeAction": { + "target": "com.amazonaws.connect#EventBridgeActionDefinition", + "traits": { + "smithy.api#documentation": "

Information about the EventBridge action.

" + } + }, + "AssignContactCategoryAction": { + "target": "com.amazonaws.connect#AssignContactCategoryActionDefinition", + "traits": { + "smithy.api#documentation": "

Information about the contact category action.

" + } + }, + "SendNotificationAction": { + "target": "com.amazonaws.connect#SendNotificationActionDefinition", + "traits": { + "smithy.api#documentation": "

Information about the send notification action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the action to be performed when a rule is triggered.

" + } + }, + "com.amazonaws.connect#RuleActions": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RuleAction" + } + }, + "com.amazonaws.connect#RuleFunction": { + "type": "string" + }, + "com.amazonaws.connect#RuleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#RuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.connect#RulePublishStatus": { + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" } }, - "Arn": { - "target": "com.amazonaws.connect#ARN", + "PUBLISHED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + "smithy.api#enumValue": "PUBLISHED" } } - }, - "traits": { - "smithy.api#documentation": "

Information about the routing profile assigned to the user.

" - } - }, - "com.amazonaws.connect#RoutingProfileSearchConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileSearchCriteria" } }, - "com.amazonaws.connect#RoutingProfileSearchCriteria": { + "com.amazonaws.connect#RuleSummary": { "type": "structure", "members": { - "OrConditions": { - "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", + "Name": { + "target": "com.amazonaws.connect#RuleName", "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} } }, - "AndConditions": { - "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", + "RuleId": { + "target": "com.amazonaws.connect#RuleId", "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#required": {} } }, - "StringCondition": { - "target": "com.amazonaws.connect#StringCondition" + "RuleArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", + "smithy.api#required": {} + } + }, + "EventSourceName": { + "target": "com.amazonaws.connect#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the event source.

", + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

", + "smithy.api#required": {} + } + }, + "ActionSummaries": { + "target": "com.amazonaws.connect#ActionSummaries", + "traits": { + "smithy.api#documentation": "

A list of ActionTypes associated with a rule.

", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the rule was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the rule was last updated.

", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "

The search criteria to be used to return routing profiles.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " + "smithy.api#documentation": "

A list of ActionTypes associated with a rule.

" } }, - "com.amazonaws.connect#RoutingProfileSearchFilter": { - "type": "structure", - "members": { - "TagFilter": { - "target": "com.amazonaws.connect#ControlPlaneTagFilter" - } - }, - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" + "com.amazonaws.connect#RuleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RuleSummary" } }, - "com.amazonaws.connect#RoutingProfileSummary": { + "com.amazonaws.connect#RuleTriggerEventSource": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.connect#RoutingProfileId", + "EventSourceName": { + "target": "com.amazonaws.connect#EventSourceName", "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + "smithy.api#documentation": "

The name of the event source.

", + "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.connect#RoutingProfileName", + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", "traits": { - "smithy.api#documentation": "

The name of the routing profile.

" + "smithy.api#documentation": "

The identifier for the integration association.

" } } }, "traits": { - "smithy.api#documentation": "

Contains summary information about a routing profile.

" - } - }, - "com.amazonaws.connect#RoutingProfileSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileSummary" + "smithy.api#documentation": "

The name of the event source. This field is required if TriggerEventSource is one of the\n following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |\n OnSalesforceCaseCreate\n

" } }, "com.amazonaws.connect#S3Config": { @@ -17526,7 +18310,7 @@ "SearchCriteria": { "target": "com.amazonaws.connect#SecurityProfileSearchCriteria", "traits": { - "smithy.api#documentation": "

The search criteria to be used to return security profiles.

\n \n

The name field support \"contains\" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

\n \n \n

The currently supported value for FieldName: name\n

\n \n " + "smithy.api#documentation": "

The search criteria to be used to return security profiles.

\n \n

The name field support \"contains\" queries with a minimum of 2 characters and\n maximum of 25 characters. Any queries with character lengths outside of this range will throw\n invalid results.

\n \n \n

The currently supported value for FieldName: name\n

\n " } }, "SearchFilter": { @@ -17586,7 +18370,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches users in an Amazon Connect instance, with optional filtering.

\n \n \n

\n AfterContactWorkTimeLimit is returned in milliseconds.

\n ", + "smithy.api#documentation": "

Searches users in an Amazon Connect instance, with optional filtering.

\n \n

\n AfterContactWorkTimeLimit is returned in milliseconds.

\n ", "smithy.api#http": { "method": "POST", "uri": "/search-users", @@ -17933,7 +18717,7 @@ } }, "traits": { - "smithy.api#documentation": "

The search criteria to be used to return security profiles.

\n \n

The name field support \"contains\" queries with a minimum of 2 characters and\n maximum of 25 characters. Any queries with character lengths outside of this range will throw\n invalid results.

\n " + "smithy.api#documentation": "

The search criteria to be used to return security profiles.

\n \n

The name field support \"contains\" queries with a minimum of 2 characters and\n maximum of 25 characters. Any queries with character lengths outside of this range will throw\n invalid results.

\n " } }, "com.amazonaws.connect#SecurityProfileSearchSummary": { @@ -18035,6 +18819,48 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.connect#SendNotificationActionDefinition": { + "type": "structure", + "members": { + "DeliveryMethod": { + "target": "com.amazonaws.connect#NotificationDeliveryType", + "traits": { + "smithy.api#documentation": "

Notification delivery method.

", + "smithy.api#required": {} + } + }, + "Subject": { + "target": "com.amazonaws.connect#Subject", + "traits": { + "smithy.api#documentation": "

The subject of the email if the delivery method is EMAIL.\n Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#Content", + "traits": { + "smithy.api#documentation": "

Notification content. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.connect#NotificationContentType", + "traits": { + "smithy.api#documentation": "

Content type format.

", + "smithy.api#required": {} + } + }, + "Recipient": { + "target": "com.amazonaws.connect#NotificationRecipientType", + "traits": { + "smithy.api#documentation": "

Notification recipient.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the send notification action.

" + } + }, "com.amazonaws.connect#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -18110,7 +18936,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n\n

When a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n\n

A 429 error occurs in the following situations:

\n \n

If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.

\n\n

For more information about chat, see Chat in the Amazon Connect\n Administrator Guide.

", + "smithy.api#documentation": "

Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n

When a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n

A 429 error occurs in the following situations:

\n \n

If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.

\n

For more information about chat, see Chat in the Amazon Connect\n Administrator Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/contact/chat", @@ -18221,7 +19047,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts recording the contact:

\n \n\n

StartContactRecording is a one-time action. For example, if you use StopContactRecording to\n stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios\n where the recording has started and you want to suspend and resume it, such as when collecting\n sensitive information (for example, a credit card number), use SuspendContactRecording and\n 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

StartContactRecording is a one-time action. For example, if you use StopContactRecording to\n stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios\n where the recording has started and you want to suspend and resume it, such as when collecting\n sensitive information (for example, a credit card number), use SuspendContactRecording and\n 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", @@ -18378,7 +19204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Places an outbound call to a contact, and then initiates the flow. It performs the actions\n in the flow that's specified (in ContactFlowId).

\n\n

Agents do not initiate the outbound API, which means that they do not dial the contact. If\n the flow places an outbound call to a contact, and then puts the contact in queue, the call is\n then routed to the agent, like any other inbound case.

\n\n

There is a 60-second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.

\n \n

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.

\n \n \n

Campaign calls are not allowed by default. Before you can make a call with\n TrafficType = CAMPAIGN, you must submit a service quota increase\n request to the quota Amazon Connect campaigns.

\n ", + "smithy.api#documentation": "

Places an outbound call to a contact, and then initiates the flow. It performs the actions\n in the flow that's specified (in ContactFlowId).

\n

Agents do not initiate the outbound API, which means that they do not dial the contact. If\n the flow places an outbound call to a contact, and then puts the contact in queue, the call is\n then routed to the agent, like any other inbound case.

\n

There is a 60-second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.

\n \n

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.

\n \n \n

Campaign calls are not allowed by default. Before you can make a call with\n TrafficType = CAMPAIGN, you must submit a service quota increase\n request to the quota Amazon Connect campaigns.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/contact/outbound-voice", @@ -18637,7 +19463,7 @@ } ], "traits": { - "smithy.api#documentation": "

Ends the specified contact. This call does not work for the following initiation\n methods:

\n \n ", + "smithy.api#documentation": "

Ends the specified contact. This call does not work for the following initiation\n methods:

\n ", "smithy.api#http": { "method": "POST", "uri": "/contact/stop", @@ -18665,7 +19491,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time\n action. If you use StopContactRecording to stop recording an ongoing call, you can't use\n StartContactRecording to restart it. For scenarios where the recording has started and you want\n to suspend it for sensitive information (for example, to collect a credit card number), and then\n restart it, use SuspendContactRecording and ResumeContactRecording.

\n\n

Only voice recordings are supported at this time.

", + "smithy.api#documentation": "

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time\n action. If you use StopContactRecording to stop recording an ongoing call, you can't use\n StartContactRecording to restart it. For scenarios where the recording has started and you want\n to suspend it for sensitive information (for example, to collect a credit card number), and then\n restart it, use SuspendContactRecording and ResumeContactRecording.

\n

Only voice recordings are supported at this time.

", "smithy.api#http": { "method": "POST", "uri": "/contact/stop-recording", @@ -18874,7 +19700,7 @@ } }, "traits": { - "smithy.api#documentation": "

A leaf node condition which can be used to specify a string condition.

\n \n

The currently supported value for FieldName: name\n

\n \n " + "smithy.api#documentation": "

A leaf node condition which can be used to specify a string condition.

\n \n

The currently supported value for FieldName: name\n

\n " } }, "com.amazonaws.connect#StringReference": { @@ -18897,6 +19723,15 @@ "smithy.api#documentation": "

Information about a reference when the referenceType is STRING.\n Otherwise, null.

" } }, + "com.amazonaws.connect#Subject": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.connect#SupportedMessagingContentType": { "type": "string", "traits": { @@ -19123,6 +19958,58 @@ } } }, + "com.amazonaws.connect#TaskActionDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#TaskNameExpression", + "traits": { + "smithy.api#documentation": "

The name. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskDescriptionExpression", + "traits": { + "smithy.api#documentation": "

The description. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

", + "smithy.api#required": {} + } + }, + "References": { + "target": "com.amazonaws.connect#ContactReferences", + "traits": { + "smithy.api#documentation": "

Information about the reference when the referenceType is URL.\n Otherwise, null. (Supports variable injection in the Value field.)

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the task action.

" + } + }, + "com.amazonaws.connect#TaskDescriptionExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.connect#TaskNameExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, "com.amazonaws.connect#TaskTemplateArn": { "type": "string", "traits": { @@ -20115,7 +21002,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", + "smithy.api#documentation": "

Updates the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", "smithy.api#http": { "method": "POST", "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/content", @@ -20145,7 +21032,7 @@ "Content": { "target": "com.amazonaws.connect#ContactFlowContent", "traits": { - "smithy.api#documentation": "

The JSON string that represents flow's content. For an example, see Example contact\n flow in Amazon Connect Flow language in the Amazon Connect\n Administrator Guide.

", + "smithy.api#documentation": "

The JSON string that represents flow's content. For an example, see Example contact\n flow in Amazon Connect Flow language.

", "smithy.api#required": {} } } @@ -20408,7 +21295,7 @@ } ], "traits": { - "smithy.api#documentation": "

The name of the flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", + "smithy.api#documentation": "

The name of the flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", "smithy.api#http": { "method": "POST", "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/name", @@ -21577,6 +22464,92 @@ } } }, + "com.amazonaws.connect#UpdateRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateRuleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a rule for the specified Amazon Connect instance.

\n

Use the Rules Function language to code conditions for the rule.\n

", + "smithy.api#http": { + "method": "PUT", + "uri": "/rules/{InstanceId}/{RuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateRuleRequest": { + "type": "structure", + "members": { + "RuleId": { + "target": "com.amazonaws.connect#RuleId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule. You can change the name only if TriggerEventSource is one\n of the following values: OnZendeskTicketCreate |\n OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate\n

", + "smithy.api#required": {} + } + }, + "Function": { + "target": "com.amazonaws.connect#RuleFunction", + "traits": { + "smithy.api#documentation": "

The conditions of the rule.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.connect#RuleActions", + "traits": { + "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#UpdateSecurityProfile": { "type": "operation", "input": { @@ -21862,7 +22835,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the traffic distribution for a given traffic distribution group.

\n\n

For more information about updating a traffic distribution group, see Update telephony\n traffic distribution across Amazon Web Services Regions\n in the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Updates the traffic distribution for a given traffic distribution group.

\n

For more information about updating a traffic distribution group, see Update telephony\n traffic distribution across Amazon Web Services Regions\n in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/traffic-distribution/{Id}", @@ -22558,6 +23531,12 @@ "com.amazonaws.connect#UserId": { "type": "string" }, + "com.amazonaws.connect#UserIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserId" + } + }, "com.amazonaws.connect#UserIdentityInfo": { "type": "structure", "members": { @@ -22650,7 +23629,7 @@ "target": "com.amazonaws.connect#AfterContactWorkTimeLimit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The After Call Work (ACW) timeout setting, in seconds.

\n \n \n

When returned by a SearchUsers call, AfterContactWorkTimeLimit is\n returned in milliseconds.

\n " + "smithy.api#documentation": "

The After Call Work (ACW) timeout setting, in seconds.

\n \n

When returned by a SearchUsers call, AfterContactWorkTimeLimit is\n returned in milliseconds.

\n " } }, "DeskPhoneNumber": { @@ -22741,7 +23720,7 @@ } }, "traits": { - "smithy.api#documentation": "

The search criteria to be used to return users.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results. \n

\n " + "smithy.api#documentation": "

The search criteria to be used to return users.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " } }, "com.amazonaws.connect#UserSearchFilter": { @@ -22858,6 +23837,15 @@ "target": "com.amazonaws.connect#UserSummary" } }, + "com.amazonaws.connect#UserTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#String" + }, + "value": { + "target": "com.amazonaws.connect#String" + } + }, "com.amazonaws.connect#Value": { "type": "double" }, @@ -23078,6 +24066,18 @@ "traits": { "smithy.api#enumValue": "zh-CN" } + }, + "EN_NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-NZ" + } + }, + "EN_ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-ZA" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/connectcases.2022-10-03.json b/codegen/sdk-codegen/aws-models/connectcases.2022-10-03.json index 989bd56ac9d..60a2e150cc5 100644 --- a/codegen/sdk-codegen/aws-models/connectcases.2022-10-03.json +++ b/codegen/sdk-codegen/aws-models/connectcases.2022-10-03.json @@ -4946,4 +4946,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/cost-explorer.2017-10-25.json b/codegen/sdk-codegen/aws-models/cost-explorer.2017-10-25.json index c52c0586a23..69e16371a73 100644 --- a/codegen/sdk-codegen/aws-models/cost-explorer.2017-10-25.json +++ b/codegen/sdk-codegen/aws-models/cost-explorer.2017-10-25.json @@ -1020,9 +1020,9 @@ "properties": { "authSchemes": [ { + "signingRegion": "cn-northwest-1", "name": "sigv4", - "signingName": "ce", - "signingRegion": "cn-northwest-1" + "signingName": "ce" } ] }, @@ -1042,9 +1042,9 @@ "properties": { "authSchemes": [ { + "signingRegion": "us-east-1", "name": "sigv4", - "signingName": "ce", - "signingRegion": "us-east-1" + "signingName": "ce" } ] }, @@ -1363,8 +1363,10 @@ "Threshold": { "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", "traits": { - "smithy.api#documentation": "

The dollar value that triggers a notification if the threshold is exceeded.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Threshold has been deprecated in favor of ThresholdExpression" + }, + "smithy.api#documentation": "

(deprecated)

\n

The dollar value that triggers a notification if the threshold is exceeded.

\n

This field has been deprecated. To specify a threshold, use ThresholdExpression.\n Continued use of Threshold will be treated as shorthand syntax for a\n ThresholdExpression.

\n

One of Threshold or ThresholdExpression is required for this resource.

" } }, "Frequency": { @@ -1380,6 +1382,12 @@ "smithy.api#documentation": "

The name for the subscription.

", "smithy.api#required": {} } + }, + "ThresholdExpression": { + "target": "com.amazonaws.costexplorer#Expression", + "traits": { + "smithy.api#documentation": "

An Expression\n object used to specify the anomalies that you want to generate alerts for. This supports\n dimensions and nested expressions. The supported dimensions are\n ANOMALY_TOTAL_IMPACT_ABSOLUTE and\n ANOMALY_TOTAL_IMPACT_PERCENTAGE. The supported nested expression types\n are AND and OR. The match option\n GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and\n 10,000,000,000.

\n

One of Threshold or ThresholdExpression is required for this resource.

\n

The following are examples of valid ThresholdExpressions:

\n " + } } }, "traits": { @@ -1674,7 +1682,7 @@ "DimensionName": { "target": "com.amazonaws.costexplorer#CostCategoryInheritedValueDimensionName", "traits": { - "smithy.api#documentation": "

The name of the dimension that's used to group costs.

\n

If you specify LINKED_ACCOUNT_NAME, the cost category value is based on\n account name. If you specify TAG, the cost category value is based on the\n value of the specified tag key.

" + "smithy.api#documentation": "

The name of the dimension that's used to group costs.

\n

If you specify LINKED_ACCOUNT_NAME, the cost category value is based on\n account name. If you specify TAG, the cost category value is based on the\n value of the specified tag key.

" } }, "DimensionKey": { @@ -1806,7 +1814,7 @@ } }, "traits": { - "smithy.api#documentation": "

A reference to a Cost Category containing only enough information to identify the Cost\n Category.

\n

You can use this information to retrieve the full Cost Category information using\n DescribeCostCategory.

" + "smithy.api#documentation": "

A reference to a Cost Category containing only enough information to identify the Cost\n Category.

\n

You can use this information to retrieve the full Cost Category information using\n DescribeCostCategory.

" } }, "com.amazonaws.costexplorer#CostCategoryReferencesList": { @@ -1824,7 +1832,7 @@ "Rule": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

An Expression\n object used to categorize costs. This supports dimensions, tags, and nested expressions.\n Currently the only dimensions supported are LINKED_ACCOUNT,\n SERVICE_CODE, RECORD_TYPE, and\n LINKED_ACCOUNT_NAME.

\n

Root level OR isn't supported. We recommend that you create a separate\n rule instead.

\n

\n RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also\n supported for Cost Category expressions. This dimension uses different terms, depending\n on whether you're using the console or API/JSON editor. For a detailed comparison, see\n Term Comparisons in the Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

An Expression\n object used to categorize costs. This supports dimensions, tags, and nested expressions.\n Currently the only dimensions supported are LINKED_ACCOUNT,\n SERVICE_CODE, RECORD_TYPE, and\n LINKED_ACCOUNT_NAME.

\n

Root level OR isn't supported. We recommend that you create a separate\n rule instead.

\n

\n RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also\n supported for Cost Category expressions. This dimension uses different terms, depending\n on whether you're using the console or API/JSON editor. For a detailed comparison, see\n Term Comparisons in the Billing and Cost Management User\n Guide.

" } }, "InheritedValue": { @@ -1930,7 +1938,7 @@ "Method": { "target": "com.amazonaws.costexplorer#CostCategorySplitChargeMethod", "traits": { - "smithy.api#documentation": "

The method that's used to define how to split your source costs across your targets.

\n

\n Proportional - Allocates charges across your targets based on the\n proportional weighted cost of each target.

\n

\n Fixed - Allocates charges across your targets based on your defined\n allocation percentage.

\n

>Even - Allocates costs evenly across all targets.

", + "smithy.api#documentation": "

The method that's used to define how to split your source costs across your targets.

\n

\n Proportional - Allocates charges across your targets based on the\n proportional weighted cost of each target.

\n

\n Fixed - Allocates charges across your targets based on your defined\n allocation percentage.

\n

>Even - Allocates costs evenly across all targets.

", "smithy.api#required": {} } }, @@ -2085,7 +2093,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Cost Categories values used for filtering the costs.

\n

If Values and Key are not specified, the ABSENT\n MatchOption is applied to all Cost Categories. That is, it filters on\n resources that aren't mapped to any Cost Categories.

\n

If Values is provided and Key isn't specified, the\n ABSENT\n MatchOption is applied to the Cost Categories Key only. That\n is, it filters on resources without the given Cost Categories key.

" + "smithy.api#documentation": "

The Cost Categories values used for filtering the costs.

\n

If Values and Key are not specified, the ABSENT\n MatchOption is applied to all Cost Categories. That is, it filters on\n resources that aren't mapped to any Cost Categories.

\n

If Values is provided and Key isn't specified, the\n ABSENT\n MatchOption is applied to the Cost Categories Key only. That\n is, it filters on resources without the given Cost Categories key.

" } }, "com.amazonaws.costexplorer#CostCategoryValuesList": { @@ -2224,7 +2232,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of instance usage, in normalized units. You can use normalized units to see\n your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose\n that you run an xlarge instance and a 2xlarge instance. If you run both instances for\n the same amount of time, the 2xlarge instance uses twice as much of your reservation as\n the xlarge instance, even though both instances show only one instance-hour. When you\n use normalized units instead of instance-hours, the xlarge instance used 8 normalized\n units, and the 2xlarge instance used 16 normalized units.

\n

For more information, see Modifying Reserved Instances\n in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances.

" + "smithy.api#documentation": "

The amount of instance usage, in normalized units. You can use normalized units to see\n your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose\n that you run an xlarge instance and a 2xlarge instance. If you run both instances for\n the same amount of time, the 2xlarge instance uses twice as much of your reservation as\n the xlarge instance, even though both instances show only one instance-hour. When you\n use normalized units instead of instance-hours, the xlarge instance used 8 normalized\n units, and the 2xlarge instance used 16 normalized units.

\n

For more information, see Modifying Reserved Instances\n in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances.

" } }, "com.amazonaws.costexplorer#CoverageNormalizedUnitsPercentage": { @@ -2300,7 +2308,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a subscription to a cost anomaly detection monitor. You can use each subscription to\n define subscribers with email or SNS notifications. Email subscribers can set a dollar\n threshold and a time frequency for receiving notifications.

" + "smithy.api#documentation": "

Adds an alert subscription to a cost anomaly detection monitor. You can use each\n subscription to define subscribers with email or SNS notifications. Email subscribers can set\n an absolute or percentage threshold and a time frequency for receiving notifications.

" } }, "com.amazonaws.costexplorer#CreateAnomalySubscriptionRequest": { @@ -2884,6 +2892,18 @@ "traits": { "smithy.api#enumValue": "INVOICING_ENTITY" } + }, + "ANOMALY_TOTAL_IMPACT_ABSOLUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALY_TOTAL_IMPACT_ABSOLUTE" + } + }, + "ANOMALY_TOTAL_IMPACT_PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALY_TOTAL_IMPACT_PERCENTAGE" + } } } }, @@ -2893,7 +2913,7 @@ "Key": { "target": "com.amazonaws.costexplorer#Dimension", "traits": { - "smithy.api#documentation": "

The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones.\n LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in\n CostCategoryRule.

" + "smithy.api#documentation": "

The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones.

\n

Not all dimensions are supported in each API. Refer to the documentation for each\n specific API to see what is supported.

\n

\n LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in\n CostCategoryRule.

\n

\n ANOMALY_TOTAL_IMPACT_ABSOLUTE and\n ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

" } }, "Values": { @@ -2905,7 +2925,7 @@ "MatchOptions": { "target": "com.amazonaws.costexplorer#MatchOptions", "traits": { - "smithy.api#documentation": "

The match options that you can use to filter your results. MatchOptions\n is only applicable for actions related to Cost Category. The default values for\n MatchOptions are EQUALS and\n CASE_SENSITIVE.

" + "smithy.api#documentation": "

The match options that you can use to filter your results.

\n

\n MatchOptions is only applicable for actions related to Cost Category and\n Anomaly Subscriptions. Refer to the documentation for each specific API to see what is\n supported.

\n

The default values for MatchOptions are EQUALS and\n CASE_SENSITIVE.

" } } }, @@ -3320,7 +3340,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use Expression to filter by cost or by usage. There are two patterns:

\n \n \n

For the GetRightsizingRecommendation action, a combination of OR and\n NOT isn't supported. OR isn't supported between different dimensions, or dimensions\n and tags. NOT operators aren't supported. Dimensions are also limited to\n LINKED_ACCOUNT, REGION, or\n RIGHTSIZING_TYPE.

\n

For the GetReservationPurchaseRecommendation action, only NOT is\n supported. AND and OR aren't supported. Dimensions are limited to\n LINKED_ACCOUNT.

\n " + "smithy.api#documentation": "

Use Expression to filter in various Cost Explorer APIs.

\n

Not all Expression types are supported in each API. Refer to the\n documentation for each specific API to see what is supported.

\n

There are two patterns:

\n \n \n

For the GetRightsizingRecommendation action, a combination of OR and\n NOT isn't supported. OR isn't supported between different dimensions, or dimensions\n and tags. NOT operators aren't supported. Dimensions are also limited to\n LINKED_ACCOUNT, REGION, or\n RIGHTSIZING_TYPE.

\n

For the GetReservationPurchaseRecommendation action, only NOT is\n supported. AND and OR aren't supported. Dimensions are limited to\n LINKED_ACCOUNT.

\n " } }, "com.amazonaws.costexplorer#Expressions": { @@ -3593,7 +3613,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account during the time period that's\n specified by the DateInterval object.

" + "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account during the time period that's\n specified by the DateInterval object. Anomalies are available for up to 90\n days.

" } }, "com.amazonaws.costexplorer#GetAnomaliesRequest": { @@ -4149,7 +4169,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

The filters that you want to use to filter your forecast. The\n GetCostForecast API supports filtering by the following dimensions:

\n \n " + "smithy.api#documentation": "

The filters that you want to use to filter your forecast. The\n GetCostForecast API supports filtering by the following dimensions:

\n " } }, "PredictionIntervalLevel": { @@ -5219,7 +5239,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

The filters that you want to use to filter your forecast. The\n GetUsageForecast API supports filtering by the following dimensions:

\n \n " + "smithy.api#documentation": "

The filters that you want to use to filter your forecast. The\n GetUsageForecast API supports filtering by the following dimensions:

\n " } }, "PredictionIntervalLevel": { @@ -5362,7 +5382,7 @@ "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum dollar value that's observed for an anomaly.

", + "smithy.api#documentation": "

The maximum dollar value that's observed for an anomaly.

", "smithy.api#required": {} } }, @@ -5370,7 +5390,25 @@ "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The cumulative dollar value that's observed for an anomaly.

" + "smithy.api#documentation": "

The cumulative dollar difference between the total actual spend and total expected\n spend. It is calculated as TotalActualSpend - TotalExpectedSpend.

" + } + }, + "TotalActualSpend": { + "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The cumulative dollar amount that was actually spent during the anomaly.

" + } + }, + "TotalExpectedSpend": { + "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The cumulative dollar amount that was expected to be spent during the anomaly. It is\n calculated using advanced machine learning models to determine the typical spending\n pattern based on historical data for a customer.

" + } + }, + "TotalImpactPercentage": { + "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The cumulative percentage difference between the total actual spend and total expected\n spend. It is calculated as (TotalImpact / TotalExpectedSpend) * 100. When\n TotalExpectedSpend is zero, this field is omitted. Expected spend can\n be zero in situations such as when you start to use a service for the first time.

" } } }, @@ -5767,6 +5805,12 @@ "traits": { "smithy.api#enumValue": "CASE_INSENSITIVE" } + }, + "GREATER_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUAL" + } } } }, @@ -6831,7 +6875,7 @@ } }, "traits": { - "smithy.api#documentation": "

The tag structure that contains a tag key and value.

\n \n

Tagging is supported only for the following Cost Explorer resource types:\n \n AnomalyMonitor\n , \n AnomalySubscription\n , \n CostCategory\n .

\n " + "smithy.api#documentation": "

The tag structure that contains a tag key and value.

\n \n

Tagging is supported only for the following Cost Explorer resource types:\n \n AnomalyMonitor\n , \n AnomalySubscription\n , \n CostCategory\n .

\n " } }, "com.amazonaws.costexplorer#ResourceTagKey": { @@ -7111,10 +7155,16 @@ "traits": { "smithy.api#documentation": "

The UsageType value that's associated with the cost anomaly.

" } + }, + "LinkedAccountName": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The member account name value that's associated with the cost anomaly.

" + } } }, "traits": { - "smithy.api#documentation": "

The combination of Amazon Web Service, linked account, Region, and usage type\n where a cost anomaly is observed.

" + "smithy.api#documentation": "

The combination of Amazon Web Service, linked account, linked account name,\n Region, and usage type where a cost anomaly is observed. The linked account name will\n only be available when the account name can be identified.

" } }, "com.amazonaws.costexplorer#RootCauses": { @@ -8021,7 +8071,7 @@ } }, "traits": { - "smithy.api#documentation": "

The values that are available for a tag.

\n

If Values and Key aren't specified, the ABSENT\n MatchOption is applied to all tags. That is, it's filtered on resources\n with no tags.

\n

If Key is provided and Values isn't specified, the\n ABSENT\n MatchOption is applied to the tag Key only. That is, it's\n filtered on resources without the given tag key.

" + "smithy.api#documentation": "

The values that are available for a tag.

\n

If Values and Key aren't specified, the ABSENT\n MatchOption is applied to all tags. That is, it's filtered on resources\n with no tags.

\n

If Key is provided and Values isn't specified, the\n ABSENT\n MatchOption is applied to the tag Key only. That is, it's\n filtered on resources without the given tag key.

" } }, "com.amazonaws.costexplorer#TagValuesList": { @@ -8364,7 +8414,10 @@ "Threshold": { "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", "traits": { - "smithy.api#documentation": "

The update to the threshold value for receiving notifications.

" + "smithy.api#deprecated": { + "message": "Threshold has been deprecated in favor of ThresholdExpression" + }, + "smithy.api#documentation": "

(deprecated)

\n

The update to the threshold value for receiving notifications.

\n

This field has been deprecated. To update a threshold, use ThresholdExpression. Continued\n use of Threshold will be treated as shorthand syntax for a ThresholdExpression.

" } }, "Frequency": { @@ -8390,6 +8443,12 @@ "traits": { "smithy.api#documentation": "

The new name of the subscription.

" } + }, + "ThresholdExpression": { + "target": "com.amazonaws.costexplorer#Expression", + "traits": { + "smithy.api#documentation": "

The update to the Expression object\n used to specify the anomalies that you want to generate alerts for. This supports dimensions\n and nested expressions. The supported dimensions are\n ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE.\n The supported nested expression types are AND and OR. The match\n option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and\n 10,000,000,000.

\n

The following are examples of valid ThresholdExpressions:

\n " + } } } }, diff --git a/codegen/sdk-codegen/aws-models/customer-profiles.2020-08-15.json b/codegen/sdk-codegen/aws-models/customer-profiles.2020-08-15.json index 8d86d781f9c..acf24ab8719 100644 --- a/codegen/sdk-codegen/aws-models/customer-profiles.2020-08-15.json +++ b/codegen/sdk-codegen/aws-models/customer-profiles.2020-08-15.json @@ -980,6 +980,18 @@ "traits": { "smithy.api#documentation": "

A key value pair of attributes of a customer profile.

" } + }, + "PartyTypeString": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

An alternative to PartyType which accepts any string as input.

" + } + }, + "GenderString": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

An alternative to Gender which accepts any string as input.

" + } } } }, @@ -1133,7 +1145,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -1182,15 +1194,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -1454,8 +1457,8 @@ }, "params": { "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ca-central-1" } }, { @@ -1467,8 +1470,8 @@ }, "params": { "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ca-central-1" } }, { @@ -1480,8 +1483,8 @@ }, "params": { "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ca-central-1" } }, { @@ -1493,8 +1496,8 @@ }, "params": { "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ca-central-1" } }, { @@ -1506,8 +1509,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -1519,8 +1522,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -1532,8 +1535,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -1545,8 +1548,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -1558,8 +1561,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -1571,8 +1574,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -1584,8 +1587,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -1597,8 +1600,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -1610,8 +1613,8 @@ }, "params": { "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "af-south-1" } }, { @@ -1623,8 +1626,8 @@ }, "params": { "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "af-south-1" } }, { @@ -1636,8 +1639,8 @@ }, "params": { "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "af-south-1" } }, { @@ -1649,8 +1652,8 @@ }, "params": { "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "af-south-1" } }, { @@ -1662,8 +1665,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-2" } }, { @@ -1675,8 +1678,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-2" } }, { @@ -1688,8 +1691,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-2" } }, { @@ -1701,8 +1704,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-2" } }, { @@ -1714,8 +1717,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-2" } }, { @@ -1727,8 +1730,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-2" } }, { @@ -1740,8 +1743,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-2" } }, { @@ -1753,8 +1756,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-2" } }, { @@ -1766,8 +1769,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-1" } }, { @@ -1779,8 +1782,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { @@ -1792,8 +1795,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-1" } }, { @@ -1805,8 +1808,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { @@ -1818,8 +1821,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -1831,8 +1834,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -1844,8 +1847,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -1857,8 +1860,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -1870,8 +1873,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -1883,8 +1886,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -1896,8 +1899,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -1909,8 +1912,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -1922,8 +1925,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -1935,8 +1938,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -1948,8 +1951,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -1961,8 +1964,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -1974,8 +1977,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1986,8 +1989,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1998,8 +2001,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -2926,7 +2929,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly\n selects a sample of matching groups from the existing matching results, and applies the\n automerging settings that you provided. You can then view the number of profiles in the\n sample, the number of matches, and the number of profiles identified to be merged. This\n enables you to evaluate the accuracy of the attributes in your matching list.

\n

You can't view which profiles are matched and would be merged.

\n \n \n

We strongly recommend you use this API to do a dry run of the automerging process\n before running the Identity Resolution Job. Include at least two matching\n attributes. If your matching list includes too few attributes (such as only\n FirstName or only LastName), there may be a large number of\n matches. This increases the chances of erroneous merges.

\n ", + "smithy.api#documentation": "

Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly\n selects a sample of matching groups from the existing matching results, and applies the\n automerging settings that you provided. You can then view the number of profiles in the\n sample, the number of matches, and the number of profiles identified to be merged. This\n enables you to evaluate the accuracy of the attributes in your matching list.

\n

You can't view which profiles are matched and would be merged.

\n \n

We strongly recommend you use this API to do a dry run of the automerging process\n before running the Identity Resolution Job. Include at least two matching\n attributes. If your matching list includes too few attributes (such as only\n FirstName or only LastName), there may be a large number of\n matches. This increases the chances of erroneous merges.

\n ", "smithy.api#http": { "method": "POST", "uri": "/domains/{DomainName}/identity-resolution-jobs/auto-merging-preview", @@ -3378,7 +3381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.

\n

GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.

\n \n

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.

\n

After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.

\n \n\n

Amazon Connect uses the following profile attributes to identify matches:

\n \n

For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

", + "smithy.api#documentation": "

Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.

\n

GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.

\n \n

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.

\n

After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.

\n \n

Amazon Connect uses the following profile attributes to identify matches:

\n \n

For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

", "smithy.api#http": { "method": "GET", "uri": "/domains/{DomainName}/matches", @@ -5381,7 +5384,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs an AWS Lambda job that does the following:

\n
    \n
  1. \n

    All the profileKeys in the ProfileToBeMerged will be moved to the\n main profile.

    \n
    2. \n
  2. \n

    All the objects in the ProfileToBeMerged will be moved to the main\n profile.

    \n
    3. \n
  3. \n

    All the ProfileToBeMerged will be deleted at the end.

    \n
    4. \n
  4. \n

    All the profileKeys in the ProfileIdsToBeMerged will be moved to the\n main profile.

    \n
    5. \n
  5. \n

    Standard fields are merged as follows:

    \n
      \n
    1. \n

      Fields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.

      \n
      2. \n
    2. \n

      When there are conflicting fields:

      \n\n
        \n
      1. \n

        If no SourceProfileIds entry is specified, the main\n Profile value is always taken.

        \n
        2. \n
      2. \n

        If a SourceProfileIds entry is specified, the specified\n profileId is always taken, even if it is a NULL value.

        \n
        3. \n
      \n
      3. \n
    \n
    6. \n
\n

You can use MergeProfiles together with GetMatches, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).

", + "smithy.api#documentation": "

Runs an AWS Lambda job that does the following:

\n
    \n
  1. \n

    All the profileKeys in the ProfileToBeMerged will be moved to the\n main profile.

    \n
    2. \n
  2. \n

    All the objects in the ProfileToBeMerged will be moved to the main\n profile.

    \n
    3. \n
  3. \n

    All the ProfileToBeMerged will be deleted at the end.

    \n
    4. \n
  4. \n

    All the profileKeys in the ProfileIdsToBeMerged will be moved to the\n main profile.

    \n
    5. \n
  5. \n

    Standard fields are merged as follows:

    \n
      \n
    1. \n

      Fields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.

      \n
      2. \n
    2. \n

      When there are conflicting fields:

      \n
        \n
      1. \n

        If no SourceProfileIds entry is specified, the main\n Profile value is always taken.

        \n
        2. \n
      2. \n

        If a SourceProfileIds entry is specified, the specified\n profileId is always taken, even if it is a NULL value.

        \n
        3. \n
      \n
      3. \n
    \n
    6. \n
\n

You can use MergeProfiles together with GetMatches, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).

", "smithy.api#http": { "method": "POST", "uri": "/domains/{DomainName}/profiles/objects/merge", @@ -7881,6 +7884,18 @@ "traits": { "smithy.api#documentation": "

A key value pair of attributes of a customer profile.

" } + }, + "PartyTypeString": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

An alternative to PartyType which accepts any string as input.

" + } + }, + "GenderString": { + "target": "com.amazonaws.customerprofiles#string0To255", + "traits": { + "smithy.api#documentation": "

An alternative to Gender which accepts any string as input.

" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/dataexchange.2017-07-25.json b/codegen/sdk-codegen/aws-models/dataexchange.2017-07-25.json index c81bffcaa3e..1ed2b422dc6 100644 --- a/codegen/sdk-codegen/aws-models/dataexchange.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/dataexchange.2017-07-25.json @@ -6390,4 +6390,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json index b8f17531ba1..7e14817d40f 100644 --- a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json +++ b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json @@ -191,7 +191,7 @@ } ], "traits": { - "smithy.api#documentation": "

Activates an DataSync agent that you have deployed in your storage\n environment. The activation process associates your agent with your account. In the activation\n process, you specify information such as the Amazon Web Services Region that you want to\n activate the agent in. You activate the agent in the Amazon Web Services Region where your\n target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.

\n

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to\n a VPC endpoint so you can run tasks without going over the public internet.

\n

You can use an agent for more than one location. If a task uses multiple agents, all of\n them need to have status AVAILABLE for the task to run. If you use multiple agents for a\n source location, the status of all the agents must be AVAILABLE for the task to run.

\n \n\n

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that\n ensures minimal interruption to your tasks.

" + "smithy.api#documentation": "

Activates an DataSync agent that you have deployed in your storage\n environment. The activation process associates your agent with your account. In the activation\n process, you specify information such as the Amazon Web Services Region that you want to\n activate the agent in. You activate the agent in the Amazon Web Services Region where your\n target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.

\n

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to\n a VPC endpoint so you can run tasks without going over the public internet.

\n

You can use an agent for more than one location. If a task uses multiple agents, all of\n them need to have status AVAILABLE for the task to run. If you use multiple agents for a\n source location, the status of all the agents must be AVAILABLE for the task to run.

\n

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that\n ensures minimal interruption to your tasks.

" } }, "com.amazonaws.datasync#CreateAgentRequest": { @@ -200,7 +200,7 @@ "ActivationKey": { "target": "com.amazonaws.datasync#ActivationKey", "traits": { - "smithy.api#documentation": "

Your agent activation key. You can get the activation key either by sending an HTTP GET\n request with redirects that enable you to get the agent IP address (port 80). Alternatively,\n you can get it from the DataSync console.

\n

The redirect URL returned in the response provides you the activation key for your\n agent in the query string parameter activationKey. It might also include other\n activation-related parameters; however, these are merely defaults. The arguments you pass to\n this API call determine the actual configuration of your agent.

\n \n\n

For more information, see Activating an Agent in the DataSync\n User Guide.\n

", + "smithy.api#documentation": "

Your agent activation key. You can get the activation key either by sending an HTTP GET\n request with redirects that enable you to get the agent IP address (port 80). Alternatively,\n you can get it from the DataSync console.

\n

The redirect URL returned in the response provides you the activation key for your\n agent in the query string parameter activationKey. It might also include other\n activation-related parameters; however, these are merely defaults. The arguments you pass to\n this API call determine the actual configuration of your agent.

\n

For more information, see Activating an Agent in the DataSync\n User Guide.\n

", "smithy.api#required": {} } }, @@ -763,7 +763,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to read the\n files. For the agent to access directories, you must additionally enable all execute\n access.

\n

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

\n \n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

", + "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to read the\n files. For the agent to access directories, you must additionally enable all execute\n access.

\n

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

\n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

", "smithy.api#required": {} } }, @@ -934,7 +934,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.

\n\n \n

For\n more information, see\n Create an Amazon S3 location\n in the DataSync User Guide.

" + "smithy.api#documentation": "

Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.

\n

For\n more information, see\n Create an Amazon S3 location\n in the DataSync User Guide.

" } }, "com.amazonaws.datasync#CreateLocationS3Request": { @@ -956,7 +956,7 @@ "S3StorageClass": { "target": "com.amazonaws.datasync#S3StorageClass", "traits": { - "smithy.api#documentation": "

The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard.\n For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

\n \n

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that\n can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

" + "smithy.api#documentation": "

The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard.\n For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

\n

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that\n can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

" } }, "S3Config": { @@ -1022,7 +1022,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#SmbSubdirectory", "traits": { - "smithy.api#documentation": "

The subdirectory in the SMB file system that is used to read data from the SMB source\n location or write data to the SMB destination. The SMB path should be a path that's\n exported by the SMB server, or a subdirectory of that path. The path should be such that it\n can be mounted by other SMB clients in your network.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n \n\n

To transfer all the data in the folder you specified, DataSync needs to have permissions\n to mount the SMB share, as well as to access all the data in that share. To ensure this,\n either ensure that the user/password specified belongs to the user who can mount the share,\n and who has the appropriate permissions for all of the files and directories that you want\n DataSync to access, or use credentials of a member of the Backup Operators group to mount\n the share. Doing either enables the agent to access the data. For the agent to access\n directories, you must additionally enable all execute access.

", + "smithy.api#documentation": "

The subdirectory in the SMB file system that is used to read data from the SMB source\n location or write data to the SMB destination. The SMB path should be a path that's\n exported by the SMB server, or a subdirectory of that path. The path should be such that it\n can be mounted by other SMB clients in your network.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n \n

To transfer all the data in the folder you specified, DataSync needs to have permissions\n to mount the SMB share, as well as to access all the data in that share. To ensure this,\n either ensure that the user/password specified belongs to the user who can mount the share,\n and who has the appropriate permissions for all of the files and directories that you want\n DataSync to access, or use credentials of a member of the Backup Operators group to mount\n the share. Doing either enables the agent to access the data. For the agent to access\n directories, you must additionally enable all execute access.

", "smithy.api#required": {} } }, @@ -1036,7 +1036,7 @@ "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "

The user who can mount the share, has the permissions to access files and folders in the\n SMB share.

\n \n

For information about choosing a user name that ensures sufficient permissions to files,\n folders, and metadata, see the User setting for SMB locations.

", + "smithy.api#documentation": "

The user who can mount the share, has the permissions to access files and folders in the\n SMB share.

\n

For information about choosing a user name that ensures sufficient permissions to files,\n folders, and metadata, see the User setting for SMB locations.

", "smithy.api#required": {} } }, @@ -1108,7 +1108,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures a task, which defines where and how DataSync transfers your\n data.

\n

A task includes a source location, a destination location, and the preferences for how and\n when you want to transfer your data (such as bandwidth limits, scheduling, among other\n options).

\n

When you create a task that transfers data between Amazon Web Services services in\n different Amazon Web Services Regions, one of your locations must reside in the Region where\n you're using DataSync.

\n

For more information, see the following topics:

\n " + "smithy.api#documentation": "

Configures a task, which defines where and how DataSync transfers your\n data.

\n

A task includes a source location, a destination location, and the preferences for how and\n when you want to transfer your data (such as bandwidth limits, scheduling, among other\n options).

" } }, "com.amazonaws.datasync#CreateTaskRequest": { @@ -1143,13 +1143,13 @@ "Options": { "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "

The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution. You can configure these\n options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data\n integrity verification, and so on.

\n

For each individual task execution, you can override these options by specifying the\n OverrideOptions before starting the task execution. For more information, see\n the StartTaskExecution operation.

" + "smithy.api#documentation": "

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

\n

You can also override these options before starting an individual run of a task (also\n known as a task execution). For more information, see StartTaskExecution.

" } }, "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

\n

\n

" + "smithy.api#documentation": "

Specifies a list of filter rules that exclude specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.

" } }, "Schedule": { @@ -1161,13 +1161,13 @@ "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the resource. The\n value can be an empty string.

" + "smithy.api#documentation": "

Specifies the tags that you want to apply to the Amazon Resource Name (ARN)\n representing the task.

\n

\n Tags are key-value pairs that help you manage, filter, and search\n for your DataSync resources.

" } }, "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern contains a single filter string that consists of the patterns to include. The patterns\n are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" + "smithy.api#documentation": "

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" } } }, @@ -1284,7 +1284,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a task.

" + "smithy.api#documentation": "

Deletes an DataSync task.

" } }, "com.amazonaws.datasync#DeleteTaskRequest": { @@ -1293,7 +1293,7 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task to delete.

", + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the task that you want to delete.

", "smithy.api#required": {} } } @@ -2248,7 +2248,7 @@ "Status": { "target": "com.amazonaws.datasync#TaskExecutionStatus", "traits": { - "smithy.api#documentation": "

The status of the task execution.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.\n

" + "smithy.api#documentation": "

The status of the task execution.

\n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.\n

" } }, "Options": { @@ -2257,13 +2257,13 @@ "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

" + "smithy.api#documentation": "

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" } }, "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n list should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

" + "smithy.api#documentation": "

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" } }, "StartTime": { @@ -2276,7 +2276,7 @@ "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The expected number of files that is to be transferred over the network. This value is\n calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the\n expected number of files to be transferred. It's calculated based on comparing the\n content of the source and destination locations and finding the delta that needs to be\n transferred.

" + "smithy.api#documentation": "

The expected number of files that is to be transferred over the network. This value is\n calculated during the PREPARING phase before the TRANSFERRING phase\n of the task execution. This value is the expected number of files to be transferred. It's\n calculated based on comparing the content of the source and destination locations and finding\n the delta that needs to be transferred.

" } }, "EstimatedBytesToTransfer": { @@ -2290,7 +2290,7 @@ "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The actual number of files that was transferred over the network. This value is\n calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated\n periodically when each file is read from the source and sent over the network.

\n

If failures occur during a transfer, this value can be less than\n EstimatedFilesToTransfer. This value can also be greater than\n EstimatedFilesTransferred in some cases. This element is\n implementation-specific for some location types, so don't use it as an indicator for a correct\n file number or to monitor your task execution.

" + "smithy.api#documentation": "

The actual number of files that was transferred over the network. This value is\n calculated and updated on an ongoing basis during the TRANSFERRING phase of the\n task execution. It's updated periodically when each file is read from the source and sent over\n the network.

\n

If failures occur during a transfer, this value can be less than\n EstimatedFilesToTransfer. In some cases, this value can also be greater than\n EstimatedFilesToTransfer. This element is implementation-specific for some\n location types, so don't use it as an indicator for a correct file number or to monitor your\n task execution.

" } }, "BytesWritten": { @@ -2304,7 +2304,7 @@ "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The physical number of bytes transferred over the network.

" + "smithy.api#documentation": "

The total number of bytes that are involved in the transfer. For the number of bytes\n sent over the network, see BytesCompressed.

" } }, "Result": { @@ -2317,7 +2317,7 @@ "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The physical number of bytes transferred over the network after compression was applied.\n In most cases, this number is less than BytesTransferred.

" + "smithy.api#documentation": "

The physical number of bytes transferred over the network after compression was applied.\n In most cases, this number is less than BytesTransferred unless the data isn't\n compressible.

" } } }, @@ -2352,7 +2352,7 @@ "Status": { "target": "com.amazonaws.datasync#TaskStatus", "traits": { - "smithy.api#documentation": "

The status of the task that was described.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.

" + "smithy.api#documentation": "

The status of the task that was described.

\n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.

" } }, "Name": { @@ -2364,7 +2364,7 @@ "CurrentTaskExecutionArn": { "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution that is syncing files.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution that is transferring files.

" } }, "SourceLocationArn": { @@ -2382,31 +2382,31 @@ "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.

\n\n \n

For more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.

\n

For more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.

" } }, "SourceNetworkInterfaceArns": { "target": "com.amazonaws.datasync#SourceNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were\n created for your subnet.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

" } }, "DestinationNetworkInterfaceArns": { "target": "com.amazonaws.datasync#DestinationNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that\n were created for your subnet.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

" } }, "Options": { "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "

The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution. You can configure these\n options to preserve metadata such as user ID (UID) and group (GID), file permissions, data\n integrity verification, and so on.

\n

For each individual task execution, you can override these options by specifying the\n overriding OverrideOptions value to StartTaskExecution operation.

" + "smithy.api#documentation": "

The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

\n

You can override these options for each task execution. For more information, see StartTaskExecution.

" } }, "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

\n

\n

" + "smithy.api#documentation": "

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" } }, "Schedule": { @@ -2436,7 +2436,7 @@ "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern contains a single filter string that consists of the patterns to include. The patterns\n are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" + "smithy.api#documentation": "

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" } } }, @@ -2817,14 +2817,14 @@ "name": "datasync" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "DataSync\n\n

DataSync is a managed data transfer service that makes it simpler for you\n to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.

\n

This API interface reference includes documentation for using DataSync\n programmatically. For complete information, see the \n DataSync User\n Guide\n .

", + "smithy.api#documentation": "DataSync\n

DataSync is a managed data transfer service that makes it simpler for you\n to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.

\n

This API interface reference includes documentation for using DataSync\n programmatically. For complete information, see the \n DataSync User\n Guide\n .

", "smithy.api#title": "AWS DataSync", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -2873,15 +2873,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -3145,8 +3136,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-south-1" } }, { @@ -3158,8 +3149,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-south-1" } }, { @@ -3171,8 +3162,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-south-1" } }, { @@ -3184,8 +3175,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-south-1" } }, { @@ -3197,8 +3188,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-south-1" } }, { @@ -3210,8 +3201,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-south-1" } }, { @@ -3223,8 +3214,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-south-1" } }, { @@ -3236,8 +3227,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-south-1" } }, { @@ -3249,8 +3240,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { @@ -3262,8 +3253,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { @@ -3275,8 +3266,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { @@ -3288,8 +3279,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { @@ -3301,8 +3292,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-central-1" } }, { @@ -3314,8 +3305,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-central-1" } }, { @@ -3327,8 +3318,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-central-1" } }, { @@ -3340,8 +3331,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-central-1" } }, { @@ -3353,8 +3344,8 @@ }, "params": { "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ca-central-1" } }, { @@ -3366,8 +3357,8 @@ }, "params": { "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ca-central-1" } }, { @@ -3379,8 +3370,8 @@ }, "params": { "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ca-central-1" } }, { @@ -3392,8 +3383,8 @@ }, "params": { "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ca-central-1" } }, { @@ -3405,8 +3396,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -3418,8 +3409,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -3431,8 +3422,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -3444,8 +3435,56 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync-fips.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-iso-west-1" + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://datasync.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-iso-west-1" } }, { @@ -3457,8 +3496,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-1" } }, { @@ -3470,8 +3509,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-1" } }, { @@ -3483,8 +3522,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-1" } }, { @@ -3496,8 +3535,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-1" } }, { @@ -3509,8 +3548,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -3522,8 +3561,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -3535,8 +3574,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -3548,8 +3587,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -3561,8 +3600,8 @@ }, "params": { "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "af-south-1" } }, { @@ -3574,8 +3613,8 @@ }, "params": { "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "af-south-1" } }, { @@ -3587,8 +3626,8 @@ }, "params": { "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "af-south-1" } }, { @@ -3600,8 +3639,8 @@ }, "params": { "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "af-south-1" } }, { @@ -3613,8 +3652,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-north-1" } }, { @@ -3626,8 +3665,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-north-1" } }, { @@ -3639,8 +3678,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-north-1" } }, { @@ -3652,8 +3691,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-north-1" } }, { @@ -3665,8 +3704,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-3" } }, { @@ -3678,8 +3717,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-3" } }, { @@ -3691,8 +3730,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-3" } }, { @@ -3704,8 +3743,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-3" } }, { @@ -3717,8 +3756,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-2" } }, { @@ -3730,8 +3769,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-2" } }, { @@ -3743,8 +3782,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-2" } }, { @@ -3756,8 +3795,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-2" } }, { @@ -3769,8 +3808,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-1" } }, { @@ -3782,8 +3821,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-1" } }, { @@ -3795,8 +3834,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-1" } }, { @@ -3808,8 +3847,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-1" } }, { @@ -3821,8 +3860,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-3" } }, { @@ -3834,8 +3873,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-3" } }, { @@ -3847,8 +3886,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-3" } }, { @@ -3860,8 +3899,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-3" } }, { @@ -3873,8 +3912,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-2" } }, { @@ -3886,8 +3925,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-2" } }, { @@ -3899,8 +3938,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-2" } }, { @@ -3912,8 +3951,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-2" } }, { @@ -3925,8 +3964,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-1" } }, { @@ -3938,8 +3977,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { @@ -3951,8 +3990,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-1" } }, { @@ -3964,8 +4003,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { @@ -3977,8 +4016,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-south-1" } }, { @@ -3990,8 +4029,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-south-1" } }, { @@ -4003,8 +4042,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-south-1" } }, { @@ -4016,8 +4055,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-south-1" } }, { @@ -4029,8 +4068,8 @@ }, "params": { "UseFIPS": true, - "Region": "sa-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "sa-east-1" } }, { @@ -4042,8 +4081,8 @@ }, "params": { "UseFIPS": true, - "Region": "sa-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "sa-east-1" } }, { @@ -4055,8 +4094,8 @@ }, "params": { "UseFIPS": false, - "Region": "sa-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "sa-east-1" } }, { @@ -4068,8 +4107,8 @@ }, "params": { "UseFIPS": false, - "Region": "sa-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "sa-east-1" } }, { @@ -4081,8 +4120,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-east-1" } }, { @@ -4094,8 +4133,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-east-1" } }, { @@ -4107,8 +4146,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-east-1" } }, { @@ -4120,8 +4159,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-east-1" } }, { @@ -4133,8 +4172,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-north-1" } }, { @@ -4146,8 +4185,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { @@ -4159,8 +4198,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-north-1" } }, { @@ -4172,8 +4211,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { @@ -4185,8 +4224,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-west-1" } }, { @@ -4198,8 +4237,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-west-1" } }, { @@ -4211,8 +4250,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-west-1" } }, { @@ -4224,8 +4263,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-west-1" } }, { @@ -4237,8 +4276,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -4250,8 +4289,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -4263,8 +4302,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -4276,8 +4315,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -4289,8 +4328,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -4302,8 +4341,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -4315,8 +4354,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -4328,8 +4367,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -4339,8 +4378,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-iso-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { @@ -4352,8 +4391,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-iso-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { @@ -4363,8 +4402,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-iso-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-iso-east-1" } }, { @@ -4376,8 +4415,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-iso-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { @@ -4389,8 +4428,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-3" } }, { @@ -4402,8 +4441,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-3" } }, { @@ -4415,8 +4454,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-3" } }, { @@ -4428,8 +4467,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-3" } }, { @@ -4441,8 +4480,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -4454,8 +4493,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -4467,8 +4506,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -4480,8 +4519,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -4493,8 +4532,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-2" } }, { @@ -4506,8 +4545,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-2" } }, { @@ -4519,8 +4558,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-2" } }, { @@ -4532,8 +4571,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-2" } }, { @@ -4545,8 +4584,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-northwest-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-northwest-1" } }, { @@ -4558,8 +4597,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-northwest-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-northwest-1" } }, { @@ -4571,8 +4610,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-northwest-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-northwest-1" } }, { @@ -4584,8 +4623,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-northwest-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-northwest-1" } }, { @@ -4595,8 +4634,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-isob-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { @@ -4608,8 +4647,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-isob-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { @@ -4619,8 +4658,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-isob-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-isob-east-1" } }, { @@ -4632,8 +4671,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-isob-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { @@ -4645,8 +4684,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -4657,8 +4696,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -4669,8 +4708,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -5233,7 +5272,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all the tags associated with a specified resource.

", + "smithy.api#documentation": "

Returns all the tags associated with an Amazon Web Services resource.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5248,20 +5287,20 @@ "ResourceArn": { "target": "com.amazonaws.datasync#TaggableResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose tags to list.

", + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the resource that you want tag information on.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.datasync#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of locations to return.

" + "smithy.api#documentation": "

Specifies how many results that you want in the response.

" } }, "NextToken": { "target": "com.amazonaws.datasync#NextToken", "traits": { - "smithy.api#documentation": "

An opaque string that indicates the position at which to begin the next list of\n locations.

" + "smithy.api#documentation": "

Specifies an opaque string that indicates the position to begin the next list of results in the response.

" } } }, @@ -5275,13 +5314,13 @@ "Tags": { "target": "com.amazonaws.datasync#OutputTagList", "traits": { - "smithy.api#documentation": "

Array of resource tags.

" + "smithy.api#documentation": "

An array of tags applied to the specified resource.

" } }, "NextToken": { "target": "com.amazonaws.datasync#NextToken", "traits": { - "smithy.api#documentation": "

An opaque string that indicates the position at which to begin returning the next list\n of resource tags.

" + "smithy.api#documentation": "

The opaque string that indicates the position to begin the next list of results in the response.

" } } }, @@ -5622,7 +5661,7 @@ "Version": { "target": "com.amazonaws.datasync#NfsVersion", "traits": { - "smithy.api#documentation": "

Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

\n\n

You can specify the following options:

\n \n \n

DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.

\n " + "smithy.api#documentation": "

Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

\n

You can specify the following options:

\n \n \n

DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.

\n " } } }, @@ -5838,96 +5877,96 @@ "VerifyMode": { "target": "com.amazonaws.datasync#VerifyMode", "traits": { - "smithy.api#documentation": "

A value that determines whether a data integrity verification should be performed at\n the end of a task execution after all data and metadata have been transferred. \n For more information, see \n Configure task settings.\n

\n

Default value: POINT_IN_TIME_CONSISTENT\n

\n

\n ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files\n that were transferred.

\n \n

\n POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at\n the end of the transfer to verify that source and destination are fully synchronized. This\n option isn't supported when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes.

\n

\n NONE: No additional verification is done at the end of the transfer, but\n all data transmissions are integrity-checked with checksum verification during the\n transfer.

" + "smithy.api#documentation": "

Specifies how and when DataSync checks the integrity of your data during a\n transfer.

\n

Default value: POINT_IN_TIME_CONSISTENT\n

\n

\n ONLY_FILES_TRANSFERRED (recommended): DataSync calculates the checksum of\n transferred files and metadata at the source location. At the end of the transfer, DataSync then\n compares this checksum to the checksum calculated on those files at the destination.

\n

We recommend this option when transferring to S3 Glacier Flexible Retrieval or\n S3 Glacier Deep Archive storage classes. For more information, see\n Storage class\n considerations with Amazon S3 locations.

\n

\n POINT_IN_TIME_CONSISTENT: At the end of the transfer, DataSync\n scans the entire source and destination to verify that both locations are fully\n synchronized.

\n

You can't use this option when transferring to S3 Glacier Flexible Retrieval or\n S3 Glacier Deep Archive storage classes. For more information, see\n Storage class\n considerations with Amazon S3 locations.

\n

\n NONE: DataSync doesn't run additional verification at the end of\n the transfer. All data transmissions are still integrity-checked with checksum verification\n during the transfer.

" } }, "OverwriteMode": { "target": "com.amazonaws.datasync#OverwriteMode", "traits": { - "smithy.api#documentation": "

A value that determines whether files at the destination should be overwritten or\n preserved when copying files. If set to NEVER a destination file will not be\n replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to\n protect against overwriting those changes.

\n

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see \n Considerations when working with Amazon S3 storage classes in DataSync \n in the DataSync\n User Guide.

" + "smithy.api#documentation": "

Specifies whether data at the destination location should be overwritten or preserved. If\n set to NEVER, a destination file for example will not be replaced by a source\n file (even if the destination file differs from the source file). If you modify files in the\n destination and you sync the files, you can use this value to protect against overwriting\n those changes.

\n

Some storage classes have specific behaviors that can affect your Amazon S3\n storage cost. For detailed information, see Considerations\n when working with Amazon S3 storage classes in DataSync .

" } }, "Atime": { "target": "com.amazonaws.datasync#Atime", "traits": { - "smithy.api#documentation": "

A file metadata value that shows the last time a file was accessed (that is, when the\n file was read or written to). If you set Atime to BEST_EFFORT,\n DataSync attempts to preserve the original Atime attribute on all\n source files (that is, the version before the PREPARING phase). However,\n Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.

\n

Default value: BEST_EFFORT\n

\n

\n BEST_EFFORT: Attempt to preserve the per-file Atime value\n (recommended).

\n

\n NONE: Ignore Atime.

\n \n

If Atime is set to BEST_EFFORT, Mtime must be set\n to PRESERVE.

\n

If Atime is set to NONE, Mtime must also be\n NONE.

\n " + "smithy.api#documentation": "

Specifies whether to preserve metadata indicating the last time a file was read or\n written to. If you set Atime to BEST_EFFORT, DataSync\n attempts to preserve the original Atime attribute on all source files (that is,\n the version before the PREPARING phase of the task execution).

\n \n

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

\n \n

Default value: BEST_EFFORT\n

\n

\n BEST_EFFORT: Attempt to preserve the per-file Atime value\n (recommended).

\n

\n NONE: Ignore Atime.

\n \n

If Atime is set to BEST_EFFORT, Mtime must be set\n to PRESERVE.

\n

If Atime is set to NONE, Mtime must also be\n NONE.

\n " } }, "Mtime": { "target": "com.amazonaws.datasync#Mtime", "traits": { - "smithy.api#documentation": "

A value that indicates the last time that a file was modified (that is, a file was\n written to) before the PREPARING phase. This option is required for cases when\n you need to run the same task more than one time.

\n

Default Value: PRESERVE\n

\n

\n PRESERVE: Preserve original Mtime (recommended)

\n

\n NONE: Ignore Mtime.

\n \n

If Mtime is set to PRESERVE, Atime must be set to\n BEST_EFFORT.

\n

If Mtime is set to NONE, Atime must also be set\n to NONE.

\n " + "smithy.api#documentation": "

Specifies whether to preserve metadata indicating the last time that a file was written\n to before the PREPARING phase of your task execution. This option is required\n when you need to run the a task more than once.

\n

Default Value: PRESERVE\n

\n

\n PRESERVE: Preserve original Mtime (recommended)

\n

\n NONE: Ignore Mtime.

\n \n

If Mtime is set to PRESERVE, Atime must be set to\n BEST_EFFORT.

\n

If Mtime is set to NONE, Atime must also be set\n to NONE.

\n " } }, "Uid": { "target": "com.amazonaws.datasync#Uid", "traits": { - "smithy.api#documentation": "

The POSIX user ID (UID) of the file's owner.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: INT_VALUE. This preserves the integer value of the ID.

\n

\n INT_VALUE: Preserve the integer value of UID and group ID (GID)\n (recommended).

\n

\n NONE: Ignore UID and GID.

" + "smithy.api#documentation": "

Specifies the POSIX user ID (UID) of the file's owner.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: INT_VALUE. This preserves the integer value of the ID.

\n

\n INT_VALUE: Preserve the integer value of UID and group ID (GID)\n (recommended).

\n

\n NONE: Ignore UID and GID.

" } }, "Gid": { "target": "com.amazonaws.datasync#Gid", "traits": { - "smithy.api#documentation": "

The POSIX group ID (GID) of the file's owners.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: INT_VALUE. This preserves the integer value of the ID.

\n

\n INT_VALUE: Preserve the integer value of user ID (UID) and GID\n (recommended).

\n

\n NONE: Ignore UID and GID.

" + "smithy.api#documentation": "

Specifies the POSIX group ID (GID) of the file's owners.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: INT_VALUE. This preserves the integer value of the ID.

\n

\n INT_VALUE: Preserve the integer value of user ID (UID) and GID\n (recommended).

\n

\n NONE: Ignore UID and GID.

" } }, "PreserveDeletedFiles": { "target": "com.amazonaws.datasync#PreserveDeletedFiles", "traits": { - "smithy.api#documentation": "

A value that specifies whether files in the destination that don't exist in the source\n file system should be preserved. This option can affect your storage cost. \n If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed\n information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User\n Guide.

\n

Default value: PRESERVE\n

\n

\n PRESERVE: Ignore such destination files (recommended).

\n

\n REMOVE: Delete destination files that aren’t present in the\n source.

" + "smithy.api#documentation": "

Specifies whether files in the destination location that don't exist in the source\n should be preserved. This option can affect your Amazon S3 storage cost. If your task\n deletes objects, you might incur minimum storage duration charges for certain storage classes.\n For detailed information, see Considerations\n when working with Amazon S3 storage classes in DataSync .

\n

Default value: PRESERVE\n

\n

\n PRESERVE: Ignore such destination files (recommended).

\n

\n REMOVE: Delete destination files that aren’t present in the\n source.

" } }, "PreserveDevices": { "target": "com.amazonaws.datasync#PreserveDevices", "traits": { - "smithy.api#documentation": "

A value that determines whether DataSync should preserve the metadata of block\n and character devices in the source file system, and re-create the files with that device name\n and metadata on the destination. DataSync does not copy the contents of such devices, only the\n name and metadata.

\n \n

DataSync can't sync the actual contents of such devices, because they are\n nonterminal and don't return an end-of-file (EOF) marker.

\n \n

Default value: NONE\n

\n

\n NONE: Ignore special devices (recommended).

\n

\n PRESERVE: Preserve character and block device metadata. This option isn't\n currently supported for Amazon EFS.

" + "smithy.api#documentation": "

Specifies whether DataSync should preserve the metadata of block and\n character devices in the source location and recreate the files with that device name and\n metadata on the destination. DataSync copies only the name and metadata of such\n devices.

\n \n

DataSync can't copy the actual contents of these devices because they're\n nonterminal and don't return an end-of-file (EOF) marker.

\n \n

Default value: NONE\n

\n

\n NONE: Ignore special devices (recommended).

\n

\n PRESERVE: Preserve character and block device metadata. This option\n currently isn't supported for Amazon EFS.

" } }, "PosixPermissions": { "target": "com.amazonaws.datasync#PosixPermissions", "traits": { - "smithy.api#documentation": "

A value that determines which users or groups can access a file for a specific purpose\n such as reading, writing, or execution of the file.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: PRESERVE\n

\n

\n PRESERVE: Preserve POSIX-style permissions (recommended).

\n

\n NONE: Ignore permissions.

\n \n

DataSync can preserve extant permissions of a source location.

\n " + "smithy.api#documentation": "

Specifies which users or groups can access a file for a specific purpose such as reading,\n writing, or execution of the file.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: PRESERVE\n

\n

\n PRESERVE: Preserve POSIX-style permissions (recommended).

\n

\n NONE: Ignore permissions.

\n \n

DataSync can preserve extant permissions of a source location.

\n " } }, "BytesPerSecond": { "target": "com.amazonaws.datasync#BytesPerSecond", "traits": { - "smithy.api#documentation": "

A value that limits the bandwidth used by DataSync. For example, if you want\n DataSync to use a maximum of 1 MB, set this value to 1048576\n (=1024*1024).

" + "smithy.api#documentation": "

Limits the bandwidth used by a DataSync task. For example, if you want\n DataSync to use a maximum of 1 MB, set this value to 1048576\n (=1024*1024).

" } }, "TaskQueueing": { "target": "com.amazonaws.datasync#TaskQueueing", "traits": { - "smithy.api#documentation": "

A value that determines whether tasks should be queued before executing the tasks. If set\n to ENABLED, the tasks will be queued. The default is ENABLED.

\n

If you use the same agent to run multiple tasks, you can enable the tasks to run in\n series. For more information, see \n Queueing task executions.

" + "smithy.api#documentation": "

Specifies whether tasks should be queued before executing the tasks. The default is\n ENABLED, which means the tasks will be queued.

\n

If you use the same agent to run multiple tasks, you can enable the tasks to run in\n series. For more information, see \n Queueing task executions.

" } }, "LogLevel": { "target": "com.amazonaws.datasync#LogLevel", "traits": { - "smithy.api#documentation": "

A value that determines the type of logs that DataSync publishes to a log stream in the\n Amazon CloudWatch log group that you provide. For more information about providing a log group\n for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published.\n BASIC publishes logs on errors for individual files transferred, and\n TRANSFER publishes logs for every file or object that is transferred and\n integrity checked.

" + "smithy.api#documentation": "

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log\n group. To specify the log group, see CloudWatchLogGroupArn.

\n

If you set LogLevel to OFF, no logs are published.\n BASIC publishes logs on errors for individual files transferred.\n TRANSFER publishes logs for every file or object that is transferred and\n integrity checked.

" } }, "TransferMode": { "target": "com.amazonaws.datasync#TransferMode", "traits": { - "smithy.api#documentation": "

A value that determines whether DataSync transfers only the data and metadata that differ between the source \n and the destination location, or whether DataSync transfers all the content from the source, without comparing to \n the destination location.

\n

\n CHANGED: DataSync copies only data or metadata that is new or\n different content from the source location to the destination location.

\n

\n ALL: DataSync copies all source location content to the\n destination, without comparing to existing content on the destination.

" + "smithy.api#documentation": "

Determines whether DataSync transfers only the data and metadata that differ\n between the source and the destination location or transfers all the content from the source\n (without comparing what's in the destination).

\n

\n CHANGED: DataSync copies only data or metadata that is new or\n different content from the source location to the destination location.

\n

\n ALL: DataSync copies all source location content to the destination\n (without comparing what's in the destination).

" } }, "SecurityDescriptorCopyFlags": { "target": "com.amazonaws.datasync#SmbSecurityDescriptorCopyFlags", "traits": { - "smithy.api#documentation": "

A value that determines which components of the SMB security descriptor are copied from source\n to destination objects.\n

\n

This value is only used for transfers \n between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File\n Server locations. For more information about how \n DataSync handles metadata, see\n How DataSync Handles Metadata and Special Files.\n

\n

Default value: OWNER_DACL\n

\n\n

\n OWNER_DACL: For each copied object, DataSync copies the following\n metadata:

\n \n

When choosing this option, DataSync does NOT copy the NTFS system access control lists\n (SACLs), which are used by administrators to log attempts to access a secured object.

\n \n

\n OWNER_DACL_SACL: For each copied object, DataSync copies the following\n metadata:

\n \n

Copying SACLs requires granting additional permissions to the Windows user that DataSync\n uses to access your SMB location. For information about choosing a user that ensures\n sufficient permissions to files, folders, and metadata, see user.

\n \n

\n NONE: None of the SMB security descriptor components are copied. Destination\n objects are owned by the user that was provided for accessing the destination location. DACLs\n and SACLs are set based on the destination server’s configuration.

" + "smithy.api#documentation": "

Specifies which components of the SMB security descriptor are copied from source to\n destination objects.

\n

This value is only used for transfers between SMB and Amazon FSx for Windows File Server\n locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.

\n

Default value: OWNER_DACL\n

\n

\n OWNER_DACL: For each copied object, DataSync copies the following\n metadata:

\n \n

\n OWNER_DACL_SACL: For each copied object, DataSync copies the\n following metadata:

\n \n

\n NONE: None of the SMB security descriptor components are copied. Destination\n objects are owned by the user that was provided for accessing the destination location. DACLs\n and SACLs are set based on the destination server’s configuration.

" } }, "ObjectTags": { "target": "com.amazonaws.datasync#ObjectTags", "traits": { - "smithy.api#documentation": "

Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

\n

Default Value: PRESERVE\n

" + "smithy.api#documentation": "

Specifies whether object tags are preserved when transferring between object storage\n systems. If you want your DataSync task to ignore object tags, specify the\n NONE value.

\n

Default Value: PRESERVE\n

" } } }, "traits": { - "smithy.api#documentation": "

Represents the options that are available to control the behavior of a \n StartTaskExecution\n operation. Behavior includes preserving metadata such as user\n ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination,\n data integrity verification, and so on.

\n

A task has a set of default options associated with it. If you don't specify an option\n in StartTaskExecution, \n the default value is used. You can override the\n defaults options on each task execution by specifying an overriding Options value\n to StartTaskExecution.

" + "smithy.api#documentation": "

Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how\n DataSync verifies data integrity, set bandwidth limits for your task, among other\n options.

\n

Each task setting has a default value. Unless you need to, you don't have to configure\n any of these Options before starting your task.

" } }, "com.amazonaws.datasync#OutputTagList": { @@ -6131,7 +6170,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access\n an Amazon S3 bucket.

\n \n

For detailed information about using such a role, see Creating a Location for\n Amazon S3 in the DataSync User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access\n an Amazon S3 bucket.

\n

For detailed information about using such a role, see Creating a Location for\n Amazon S3 in the DataSync User Guide.

" } }, "com.amazonaws.datasync#S3StorageClass": { @@ -6178,6 +6217,12 @@ "traits": { "smithy.api#enumValue": "OUTPOSTS" } + }, + "GLACIER_INSTANT_RETRIEVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER_INSTANT_RETRIEVAL" + } } } }, @@ -6335,7 +6380,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a specific invocation of a task. A TaskExecution value represents\n an individual run of a task. Each task can have at most one TaskExecution at a\n time.

\n

\n TaskExecution has the following transition phases: INITIALIZING |\n PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

\n \n

For detailed information, see the Task Execution section in the Components and\n Terminology topic in the DataSync User Guide.

" + "smithy.api#documentation": "

Starts an DataSync task. For each task, you can only run one task execution at a time.

\n

There are several phases to a task execution. For more information, see Task execution statuses.

" } }, "com.amazonaws.datasync#StartTaskExecutionRequest": { @@ -6344,7 +6389,7 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task to start.

", + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

", "smithy.api#required": {} } }, @@ -6354,13 +6399,19 @@ "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe), for example,\n \"/folder1|/folder2\".

\n \n

\n

" + "smithy.api#documentation": "

Specifies a list of filter rules that determines which files to include when running a\n task. The pattern should contain a single filter string that consists of the patterns to\n include. The patterns are delimited by \"|\" (that is, a pipe), for example,\n \"/folder1|/folder2\".

" } }, "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list\n contains a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" + "smithy.api#documentation": "

Specifies a list of filter rules that determines which files to exclude from a task. The\n list contains a single filter string that consists of the patterns to exclude. The patterns\n are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" + } + }, + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", + "traits": { + "smithy.api#documentation": "

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

\n

\n Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

" } } }, @@ -6374,7 +6425,7 @@ "TaskExecutionArn": { "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the specific task execution that was\n started.

" + "smithy.api#documentation": "

The ARN of the running task execution.

" } } }, @@ -6432,7 +6483,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a single entry in a list of Amazon Web Services resource tags. TagListEntry\n returns an array that contains a list of tasks when the \n ListTagsForResource\n operation is called.

" + "smithy.api#documentation": "

A key-value pair representing a single tag that's been applied to an Amazon Web Services\n resource.

" } }, "com.amazonaws.datasync#TagResource": { @@ -6452,7 +6503,7 @@ } ], "traits": { - "smithy.api#documentation": "

Applies a key-value pair to an Amazon Web Services resource.

" + "smithy.api#documentation": "

Applies a tag to an Amazon Web Services\n resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.

\n

These include DataSync resources, such as locations, tasks, and task executions.

" } }, "com.amazonaws.datasync#TagResourceRequest": { @@ -6461,14 +6512,14 @@ "ResourceArn": { "target": "com.amazonaws.datasync#TaggableResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to apply the tag to.

", + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the resource to apply the tag to.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "

The tags to apply.

", + "smithy.api#documentation": "

Specifies the tags that you want to apply to the resource.

", "smithy.api#required": {} } } @@ -6498,7 +6549,7 @@ "min": 0, "max": 128 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:(agent|task|location)/(agent|task|loc)-[0-9a-z]{17}$" + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:(agent|task|location)/(agent|task|loc)-[a-f0-9]{17}(/execution/exec-[a-f0-9]{17})?$" } }, "com.amazonaws.datasync#TaskArn": { @@ -6873,7 +6924,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a tag from an Amazon Web Services resource.

" + "smithy.api#documentation": "

Removes tags from an Amazon Web Services resource.

" } }, "com.amazonaws.datasync#UntagResourceRequest": { @@ -6882,14 +6933,14 @@ "ResourceArn": { "target": "com.amazonaws.datasync#TaggableResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove the tag from.

", + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the resource to remove the tags from.

", "smithy.api#required": {} } }, "Keys": { "target": "com.amazonaws.datasync#TagKeyList", "traits": { - "smithy.api#documentation": "

The keys in the key-value pair in the tag to remove.

", + "smithy.api#documentation": "

Specifies the keys in the tags that you want to remove.

", "smithy.api#required": {} } } @@ -7088,7 +7139,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n \n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder that you specified, DataSync must have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the files you want DataSync to\n access have permissions that allow read access for all users. Doing either option enables the\n agent to read the files. For the agent to access directories, you must additionally enable all\n execute access.

\n

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

\n \n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

" + "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder that you specified, DataSync must have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the files you want DataSync to\n access have permissions that allow read access for all users. Doing either option enables the\n agent to read the files. For the agent to access directories, you must additionally enable all\n execute access.

\n

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

\n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

" } }, "OnPremConfig": { @@ -7214,7 +7265,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#SmbSubdirectory", "traits": { - "smithy.api#documentation": "

The subdirectory in the SMB file system that is used to read data from the SMB source\n location or write data to the SMB destination. The SMB path should be a path that's\n exported by the SMB server, or a subdirectory of that path. The path should be such that it\n can be mounted by other SMB clients in your network.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n \n \n

To transfer all the data in the folder that you specified, DataSync must have\n permissions to mount the SMB share and to access all the data in that share. To ensure this,\n do either of the following:

\n \n

Doing either of these options enables the agent to access the data. For the agent to\n access directories, you must also enable all execute access.

" + "smithy.api#documentation": "

The subdirectory in the SMB file system that is used to read data from the SMB source\n location or write data to the SMB destination. The SMB path should be a path that's\n exported by the SMB server, or a subdirectory of that path. The path should be such that it\n can be mounted by other SMB clients in your network.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n \n

To transfer all the data in the folder that you specified, DataSync must have\n permissions to mount the SMB share and to access all the data in that share. To ensure this,\n do either of the following:

\n \n

Doing either of these options enables the agent to access the data. For the agent to\n access directories, you must also enable all execute access.

" } }, "User": { @@ -7287,7 +7338,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates execution of a task.

\n

You can modify bandwidth throttling for a task execution that is running or queued.\n For more information, see Adjusting Bandwidth Throttling for a Task Execution.

\n \n \n

The only Option that can be modified by UpdateTaskExecution \n is \n BytesPerSecond\n .

\n " + "smithy.api#documentation": "

Updates execution of a task.

\n

You can modify bandwidth throttling for a task execution that is running or queued.\n For more information, see Adjusting Bandwidth Throttling for a Task Execution.

\n \n

The only Option that can be modified by UpdateTaskExecution \n is \n BytesPerSecond\n .

\n " } }, "com.amazonaws.datasync#UpdateTaskExecutionRequest": { @@ -7328,7 +7379,7 @@ "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

\n

\n

" + "smithy.api#documentation": "

Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" } }, "Schedule": { @@ -7352,7 +7403,7 @@ "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern contains a single filter string that consists of the patterns to include. The patterns\n are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" + "smithy.api#documentation": "

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/docdb-elastic.2022-11-28.json b/codegen/sdk-codegen/aws-models/docdb-elastic.2022-11-28.json index 5e480a159af..52d3312acbc 100644 --- a/codegen/sdk-codegen/aws-models/docdb-elastic.2022-11-28.json +++ b/codegen/sdk-codegen/aws-models/docdb-elastic.2022-11-28.json @@ -2289,4 +2289,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/drs.2020-02-26.json b/codegen/sdk-codegen/aws-models/drs.2020-02-26.json index 3870df0d760..c263fd5ba4c 100644 --- a/codegen/sdk-codegen/aws-models/drs.2020-02-26.json +++ b/codegen/sdk-codegen/aws-models/drs.2020-02-26.json @@ -7700,4 +7700,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json index 662a6717642..18f763e919d 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json @@ -230,7 +230,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -279,15 +279,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -569,7 +560,7 @@ } ], "endpoint": { - "url": "https://localhost:8000", + "url": "http://localhost:8000", "properties": { "authSchemes": [ { @@ -608,8 +599,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-south-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -621,8 +612,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-south-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -634,8 +625,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-south-2", + "UseFIPS": false, "UseDualStack": true } }, @@ -647,8 +638,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-south-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -660,8 +651,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-south-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -673,8 +664,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-south-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -686,8 +677,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -699,8 +690,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -712,8 +703,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-south-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -725,8 +716,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-south-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -738,8 +729,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-south-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -751,8 +742,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -764,8 +755,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-south-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -777,8 +768,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-south-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -790,8 +781,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-south-2", + "UseFIPS": false, "UseDualStack": true } }, @@ -803,8 +794,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-south-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -816,8 +807,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -829,8 +820,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -842,8 +833,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -855,8 +846,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -868,8 +859,8 @@ } }, "params": { - "UseFIPS": true, "Region": "me-central-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -881,8 +872,8 @@ } }, "params": { - "UseFIPS": true, "Region": "me-central-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -894,8 +885,8 @@ } }, "params": { - "UseFIPS": false, "Region": "me-central-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -907,8 +898,8 @@ } }, "params": { - "UseFIPS": false, "Region": "me-central-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -920,8 +911,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -933,8 +924,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -946,8 +937,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -959,8 +950,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -972,8 +963,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -985,8 +976,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -998,8 +989,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1011,8 +1002,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1022,8 +1013,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "Region": "us-iso-west-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1035,8 +1026,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-iso-west-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1046,8 +1037,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "Region": "us-iso-west-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1059,8 +1050,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-iso-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1072,8 +1063,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-central-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -1085,8 +1076,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-central-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -1098,8 +1089,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-central-2", + "UseFIPS": false, "UseDualStack": true } }, @@ -1111,8 +1102,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-central-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -1124,8 +1115,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1137,8 +1128,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1150,8 +1141,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1163,8 +1154,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1176,8 +1167,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -1189,8 +1180,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -1202,8 +1193,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true } }, @@ -1215,8 +1206,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -1228,8 +1219,8 @@ } }, "params": { - "UseFIPS": true, "Region": "af-south-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1241,8 +1232,8 @@ } }, "params": { - "UseFIPS": true, "Region": "af-south-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1254,8 +1245,8 @@ } }, "params": { - "UseFIPS": false, "Region": "af-south-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1267,8 +1258,8 @@ } }, "params": { - "UseFIPS": false, "Region": "af-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1280,8 +1271,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-north-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1293,8 +1284,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-north-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1306,8 +1297,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1319,8 +1310,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1332,8 +1323,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-west-3", + "UseFIPS": true, "UseDualStack": true } }, @@ -1345,8 +1336,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-west-3", + "UseFIPS": true, "UseDualStack": false } }, @@ -1358,8 +1349,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": true } }, @@ -1371,8 +1362,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": false } }, @@ -1384,8 +1375,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -1397,8 +1388,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -1410,8 +1401,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": true } }, @@ -1423,8 +1414,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -1436,8 +1427,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1449,8 +1440,8 @@ } }, "params": { - "UseFIPS": true, "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1462,8 +1453,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1475,8 +1466,8 @@ } }, "params": { - "UseFIPS": false, "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1488,8 +1479,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-northeast-3", + "UseFIPS": true, "UseDualStack": true } }, @@ -1501,8 +1492,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-northeast-3", + "UseFIPS": true, "UseDualStack": false } }, @@ -1514,8 +1505,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-3", + "UseFIPS": false, "UseDualStack": true } }, @@ -1527,8 +1518,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-3", + "UseFIPS": false, "UseDualStack": false } }, @@ -1540,8 +1531,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -1553,8 +1544,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -1566,8 +1557,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": true } }, @@ -1579,8 +1570,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -1592,8 +1583,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1605,8 +1596,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1618,8 +1609,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1631,8 +1622,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1644,8 +1635,8 @@ } }, "params": { - "UseFIPS": true, "Region": "me-south-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1657,8 +1648,8 @@ } }, "params": { - "UseFIPS": true, "Region": "me-south-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1670,8 +1661,8 @@ } }, "params": { - "UseFIPS": false, "Region": "me-south-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1683,8 +1674,8 @@ } }, "params": { - "UseFIPS": false, "Region": "me-south-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1696,8 +1687,8 @@ } }, "params": { - "UseFIPS": true, "Region": "sa-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1709,8 +1700,8 @@ } }, "params": { - "UseFIPS": true, "Region": "sa-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1722,8 +1713,8 @@ } }, "params": { - "UseFIPS": false, "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1735,8 +1726,8 @@ } }, "params": { - "UseFIPS": false, "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1748,8 +1739,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1761,8 +1752,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1774,8 +1765,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1787,8 +1778,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1800,8 +1791,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1813,8 +1804,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1826,8 +1817,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1839,8 +1830,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1852,8 +1843,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1865,8 +1856,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1878,8 +1869,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1891,8 +1882,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1904,8 +1895,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-southeast-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1917,8 +1908,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-southeast-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -1930,8 +1921,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -1943,8 +1934,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -1956,8 +1947,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -1969,8 +1960,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -1982,8 +1973,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": true } }, @@ -1995,8 +1986,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -2006,8 +1997,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -2019,8 +2010,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -2030,8 +2021,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -2043,8 +2034,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -2056,8 +2047,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-southeast-3", + "UseFIPS": true, "UseDualStack": true } }, @@ -2069,8 +2060,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-southeast-3", + "UseFIPS": true, "UseDualStack": false } }, @@ -2082,8 +2073,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-3", + "UseFIPS": false, "UseDualStack": true } }, @@ -2095,8 +2086,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-3", + "UseFIPS": false, "UseDualStack": false } }, @@ -2108,8 +2099,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-southeast-4", + "UseFIPS": true, "UseDualStack": true } }, @@ -2121,8 +2112,8 @@ } }, "params": { - "UseFIPS": true, "Region": "ap-southeast-4", + "UseFIPS": true, "UseDualStack": false } }, @@ -2134,8 +2125,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-4", + "UseFIPS": false, "UseDualStack": true } }, @@ -2147,8 +2138,8 @@ } }, "params": { - "UseFIPS": false, "Region": "ap-southeast-4", + "UseFIPS": false, "UseDualStack": false } }, @@ -2160,8 +2151,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -2173,8 +2164,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -2186,8 +2177,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -2199,8 +2190,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -2212,8 +2203,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -2225,8 +2216,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": false } }, @@ -2238,8 +2229,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": true } }, @@ -2251,8 +2242,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": false } }, @@ -2264,8 +2255,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-northwest-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -2277,8 +2268,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-northwest-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -2290,8 +2281,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-northwest-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -2303,8 +2294,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-northwest-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -2314,8 +2305,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -2327,8 +2318,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -2338,8 +2329,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -2351,8 +2342,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": false } }, @@ -2364,8 +2355,8 @@ } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } @@ -2376,8 +2367,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } @@ -2388,8 +2379,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } diff --git a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json index e137daa8710..05035108a15 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json @@ -3403,7 +3403,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -3452,15 +3452,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -3742,7 +3733,7 @@ } ], "endpoint": { - "url": "https://localhost:8000", + "url": "http://localhost:8000", "properties": { "authSchemes": [ { @@ -3781,9 +3772,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -3794,9 +3785,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -3807,9 +3798,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -3820,9 +3811,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -3833,9 +3824,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -3846,9 +3837,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -3859,9 +3850,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -3872,9 +3863,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -3885,9 +3876,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-south-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -3898,9 +3889,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-south-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -3911,9 +3902,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-south-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -3924,9 +3915,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -3937,9 +3928,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-south-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -3950,9 +3941,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-south-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -3963,9 +3954,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-south-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -3976,9 +3967,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -3989,9 +3980,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4002,9 +3993,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4015,9 +4006,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4028,9 +4019,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4041,9 +4032,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "me-central-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4054,9 +4045,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "me-central-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4067,9 +4058,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "me-central-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4080,9 +4071,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "me-central-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4093,9 +4084,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ca-central-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4106,9 +4097,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ca-central-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4119,9 +4110,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ca-central-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4132,9 +4123,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ca-central-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4145,9 +4136,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4158,9 +4149,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4171,9 +4162,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4184,9 +4175,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4195,9 +4186,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-west-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4208,9 +4199,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-west-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4219,9 +4210,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-west-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4232,9 +4223,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-west-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4245,9 +4236,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4258,9 +4249,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4271,9 +4262,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4284,9 +4275,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4297,9 +4288,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4310,9 +4301,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4323,9 +4314,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4336,9 +4327,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4349,9 +4340,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4362,9 +4353,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4375,9 +4366,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4388,9 +4379,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4401,9 +4392,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "af-south-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4414,9 +4405,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "af-south-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4427,9 +4418,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "af-south-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4440,9 +4431,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "af-south-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4453,9 +4444,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-north-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4466,9 +4457,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-north-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4479,9 +4470,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-north-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4492,9 +4483,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-north-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4505,9 +4496,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-3", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4518,9 +4509,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-3", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4531,9 +4522,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-3", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4544,9 +4535,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-3", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4557,9 +4548,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4570,9 +4561,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4583,9 +4574,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4596,9 +4587,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4609,9 +4600,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4622,9 +4613,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4635,9 +4626,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4648,9 +4639,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4661,9 +4652,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-3", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4674,9 +4665,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-3", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4687,9 +4678,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-3", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4700,9 +4691,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-3", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4713,9 +4704,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4726,9 +4717,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4739,9 +4730,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4752,9 +4743,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4765,9 +4756,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4778,9 +4769,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4791,9 +4782,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4804,9 +4795,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4817,9 +4808,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "me-south-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4830,9 +4821,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "me-south-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4843,9 +4834,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "me-south-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4856,9 +4847,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "me-south-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4869,9 +4860,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "sa-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4882,9 +4873,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "sa-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4895,9 +4886,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "sa-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4908,9 +4899,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "sa-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4921,9 +4912,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4934,9 +4925,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4947,9 +4938,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -4960,9 +4951,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -4973,9 +4964,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "cn-north-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -4986,9 +4977,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "cn-north-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -4999,9 +4990,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "cn-north-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5012,9 +5003,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "cn-north-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5025,9 +5016,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-west-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5038,9 +5029,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-west-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5051,9 +5042,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-west-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5064,9 +5055,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-west-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5077,9 +5068,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5090,9 +5081,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5103,9 +5094,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5116,9 +5107,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5129,9 +5120,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5142,9 +5133,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5155,9 +5146,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5168,9 +5159,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5179,9 +5170,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5192,9 +5183,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5203,9 +5194,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5216,9 +5207,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5229,9 +5220,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-3", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5242,9 +5233,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-3", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5255,9 +5246,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-3", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5268,9 +5259,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-3", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5281,9 +5272,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-4", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5294,9 +5285,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-4", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5307,9 +5298,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-4", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5320,9 +5311,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-4", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5333,9 +5324,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5346,9 +5337,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5359,9 +5350,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5372,9 +5363,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5385,9 +5376,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5398,9 +5389,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5411,9 +5402,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5424,9 +5415,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5437,9 +5428,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "cn-northwest-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5450,9 +5441,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "cn-northwest-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5463,9 +5454,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "cn-northwest-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5476,9 +5467,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "cn-northwest-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5487,9 +5478,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-isob-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -5500,9 +5491,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-isob-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -5511,9 +5502,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-isob-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -5524,9 +5515,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-isob-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -5537,9 +5528,9 @@ } }, "params": { - "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -5549,9 +5540,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -5561,9 +5552,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } } diff --git a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json index 2569b857b34..f82e2353bf3 100644 --- a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json +++ b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json @@ -596,7 +596,7 @@ "target": "com.amazonaws.ec2#AcceptVpcPeeringConnectionResult" }, "traits": { - "smithy.api#documentation": "

Accept a VPC peering connection request. To accept a request, the VPC peering connection must\n be in the pending-acceptance state, and you must be the owner of the peer VPC.\n Use DescribeVpcPeeringConnections to view your outstanding VPC\n peering connection requests.

\n \t

For an inter-Region VPC peering connection request, you must accept the VPC peering\n connection in the Region of the accepter VPC.

" + "smithy.api#documentation": "

Accept a VPC peering connection request. To accept a request, the VPC peering connection must\n be in the pending-acceptance state, and you must be the owner of the peer VPC.\n Use DescribeVpcPeeringConnections to view your outstanding VPC\n peering connection requests.

\n

For an inter-Region VPC peering connection request, you must accept the VPC peering\n connection in the Region of the accepter VPC.

" } }, "com.amazonaws.ec2#AcceptVpcPeeringConnectionRequest": { @@ -975,7 +975,7 @@ "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A description for the entry.

\n

Constraints: Up to 255 characters in length.

" + "smithy.api#documentation": "

A description for the entry.

\n

Constraints: Up to 255 characters in length.

" } } }, @@ -1378,7 +1378,7 @@ "target": "com.amazonaws.ec2#AdvertiseByoipCidrResult" }, "traits": { - "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.

\n

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.

\n

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" + "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.

\n

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.

\n

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" } }, "com.amazonaws.ec2#AdvertiseByoipCidrRequest": { @@ -1468,7 +1468,7 @@ "NetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.

\n

Use DescribeAvailabilityZones to view the network border groups.

\n \n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, \n you receive an InvalidParameterCombination error.

" + "smithy.api#documentation": "

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services\n advertises IP addresses. Use this parameter to limit the IP address to this location. IP\n addresses cannot move between network border groups.

\n

Use DescribeAvailabilityZones to view the network border groups.

\n

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, \n you receive an InvalidParameterCombination error.

" } }, "CustomerOwnedIpv4Pool": { @@ -1584,7 +1584,7 @@ "target": "com.amazonaws.ec2#AutoPlacement", "traits": { "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.

\n\n

Default: on\n

", + "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.

\n

Default: on\n

", "smithy.api#xmlName": "autoPlacement" } }, @@ -1610,14 +1610,14 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.

\n\n

If you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

", + "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.

\n

If you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

", "smithy.api#xmlName": "instanceType" } }, "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify\n an instance family, the Dedicated Hosts support multiple instance types within that\n instance family.

\n\n

If you want the Dedicated Hosts to support a specific instance type only, omit this\n parameter and specify InstanceType instead. You cannot\n specify InstanceFamily and InstanceType in the same request.

" + "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify\n an instance family, the Dedicated Hosts support multiple instance types within that\n instance family.

\n

If you want the Dedicated Hosts to support a specific instance type only, omit this\n parameter and specify InstanceType instead. You cannot\n specify InstanceFamily and InstanceType in the same request.

" } }, "Quantity": { @@ -1641,7 +1641,7 @@ "HostRecovery": { "target": "com.amazonaws.ec2#HostRecovery", "traits": { - "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. Host\n recovery is disabled by default. For more information, see Host recovery\n in the Amazon EC2 User Guide.

\n

Default: off\n

" + "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. Host\n recovery is disabled by default. For more information, see Host recovery\n in the Amazon EC2 User Guide.

\n

Default: off\n

" } }, "OutpostArn": { @@ -3800,15 +3800,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -6573,7 +6564,7 @@ "target": "com.amazonaws.ec2#AssignIpv6AddressesResult" }, "traits": { - "smithy.api#documentation": "

Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.

\n

You must specify either the IPv6 addresses or the IPv6 address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.

\n

You must specify either the IPv6 addresses or the IPv6 address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#AssignIpv6AddressesRequest": { @@ -6662,7 +6653,7 @@ "target": "com.amazonaws.ec2#AssignPrivateIpAddressesResult" }, "traits": { - "smithy.api#documentation": "

Assigns one or more secondary private IP addresses to the specified network interface.

\n

You can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

When you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.

\n

Remapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.

\n

You must specify either the IP addresses or the IP address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Assigns one or more secondary private IP addresses to the specified network interface.

\n

You can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

When you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.

\n

Remapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.

\n

You must specify either the IP addresses or the IP address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#AssignPrivateIpAddressesRequest": { @@ -6692,7 +6683,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressStringList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

\n

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "smithy.api#documentation": "

The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

\n

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "smithy.api#xmlName": "privateIpAddress" } }, @@ -6789,7 +6780,7 @@ "target": "com.amazonaws.ec2#AssociateAddressResult" }, "traits": { - "smithy.api#documentation": "

Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.

\n

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.

\n

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.

\n \n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.

\n

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic\n IP address is associated with the primary IP address. If the Elastic IP address is already\n associated with a different instance or a network interface, you get an error unless you allow\n reassociation. You cannot associate an Elastic IP address with an instance or network\n interface that has an existing Elastic IP address.

\n

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#AssociateAddressRequest": { @@ -6837,7 +6828,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

\n \t

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

", + "smithy.api#documentation": "

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

\n

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

", "smithy.api#xmlName": "networkInterfaceId" } }, @@ -6873,7 +6864,7 @@ "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetworkResult" }, "traits": { - "smithy.api#documentation": "

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

\n\t

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

" + "smithy.api#documentation": "

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

\n

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.

" } }, "com.amazonaws.ec2#AssociateClientVpnTargetNetworkRequest": { @@ -6985,7 +6976,7 @@ "target": "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleResult" }, "traits": { - "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.

\n\t\t\n\t\t

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

\n\t\t\n\t\t

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.

" + "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. \n\t\t\tThis enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more \n\t\t\tinformation, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves \n\t\t\t\t\tUser Guide.

\n

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted \n\t\t\tprivate key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate \n\t\t\tis encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

\n

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject \n\t\t\ton the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key,\n\t\t\tyou must grant it permission to call kms:Decrypt on the KMS key returned by the command. \n\t\t\tFor more information, see \n\t\t\t\tGrant the role permission to access the certificate and encryption key in the \n\t\t\tAmazon Web Services Nitro Enclaves User Guide.

" } }, "com.amazonaws.ec2#AssociateEnclaveCertificateIamRoleRequest": { @@ -7151,7 +7142,7 @@ "target": "com.amazonaws.ec2#AssociateRouteTableResult" }, "traits": { - "smithy.api#documentation": "

Associates a subnet in your VPC or an internet gateway or virtual private gateway\n attached to your VPC with a route table in your VPC. This association causes traffic\n from the subnet or gateway to be routed according to the routes in the route table. The\n action returns an association ID, which you need in order to disassociate the route\n table later. A route table can be associated with multiple subnets.

\n

For more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Associates a subnet in your VPC or an internet gateway or virtual private gateway\n attached to your VPC with a route table in your VPC. This association causes traffic\n from the subnet or gateway to be routed according to the routes in the route table. The\n action returns an association ID, which you need in order to disassociate the route\n table later. A route table can be associated with multiple subnets.

\n

For more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#AssociateRouteTableRequest": { @@ -7281,7 +7272,7 @@ "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult" }, "traits": { - "smithy.api#documentation": "

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

\n

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments \n to see the state of the attachment.

" + "smithy.api#documentation": "

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

\n

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments \n to see the state of the attachment.

" } }, "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest": { @@ -7445,7 +7436,7 @@ "target": "com.amazonaws.ec2#AssociateTrunkInterfaceResult" }, "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n \n

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

" + "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

" } }, "com.amazonaws.ec2#AssociateTrunkInterfaceRequest": { @@ -7530,7 +7521,7 @@ "target": "com.amazonaws.ec2#AssociateVpcCidrBlockResult" }, "traits": { - "smithy.api#documentation": "

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed\n at /56.

\n

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.

\n

For more information about associating CIDR blocks with your VPC and applicable\n restrictions, see VPC and subnet sizing in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block,\n an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that\n you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed\n at /56.

\n

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6\n pool, or an Amazon-provided IPv6 CIDR block.

\n

For more information about associating CIDR blocks with your VPC and applicable\n restrictions, see VPC and subnet sizing in the\n Amazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { @@ -7577,7 +7568,7 @@ "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + "smithy.api#documentation": "

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" } }, "Ipv4IpamPoolId": { @@ -7856,7 +7847,7 @@ "target": "com.amazonaws.ec2#AttachClassicLinkVpcResult" }, "traits": { - "smithy.api#documentation": "\n\t

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n\t \n\t

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's\n\t\t\tsecurity groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You\n\t\t\tcan only link an instance that's in the running state. An instance is\n\t\t\tautomatically unlinked from a VPC when it's stopped - you can link it to the VPC again when\n\t\t\tyou restart it.

\n\t\t

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

\n\t\t

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's\n\t\t\tsecurity groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You\n\t\t\tcan only link an instance that's in the running state. An instance is\n\t\t\tautomatically unlinked from a VPC when it's stopped - you can link it to the VPC again when\n\t\t\tyou restart it.

\n

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

\n

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" } }, "com.amazonaws.ec2#AttachClassicLinkVpcRequest": { @@ -8195,7 +8186,7 @@ "target": "com.amazonaws.ec2#AttachVpnGatewayResult" }, "traits": { - "smithy.api#documentation": "

Attaches a virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + "smithy.api#documentation": "

Attaches a virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" } }, "com.amazonaws.ec2#AttachVpnGatewayRequest": { @@ -8512,7 +8503,7 @@ "target": "com.amazonaws.ec2#AuthorizeSecurityGroupEgressResult" }, "traits": { - "smithy.api#documentation": "

[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.

\n

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR\n address ranges, or to the instances that are associated with the specified source\n security groups. When specifying an outbound rule for your security group in a VPC, the\n IpPermissions must include a destination for the traffic.

\n

You specify a protocol for each rule (for example, TCP). \n For the TCP and UDP protocols, you must also specify the destination port or port range. \n For the ICMP protocol, you must also specify the ICMP type and code. \n You can use -1 for the type or code to mean all types or all codes.

\n

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

\n

For information about VPC security group quotas, see Amazon VPC quotas.

" + "smithy.api#documentation": "

[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.

\n

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR\n address ranges, or to the instances that are associated with the specified source\n security groups. When specifying an outbound rule for your security group in a VPC, the\n IpPermissions must include a destination for the traffic.

\n

You specify a protocol for each rule (for example, TCP). \n For the TCP and UDP protocols, you must also specify the destination port or port range. \n For the ICMP protocol, you must also specify the ICMP type and code. \n You can use -1 for the type or code to mean all types or all codes.

\n

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

\n

For information about VPC security group quotas, see Amazon VPC quotas.

" } }, "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest": { @@ -8639,7 +8630,7 @@ "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult" }, "traits": { - "smithy.api#documentation": "

Adds the specified inbound (ingress) rules to a security group.

\n

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.

\n

You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.

\n

Rule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.

\n

For more information about VPC security group quotas, see Amazon VPC quotas.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Adds the specified inbound (ingress) rules to a security group.

\n

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.

\n

You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.

\n

Rule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.

\n

For more information about VPC security group quotas, see Amazon VPC quotas.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest": { @@ -8680,7 +8671,7 @@ "IpProtocol": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number\n (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

\n

[VPC only] Use -1 to specify all protocols. If you specify -1 or a \n protocol other than tcp, udp, or icmp, traffic on all ports \n is allowed, regardless of any ports you specify.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp) or number\n (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

\n

[VPC only] Use -1 to specify all protocols. If you specify -1 or a \n protocol other than tcp, udp, or icmp, traffic on all ports \n is allowed, regardless of any ports you specify.

\n

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" } }, "SourceSecurityGroupName": { @@ -9215,7 +9206,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", "smithy.api#xmlName": "virtualName" } }, @@ -9331,7 +9322,7 @@ "target": "com.amazonaws.ec2#BundleInstanceResult" }, "traits": { - "smithy.api#documentation": "

Bundles an Amazon instance store-backed Windows instance.

\n

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

\n \n

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

\n\t\t\t " + "smithy.api#documentation": "

Bundles an Amazon instance store-backed Windows instance.

\n

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

\n \n

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

\n " } }, "com.amazonaws.ec2#BundleInstanceRequest": { @@ -9756,7 +9747,7 @@ "target": "com.amazonaws.ec2#CancelCapacityReservationResult" }, "traits": { - "smithy.api#documentation": "

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to\n\t\t\tcancelled.

\n\t\t

Instances running in the reserved capacity continue running until you stop them. Stopped\n\t\t\tinstances that target the Capacity Reservation can no longer launch. Modify these instances to either\n\t\t\ttarget a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation\n\t\t\tthat has matching attributes and sufficient capacity.

" + "smithy.api#documentation": "

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to\n\t\t\tcancelled.

\n

Instances running in the reserved capacity continue running until you stop them. Stopped\n\t\t\tinstances that target the Capacity Reservation can no longer launch. Modify these instances to either\n\t\t\ttarget a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation\n\t\t\tthat has matching attributes and sufficient capacity.

" } }, "com.amazonaws.ec2#CancelCapacityReservationFleetError": { @@ -9798,7 +9789,7 @@ "target": "com.amazonaws.ec2#CancelCapacityReservationFleetsResult" }, "traits": { - "smithy.api#documentation": "

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation \n\t\t\tFleet, the following happens:

\n\t\t " + "smithy.api#documentation": "

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation \n\t\t\tFleet, the following happens:

\n " } }, "com.amazonaws.ec2#CancelCapacityReservationFleetsRequest": { @@ -9961,7 +9952,7 @@ "target": "com.amazonaws.ec2#CancelImageLaunchPermissionResult" }, "traits": { - "smithy.api#documentation": "

Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more\n information, see Cancel having an AMI shared with your Amazon Web Services account \n in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more\n information, see Cancel having an AMI shared with your Amazon Web Services account \n in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CancelImageLaunchPermissionRequest": { @@ -10121,7 +10112,7 @@ "target": "com.amazonaws.ec2#CancelSpotFleetRequestsResponse" }, "traits": { - "smithy.api#documentation": "

Cancels the specified Spot Fleet requests.

\n

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances.\n You must specify whether the Spot Fleet should also terminate its Spot Instances. If you\n terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.

" + "smithy.api#documentation": "

Cancels the specified Spot Fleet requests.

\n

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances.\n You must specify whether the Spot Fleet should also terminate its Spot Instances. If you\n terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.

" } }, "com.amazonaws.ec2#CancelSpotFleetRequestsError": { @@ -10329,7 +10320,7 @@ "target": "com.amazonaws.ec2#CancelSpotInstanceRequestsResult" }, "traits": { - "smithy.api#documentation": "

Cancels one or more Spot Instance requests.

\n \n

Canceling a Spot Instance request does not terminate running Spot Instances\n associated with the request.

\n " + "smithy.api#documentation": "

Cancels one or more Spot Instance requests.

\n \n

Canceling a Spot Instance request does not terminate running Spot Instances\n associated with the request.

\n " } }, "com.amazonaws.ec2#CancelSpotInstanceRequestsRequest": { @@ -10506,7 +10497,7 @@ "target": "com.amazonaws.ec2#CapacityReservationTenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n\t\t ", + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n ", "smithy.api#xmlName": "tenancy" } }, @@ -10554,7 +10545,7 @@ "target": "com.amazonaws.ec2#CapacityReservationState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n\t\t\t ", + "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n ", "smithy.api#xmlName": "state" } }, @@ -10578,7 +10569,7 @@ "target": "com.amazonaws.ec2#EndDateType", "traits": { "aws.protocols#ec2QueryName": "EndDateType", - "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n\t\t ", + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n ", "smithy.api#xmlName": "endDateType" } }, @@ -10586,7 +10577,7 @@ "target": "com.amazonaws.ec2#InstanceMatchCriteria", "traits": { "aws.protocols#ec2QueryName": "InstanceMatchCriteria", - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n\t\t ", + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n ", "smithy.api#xmlName": "instanceMatchCriteria" } }, @@ -10666,7 +10657,7 @@ "target": "com.amazonaws.ec2#CapacityReservationFleetState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Capacity Reservation Fleet. Possible states include:

\n\t\t ", + "smithy.api#documentation": "

The state of the Capacity Reservation Fleet. Possible states include:

\n ", "smithy.api#xmlName": "state" } }, @@ -10694,7 +10685,7 @@ "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the Capacity Reservation Fleet. Tenancies include:

\n\t\t ", + "smithy.api#documentation": "

The tenancy of the Capacity Reservation Fleet. Tenancies include:

\n ", "smithy.api#xmlName": "tenancy" } }, @@ -10718,7 +10709,7 @@ "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", "traits": { "aws.protocols#ec2QueryName": "InstanceMatchCriteria", - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.

\n\t\t

Currently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.

", + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.

\n

Currently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.

", "smithy.api#xmlName": "instanceMatchCriteria" } }, @@ -11086,7 +11077,7 @@ "CapacityReservationPreference": { "target": "com.amazonaws.ec2#CapacityReservationPreference", "traits": { - "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

\n\t\t " + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

\n " } }, "CapacityReservationTarget": { @@ -11097,7 +11088,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an instance's Capacity Reservation targeting option. You can specify only one parameter \n\t\t\tat a time. If you specify CapacityReservationPreference and \n\t\t\tCapacityReservationTarget, the request fails.

\n\t\t\t

Use the CapacityReservationPreference parameter to configure the instance\n\t\t\tto run as an On-Demand Instance or to run in any open Capacity Reservation that has\n\t\t\tmatching attributes (instance type, platform, Availability Zone). Use the\n\t\t\tCapacityReservationTarget parameter to explicitly target a specific\n\t\t\t \tCapacity Reservation or a Capacity Reservation group.

" + "smithy.api#documentation": "

Describes an instance's Capacity Reservation targeting option. You can specify only one parameter \n\t\t\tat a time. If you specify CapacityReservationPreference and \n\t\t\tCapacityReservationTarget, the request fails.

\n

Use the CapacityReservationPreference parameter to configure the instance\n\t\t\tto run as an On-Demand Instance or to run in any open Capacity Reservation that has\n\t\t\tmatching attributes (instance type, platform, Availability Zone). Use the\n\t\t\tCapacityReservationTarget parameter to explicitly target a specific\n\t\t\t \tCapacity Reservation or a Capacity Reservation group.

" } }, "com.amazonaws.ec2#CapacityReservationSpecificationResponse": { @@ -11107,7 +11098,7 @@ "target": "com.amazonaws.ec2#CapacityReservationPreference", "traits": { "aws.protocols#ec2QueryName": "CapacityReservationPreference", - "smithy.api#documentation": "

Describes the instance's Capacity Reservation preferences. Possible preferences include:

\n ", + "smithy.api#documentation": "

Describes the instance's Capacity Reservation preferences. Possible preferences include:

\n ", "smithy.api#xmlName": "capacityReservationPreference" } }, @@ -11479,7 +11470,7 @@ } }, "traits": { - "smithy.api#documentation": "\n\t

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n\t \n\t\t

Describes a linked EC2-Classic instance.

" + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes a linked EC2-Classic instance.

" } }, "com.amazonaws.ec2#ClassicLinkInstanceList": { @@ -11677,7 +11668,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Enable or disable a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

\n\t\t

Valid values: true | false\n

\n\t\t

Default value: false\n

" + "smithy.api#documentation": "

Enable or disable a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

\n

Valid values: true | false\n

\n

Default value: false\n

" } }, "BannerText": { @@ -11700,7 +11691,7 @@ "aws.protocols#ec2QueryName": "Enabled", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Current state of text banner feature.

\n\t\t

Valid values: true | false\n

", + "smithy.api#documentation": "

Current state of text banner feature.

\n

Valid values: true | false\n

", "smithy.api#xmlName": "enabled" } }, @@ -12138,7 +12129,7 @@ "aws.protocols#ec2QueryName": "SplitTunnel", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

\n\t\t

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint \n\t\t\tin the Client VPN Administrator Guide.

", + "smithy.api#documentation": "

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

\n

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint \n\t\t\tin the Client VPN Administrator Guide.

", "smithy.api#xmlName": "splitTunnel" } }, @@ -12249,7 +12240,7 @@ "aws.protocols#ec2QueryName": "SessionTimeoutHours", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n\t\t

Valid values: 8 | 10 | 12 | 24\n

\n\t\t

Default value: 24\n

", + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

", "smithy.api#xmlName": "sessionTimeoutHours" } }, @@ -12326,7 +12317,7 @@ "target": "com.amazonaws.ec2#ClientVpnEndpointStatusCode", "traits": { "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state of the Client VPN endpoint. Possible states include:

\n\t\t ", + "smithy.api#documentation": "

The state of the Client VPN endpoint. Possible states include:

\n ", "smithy.api#xmlName": "code" } }, @@ -12519,7 +12510,7 @@ "aws.protocols#ec2QueryName": "LogEnabled", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Status of VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

", + "smithy.api#documentation": "

Status of VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

", "smithy.api#xmlName": "logEnabled" } }, @@ -12535,7 +12526,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "LogOutputFormat", - "smithy.api#documentation": "

Configured log format. Default format is json.

\n

Valid values: json | text\n

", + "smithy.api#documentation": "

Configured log format. Default format is json.

\n

Valid values: json | text\n

", "smithy.api#xmlName": "logOutputFormat" } } @@ -12552,7 +12543,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Enable or disable VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

" + "smithy.api#documentation": "

Enable or disable VPN tunnel logging feature. Default value is False.

\n

Valid values: True | False\n

" } }, "LogGroupArn": { @@ -12564,7 +12555,7 @@ "LogOutputFormat": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Set log format. Default format is json.

\n\t

Valid values: json | text\n

" + "smithy.api#documentation": "

Set log format. Default format is json.

\n

Valid values: json | text\n

" } } }, @@ -13193,7 +13184,7 @@ "target": "com.amazonaws.ec2#CopyImageResult" }, "traits": { - "smithy.api#documentation": "

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

\n \t\n \t

To copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.

\n \t\n \t

To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

\n \n

For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

\n

To copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.

\n

To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

\n

For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CopyImageRequest": { @@ -13217,7 +13208,7 @@ "aws.protocols#ec2QueryName": "Encrypted", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the destination snapshots of the copied image should be encrypted. You\n can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an\n encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default\n Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

Specifies whether the destination snapshots of the copied image should be encrypted. You\n can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an\n encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default\n Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the\n Amazon EC2 User Guide.

", "smithy.api#xmlName": "encrypted" } }, @@ -13225,7 +13216,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating\n \t\tencrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. \n \t\tIf you specify a KMS key, you must also set the encrypted state to true.

\n \t

You can specify a KMS key using any of the following:

\n \t \n \t

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid,\n the action can appear to complete, but eventually fails.

\n \t

The specified KMS key must exist in the destination Region.

\n \t

Amazon EBS does not support asymmetric KMS keys.

", + "smithy.api#documentation": "

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating\n \t\tencrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. \n \t\tIf you specify a KMS key, you must also set the encrypted state to true.

\n

You can specify a KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid,\n the action can appear to complete, but eventually fails.

\n

The specified KMS key must exist in the destination Region.

\n

Amazon EBS does not support asymmetric KMS keys.

", "smithy.api#xmlName": "kmsKeyId" } }, @@ -13256,7 +13247,7 @@ "DestinationOutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.

\n \t

For more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.

\n

For more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon EC2 User Guide.

" } }, "DryRun": { @@ -13307,7 +13298,7 @@ "target": "com.amazonaws.ec2#CopySnapshotResult" }, "traits": { - "smithy.api#documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.

\n

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

\n \n \t\n

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.

\n \t\n \t

Snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For more information, see Copy an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.

\n

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

\n

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.

\n

Snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For more information, see Copy an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CopySnapshotRequest": { @@ -13322,14 +13313,14 @@ "DestinationOutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only \n\t\tspecify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. \n\t\tThe snapshot must be in the Region for the destination Outpost. You cannot copy a \n\t\tsnapshot from an Outpost to a Region, from one Outpost to another, or within the same \n\t\tOutpost.

\n \t

For more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only \n\t\tspecify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. \n\t\tThe snapshot must be in the Region for the destination Outpost. You cannot copy a \n\t\tsnapshot from an Outpost to a Region, from one Outpost to another, or within the same \n\t\tOutpost.

\n

For more information, see \n \t\tCopy snapshots from an Amazon Web Services Region to an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.

" } }, "DestinationRegion": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "DestinationRegion", - "smithy.api#documentation": "

The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.

\n \n

The snapshot copy is sent to the regional endpoint that you sent the HTTP\n \trequest to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is\n specified using the --region parameter or the default Region in your Amazon Web Services\n configuration file.

", + "smithy.api#documentation": "

The destination Region to use in the PresignedUrl parameter of a snapshot\n copy operation. This parameter is only valid for specifying the destination Region in a\n PresignedUrl parameter, where it is required.

\n

The snapshot copy is sent to the regional endpoint that you sent the HTTP\n \trequest to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is\n specified using the --region parameter or the default Region in your Amazon Web Services\n configuration file.

", "smithy.api#xmlName": "destinationRegion" } }, @@ -13534,7 +13525,7 @@ "target": "com.amazonaws.ec2#CreateCapacityReservationResult" }, "traits": { - "smithy.api#documentation": "

Creates a new Capacity Reservation with the specified attributes.

\n\t\t

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This \n\t\t\tgives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. \n\t\t\tBy creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. \n\t\t\tFor more information, see Capacity Reservations in the Amazon EC2 User Guide.

\n\t\t\n\t\t

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to\n\t\t\tfulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try\n\t\t\tagain at a later time, try in a different Availability Zone, or request a smaller\n\t\t\tcapacity reservation. If your application is flexible across instance types and sizes,\n\t\t\ttry to create a Capacity Reservation with different instance attributes.

\n\t\t\n\t\t

Your request could also fail if the requested quantity exceeds your On-Demand Instance\n\t\t\tlimit for the selected instance type. If your request fails due to limit constraints,\n\t\t\tincrease your On-Demand Instance limit for the required instance type and try again. For\n\t\t\tmore information about increasing your instance limits, see Amazon EC2 Service\n\t\t\t\tQuotas in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Creates a new Capacity Reservation with the specified attributes.

\n

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This \n\t\t\tgives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. \n\t\t\tBy creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. \n\t\t\tFor more information, see Capacity Reservations in the Amazon EC2 User Guide.

\n

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to\n\t\t\tfulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try\n\t\t\tagain at a later time, try in a different Availability Zone, or request a smaller\n\t\t\tcapacity reservation. If your application is flexible across instance types and sizes,\n\t\t\ttry to create a Capacity Reservation with different instance attributes.

\n

Your request could also fail if the requested quantity exceeds your On-Demand Instance\n\t\t\tlimit for the selected instance type. If your request fails due to limit constraints,\n\t\t\tincrease your On-Demand Instance limit for the required instance type and try again. For\n\t\t\tmore information about increasing your instance limits, see Amazon EC2 Service\n\t\t\t\tQuotas in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreateCapacityReservationFleet": { @@ -13555,7 +13546,7 @@ "AllocationStrategy": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The strategy used by the Capacity Reservation Fleet to determine which of the \n\t\t\tspecified instance types to use. Currently, only the prioritized \n\t\t\tallocation strategy is supported. For more information, see \n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.

\n\t\t

Valid values: prioritized\n

" + "smithy.api#documentation": "

The strategy used by the Capacity Reservation Fleet to determine which of the \n\t\t\tspecified instance types to use. Currently, only the prioritized \n\t\t\tallocation strategy is supported. For more information, see \n\t\t\t\tAllocation strategy in the Amazon EC2 User Guide.

\n

Valid values: prioritized\n

" } }, "ClientToken": { @@ -13577,7 +13568,7 @@ "Tenancy": { "target": "com.amazonaws.ec2#FleetCapacityReservationTenancy", "traits": { - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations \n\t\t\tin the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of \n\t\t\tthe following tenancy settings:

\n\t\t " + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations \n\t\t\tin the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of \n\t\t\tthe following tenancy settings:

\n " } }, "TotalTargetCapacity": { @@ -13592,13 +13583,13 @@ "EndDate": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity \n\t\t\tReservation Fleet expires, its state changes to expired and all of the Capacity \n\t\t\tReservations in the Fleet expire.

\t\n\t\t

The Capacity Reservation Fleet expires within an hour after the specified time. For example, \n\t\t\tif you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet \n\t\t\tis guaranteed to expire between 13:30:55 and 14:30:55 on \n\t\t\t5/31/2019.\n\t\t

" + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity \n\t\t\tReservation Fleet expires, its state changes to expired and all of the Capacity \n\t\t\tReservations in the Fleet expire.

\n

The Capacity Reservation Fleet expires within an hour after the specified time. For example, \n\t\t\tif you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet \n\t\t\tis guaranteed to expire between 13:30:55 and 14:30:55 on \n\t\t\t5/31/2019.\n\t\t

" } }, "InstanceMatchCriteria": { "target": "com.amazonaws.ec2#FleetInstanceMatchCriteria", "traits": { - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.

\n\t\t

Currently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.

" + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All \n\t\t\tCapacity Reservations in the Fleet inherit this instance matching criteria.

\n

Currently, Capacity Reservation Fleets support open instance matching criteria \n\t\t\tonly. This means that instances that have matching attributes (instance type, platform, and \n\t\t\tAvailability Zone) run in the Capacity Reservations automatically. Instances do not need to \n\t\t\texplicitly target a Capacity Reservation Fleet to use its reserved capacity.

" } }, "TagSpecifications": { @@ -13755,7 +13746,7 @@ "Tenancy": { "target": "com.amazonaws.ec2#CapacityReservationTenancy", "traits": { - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n\t\t " + "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n " } }, "InstanceCount": { @@ -13763,7 +13754,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of instances for which to reserve capacity.

\n\t \t

Valid range: 1 - 1000

", + "smithy.api#documentation": "

The number of instances for which to reserve capacity.

\n

Valid range: 1 - 1000

", "smithy.api#required": {} } }, @@ -13786,19 +13777,19 @@ "EndDate": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\t\n\t\t

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

\n\t\t\n\t\t

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

" + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

\n

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

" } }, "EndDateType": { "target": "com.amazonaws.ec2#EndDateType", "traits": { - "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n\t\t " + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n " } }, "InstanceMatchCriteria": { "target": "com.amazonaws.ec2#InstanceMatchCriteria", "traits": { - "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n\t\t \n\t\t

Default: open\n

" + "smithy.api#documentation": "

Indicates the type of instance launches that the Capacity Reservation accepts. The options\n\t\t\tinclude:

\n \n

Default: open\n

" } }, "TagSpecifications": { @@ -13946,7 +13937,7 @@ "target": "com.amazonaws.ec2#ConnectionLogOptions", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about the client connection logging options.

\n\t\t

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n\t\t ", + "smithy.api#documentation": "

Information about the client connection logging options.

\n

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n ", "smithy.api#required": {} } }, @@ -13959,7 +13950,7 @@ "TransportProtocol": { "target": "com.amazonaws.ec2#TransportProtocol", "traits": { - "smithy.api#documentation": "

The transport protocol to be used by the VPN session.

\n\t\t

Default value: udp\n

" + "smithy.api#documentation": "

The transport protocol to be used by the VPN session.

\n

Default value: udp\n

" } }, "VpnPort": { @@ -13967,7 +13958,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n\t

Valid Values: 443 | 1194\n

\n\t

Default Value: 443\n

" + "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n

Valid Values: 443 | 1194\n

\n

Default Value: 443\n

" } }, "Description": { @@ -13981,7 +13972,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether split-tunnel is enabled on the Client VPN endpoint.

\n\t\t

By default, split-tunnel on a VPN endpoint is disabled.

\n\t\t

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n\t\t\tClient VPN Administrator Guide.

" + "smithy.api#documentation": "

Indicates whether split-tunnel is enabled on the Client VPN endpoint.

\n

By default, split-tunnel on a VPN endpoint is disabled.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n\t\t\tClient VPN Administrator Guide.

" } }, "DryRun": { @@ -14022,7 +14013,7 @@ "SelfServicePortal": { "target": "com.amazonaws.ec2#SelfServicePortal", "traits": { - "smithy.api#documentation": "

Specify whether to enable the self-service portal for the Client VPN endpoint.

\n

Default Value: enabled\n

" + "smithy.api#documentation": "

Specify whether to enable the self-service portal for the Client VPN endpoint.

\n

Default Value: enabled\n

" } }, "ClientConnectOptions": { @@ -14036,7 +14027,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n\t\t

Valid values: 8 | 10 | 12 | 24\n

\n\t\t

Default value: 24\n

" + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

" } }, "ClientLoginBannerOptions": { @@ -14103,7 +14094,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination. For example:

\n\t\t ", + "smithy.api#documentation": "

The IPv4 address range, in CIDR notation, of the route destination. For example:

\n ", "smithy.api#required": {} } }, @@ -14111,7 +14102,7 @@ "target": "com.amazonaws.ec2#SubnetId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.

\n\t

Alternatively, if you're adding a route for the local network, specify local.

", + "smithy.api#documentation": "

The ID of the subnet through which you want to route traffic. The specified subnet must be\n\t\t\tan existing target network of the Client VPN endpoint.

\n

Alternatively, if you're adding a route for the local network, specify local.

", "smithy.api#required": {} } }, @@ -14267,7 +14258,7 @@ "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" }, "traits": { - "smithy.api#documentation": "

Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

" + "smithy.api#documentation": "

Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

" } }, "com.amazonaws.ec2#CreateCustomerGatewayRequest": { @@ -14278,7 +14269,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

For devices that support BGP, the customer gateway's BGP ASN.

\n

Default: 65000

", + "smithy.api#documentation": "

For devices that support BGP, the customer gateway's BGP ASN.

\n

Default: 65000

", "smithy.api#required": {} } }, @@ -14312,7 +14303,7 @@ "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

A name for the customer gateway device.

\n

Length Constraints: Up to 255 characters.

" + "smithy.api#documentation": "

A name for the customer gateway device.

\n

Length Constraints: Up to 255 characters.

" } }, "IpAddress": { @@ -14415,7 +14406,7 @@ "target": "com.amazonaws.ec2#CreateDefaultVpcResult" }, "traits": { - "smithy.api#documentation": "

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet\n\t\t\tin each Availability Zone. For more information about the components of a default VPC,\n\t\t\tsee Default VPC and\n\t\t\tdefault subnets in the Amazon Virtual Private Cloud User Guide. You cannot\n\t\t\tspecify the components of the default VPC yourself.

\n\t\t

If you deleted your previous default VPC, you can create a default VPC. You cannot have\n\t\t\tmore than one default VPC per Region.

\n\t\t

If your account supports EC2-Classic, you cannot use this action to create a default VPC\n\t\t\tin a Region that supports EC2-Classic. If you want a default VPC in a Region that\n\t\t\tsupports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is\n\t\t\tthat possible?\" in the Default VPCs\n\t\t\tFAQ.

\n\t \n\t

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n\t " + "smithy.api#documentation": "

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet\n\t\t\tin each Availability Zone. For more information about the components of a default VPC,\n\t\t\tsee Default VPC and\n\t\t\tdefault subnets in the Amazon Virtual Private Cloud User Guide. You cannot\n\t\t\tspecify the components of the default VPC yourself.

\n

If you deleted your previous default VPC, you can create a default VPC. You cannot have\n\t\t\tmore than one default VPC per Region.

\n

If your account supports EC2-Classic, you cannot use this action to create a default VPC\n\t\t\tin a Region that supports EC2-Classic. If you want a default VPC in a Region that\n\t\t\tsupports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is\n\t\t\tthat possible?\" in the Default VPCs\n\t\t\tFAQ.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#CreateDefaultVpcRequest": { @@ -14453,7 +14444,7 @@ "target": "com.amazonaws.ec2#CreateDhcpOptionsResult" }, "traits": { - "smithy.api#documentation": "

Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.

\n \n\n

Your VPC automatically starts out with a set of DHCP options that includes only a DNS\n\t\t\tserver that we provide (AmazonProvidedDNS). If you create a set of options, and if your\n\t\t\tVPC has an internet gateway, make sure to set the domain-name-servers\n\t\t\toption either to AmazonProvidedDNS or to a domain name server of your\n\t\t\tchoice. For more information, see DHCP options sets in the\n\t\t\tAmazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.

\n \n

Your VPC automatically starts out with a set of DHCP options that includes only a DNS\n\t\t\tserver that we provide (AmazonProvidedDNS). If you create a set of options, and if your\n\t\t\tVPC has an internet gateway, make sure to set the domain-name-servers\n\t\t\toption either to AmazonProvidedDNS or to a domain name server of your\n\t\t\tchoice. For more information, see DHCP options sets in the\n\t\t\tAmazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateDhcpOptionsRequest": { @@ -14824,7 +14815,7 @@ "target": "com.amazonaws.ec2#CreateFlowLogsResult" }, "traits": { - "smithy.api#documentation": "

Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.

\n \n

Flow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon Virtual Private Cloud User Guide.

\n \n

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.

\n \n

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.

\n

Flow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon Virtual Private Cloud User Guide.

\n

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.

\n

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateFlowLogsRequest": { @@ -14847,7 +14838,7 @@ "DeliverLogsPermissionArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in\n your account.

\n

This parameter is required if the destination type is cloud-watch-logs\n and unsupported otherwise.

" + "smithy.api#documentation": "

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in\n your account.

\n

This parameter is required if the destination type is cloud-watch-logs\n and unsupported otherwise.

" } }, "DeliverCrossAccountRole": { @@ -14859,14 +14850,14 @@ "LogGroupName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

\n

This parameter is valid only if the destination type is cloud-watch-logs.

" + "smithy.api#documentation": "

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

\n

This parameter is valid only if the destination type is cloud-watch-logs.

" } }, "ResourceIds": { "target": "com.amazonaws.ec2#FlowLogResourceIds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the resources to monitor. For example, if the resource type is\n VPC, specify the IDs of the VPCs.

\n

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the\n other resource types.

", + "smithy.api#documentation": "

The IDs of the resources to monitor. For example, if the resource type is\n VPC, specify the IDs of the VPCs.

\n

Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the\n other resource types.

", "smithy.api#required": {}, "smithy.api#xmlName": "ResourceId" } @@ -14888,19 +14879,19 @@ "LogDestinationType": { "target": "com.amazonaws.ec2#LogDestinationType", "traits": { - "smithy.api#documentation": "

The type of destination for the flow log data.

\n

Default: cloud-watch-logs\n

" + "smithy.api#documentation": "

The type of destination for the flow log data.

\n

Default: cloud-watch-logs\n

" } }, "LogDestination": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The destination for the flow log data. The meaning of this parameter depends on the destination type.

\n " + "smithy.api#documentation": "

The destination for the flow log data. The meaning of this parameter depends on the destination type.

\n " } }, "LogFormat": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

\n

Specify the fields using the ${field-id} format, separated by spaces. For\n the CLI, surround this parameter value with single quotes on Linux or\n double quotes on Windows.

" + "smithy.api#documentation": "

The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

\n

Specify the fields using the ${field-id} format, separated by spaces. For\n the CLI, surround this parameter value with single quotes on Linux or\n double quotes on Windows.

" } }, "TagSpecifications": { @@ -14915,7 +14906,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.

\n

Default: 600

" + "smithy.api#documentation": "

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. \n The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes).\n This parameter must be 60 seconds for transit gateway resource types.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.

\n

Default: 600

" } }, "DestinationOptions": { @@ -15049,7 +15040,7 @@ "target": "com.amazonaws.ec2#CreateImageResult" }, "traits": { - "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n\t

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \t \n\t\t\t\t\t

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n\t\t\t\t \n \n \n \n \t\n \t

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

\n \t

For more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \n

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n \n

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

\n

For more information, see Create an Amazon EBS-backed Linux\n AMI in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateImageRequest": { @@ -15107,14 +15098,14 @@ "aws.protocols#ec2QueryName": "NoReboot", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \t \n\t\t\t\t\t

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n\t\t\t\t \n

Default: false (follow standard reboot process)

", + "smithy.api#documentation": "

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \n

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n \n

Default: false (follow standard reboot process)

", "smithy.api#xmlName": "noReboot" } }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.

\n \n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", + "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.

\n \n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", "smithy.api#xmlName": "TagSpecification" } } @@ -15142,7 +15133,7 @@ "target": "com.amazonaws.ec2#CreateInstanceEventWindowResult" }, "traits": { - "smithy.api#documentation": "

Creates an event window in which scheduled events for the associated Amazon EC2 instances can\n run.

\n

You can define either a set of time ranges or a cron expression when creating the event\n window, but not both. All event window times are in UTC.

\n

You can create up to 200 event windows per Amazon Web Services Region.

\n

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags)\n are not yet associated with it. To ensure that the event window can be used, you must\n associate one or more targets with it by using the AssociateInstanceEventWindow API.

\n \n \n

Event windows are applicable only for scheduled events that stop, reboot, or\n terminate instances.

\n

Event windows are not applicable for:

\n \n \n \n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Creates an event window in which scheduled events for the associated Amazon EC2 instances can\n run.

\n

You can define either a set of time ranges or a cron expression when creating the event\n window, but not both. All event window times are in UTC.

\n

You can create up to 200 event windows per Amazon Web Services Region.

\n

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags)\n are not yet associated with it. To ensure that the event window can be used, you must\n associate one or more targets with it by using the AssociateInstanceEventWindow API.

\n \n

Event windows are applicable only for scheduled events that stop, reboot, or\n terminate instances.

\n

Event windows are not applicable for:

\n \n \n

For more information, see Define event windows for scheduled\n events in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreateInstanceEventWindowRequest": { @@ -15598,7 +15589,7 @@ "target": "com.amazonaws.ec2#KeyPair" }, "traits": { - "smithy.api#documentation": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.

\n\t\t

The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.

\n

The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateKeyPairRequest": { @@ -15608,7 +15599,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A unique name for the key pair.

\n\t

Constraints: Up to 255 ASCII characters

", + "smithy.api#documentation": "

A unique name for the key pair.

\n

Constraints: Up to 255 ASCII characters

", "smithy.api#required": {} } }, @@ -15625,7 +15616,7 @@ "KeyType": { "target": "com.amazonaws.ec2#KeyType", "traits": { - "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

\n

Default: rsa\n

" + "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

\n

Default: rsa\n

" } }, "TagSpecifications": { @@ -15638,7 +15629,7 @@ "KeyFormat": { "target": "com.amazonaws.ec2#KeyFormat", "traits": { - "smithy.api#documentation": "

The format of the key pair.

\n

Default: pem\n

" + "smithy.api#documentation": "

The format of the key pair.

\n

Default: pem\n

" } } } @@ -15652,7 +15643,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateLaunchTemplateRequest": { @@ -15669,7 +15660,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" } }, "LaunchTemplateName": { @@ -15697,7 +15688,7 @@ "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.

\n \n

To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch\n template data structure.

\n ", + "smithy.api#documentation": "

The tags to apply to the launch template on creation. To tag the launch template, the\n resource type must be launch-template.

\n \n

To specify the tags for the resources that are created when an instance is\n launched, you must use the TagSpecifications parameter in the launch\n template data structure.

\n ", "smithy.api#xmlName": "TagSpecification" } } @@ -15733,7 +15724,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionResult" }, "traits": { - "smithy.api#documentation": "

Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.

\n

Launch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.

\n

Launch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.

\n

For more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.

\n

Launch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.

\n

Launch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.

\n

For more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest": { @@ -15750,19 +15741,19 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" } }, "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" } }, "SourceVersion": { @@ -16082,7 +16073,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A name for the prefix list.

\n

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

", + "smithy.api#documentation": "

A name for the prefix list.

\n

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

", "smithy.api#required": {} } }, @@ -16113,14 +16104,14 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IP address type.

\n

Valid Values: IPv4 | IPv6\n

", + "smithy.api#documentation": "

The IP address type.

\n

Valid Values: IPv4 | IPv6\n

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraints: Up to 255 UTF-8 characters in length.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.

\n

Constraints: Up to 255 UTF-8 characters in length.

", "smithy.api#idempotencyToken": {} } } @@ -16148,7 +16139,7 @@ "target": "com.amazonaws.ec2#CreateNatGatewayResult" }, "traits": { - "smithy.api#documentation": "

Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.

\n

With a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.

\n

With a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.

\n

For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.

\n

With a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.

\n

With a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.

\n

For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateNatGatewayRequest": { @@ -16234,7 +16225,7 @@ "target": "com.amazonaws.ec2#CreateNetworkAclResult" }, "traits": { - "smithy.api#documentation": "

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

\n\t\t

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

\n

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateNetworkAclEntry": { @@ -16246,7 +16237,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of \n\t\t ingress rules and a separate set of egress rules.

\n\t\t

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

\n\t\t

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

\n

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of \n\t\t ingress rules and a separate set of egress rules.

\n

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

\n

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

\n

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateNetworkAclEntryRequest": { @@ -16575,7 +16566,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfaceResult" }, "traits": { - "smithy.api#documentation": "

Creates a network interface in the specified subnet.

\n

The number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.

\n

For more information about network interfaces, see Elastic network interfaces \n in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates a network interface in the specified subnet.

\n

The number of IP addresses you can assign to a network interface varies by instance\n type. For more information, see IP Addresses Per ENI Per\n Instance Type in the Amazon Virtual Private Cloud User Guide.

\n

For more information about network interfaces, see Elastic network interfaces \n in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermission": { @@ -16587,7 +16578,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult" }, "traits": { - "smithy.api#documentation": "

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.

\n\t

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

" + "smithy.api#documentation": "

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.

\n

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest": { @@ -16684,7 +16675,7 @@ "aws.protocols#ec2QueryName": "Ipv6AddressCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.

\n

You can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

\n

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.

", + "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.

\n

You can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

\n

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.

", "smithy.api#xmlName": "ipv6AddressCount" } }, @@ -16692,7 +16683,7 @@ "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

\n

You can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

", + "smithy.api#documentation": "

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

\n

You can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

", "smithy.api#xmlName": "ipv6Addresses" } }, @@ -16708,7 +16699,7 @@ "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "

The private IPv4 addresses.

\n

You can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", + "smithy.api#documentation": "

The private IPv4 addresses.

\n

You can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", "smithy.api#xmlName": "privateIpAddresses" } }, @@ -16718,14 +16709,14 @@ "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", + "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", "smithy.api#xmlName": "secondaryPrivateIpAddressCount" } }, "Ipv4Prefixes": { "target": "com.amazonaws.ec2#Ipv4PrefixList", "traits": { - "smithy.api#documentation": "

The IPv4 prefixes assigned to the network interface.

\n

You can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

", + "smithy.api#documentation": "

The IPv4 prefixes assigned to the network interface.

\n

You can't specify IPv4 prefixes if you've specified one of the following:\n a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

", "smithy.api#xmlName": "Ipv4Prefix" } }, @@ -16734,13 +16725,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.

" + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv4 prefixes if you've specified one of the following:\n specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4\n addresses.

" } }, "Ipv6Prefixes": { "target": "com.amazonaws.ec2#Ipv6PrefixList", "traits": { - "smithy.api#documentation": "

The IPv6 prefixes assigned to the network interface.

\n

You can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

", + "smithy.api#documentation": "

The IPv6 prefixes assigned to the network interface.

\n

You can't specify IPv6 prefixes if you've specified one of the following:\n a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

", "smithy.api#xmlName": "Ipv6Prefix" } }, @@ -16749,13 +16740,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

" + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

\n

You can't specify a count of IPv6 prefixes if you've specified one of the following:\n specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

" } }, "InterfaceType": { "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", "traits": { - "smithy.api#documentation": "

The type of network interface. The default is interface.

\n

The only supported values are efa and trunk.

" + "smithy.api#documentation": "

The type of network interface. The default is interface.

\n

The only supported values are efa and trunk.

" } }, "SubnetId": { @@ -16814,7 +16805,7 @@ "target": "com.amazonaws.ec2#CreatePlacementGroupResult" }, "traits": { - "smithy.api#documentation": "

Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.

\n

A cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.

\n

For more information, see Placement groups in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.

\n

A cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.

\n

For more information, see Placement groups in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreatePlacementGroupRequest": { @@ -16834,7 +16825,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

A name for the placement group. Must be unique within the scope of your account for\n the Region.

\n

Constraints: Up to 255 ASCII characters

", + "smithy.api#documentation": "

A name for the placement group. Must be unique within the scope of your account for\n the Region.

\n

Constraints: Up to 255 ASCII characters

", "smithy.api#xmlName": "groupName" } }, @@ -16864,7 +16855,7 @@ "SpreadLevel": { "target": "com.amazonaws.ec2#SpreadLevel", "traits": { - "smithy.api#documentation": "

Determines how placement groups spread instances.

\n " + "smithy.api#documentation": "

Determines how placement groups spread instances.

\n " } } } @@ -16936,7 +16927,7 @@ "target": "com.amazonaws.ec2#CreateReplaceRootVolumeTaskResult" }, "traits": { - "smithy.api#documentation": "

Replaces the EBS-backed root volume for a running instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.

\n \n

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Replaces the EBS-backed root volume for a running instance with a new \n volume that is restored to the original root volume's launch state, that is restored to a \n specific snapshot taken from the original root volume, or that is restored from an AMI \n that has the same key characteristics as that of the instance.

\n

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateReplaceRootVolumeTaskRequest": { @@ -17016,7 +17007,7 @@ "target": "com.amazonaws.ec2#CreateReservedInstancesListingResult" }, "traits": { - "smithy.api#documentation": "

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.

\n \n

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.

\n \n\t\t

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

\n\t\t

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.

\n

For more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon EC2 User Guide.

" + "smithy.api#documentation": "

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your\n\t\t\tStandard Reserved Instances, you can use the DescribeReservedInstances operation.

\n \n

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. \n Convertible Reserved Instances cannot be sold.

\n \n

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

\n

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance\n Marketplace. After completing the registration process, you can create a Reserved Instance\n Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price\n to receive for them. Your Standard Reserved Instance listings then become available for purchase. To\n view the details of your Standard Reserved Instance listing, you can use the\n DescribeReservedInstancesListings operation.

\n

For more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { @@ -17093,7 +17084,7 @@ "target": "com.amazonaws.ec2#CreateRestoreImageTaskResult" }, "traits": { - "smithy.api#documentation": "

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using\n CreateStoreImageTask.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using\n CreateStoreImageTask.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreateRestoreImageTaskRequest": { @@ -17160,7 +17151,7 @@ "target": "com.amazonaws.ec2#CreateRouteResult" }, "traits": { - "smithy.api#documentation": "

Creates a route in a route table within a VPC.

\n

You must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list.

\n

When determining how to route traffic, we use the route with the most specific match.\n For example, traffic is destined for the IPv4 address 192.0.2.3, and the\n route table includes the following two IPv4 routes:

\n\t\t\t \n\t\t

Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.

\n

For more information about route tables, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates a route in a route table within a VPC.

\n

You must specify either a destination CIDR block or a prefix list ID. You must also specify \n exactly one of the resources from the parameter list.

\n

When determining how to route traffic, we use the route with the most specific match.\n For example, traffic is destined for the IPv4 address 192.0.2.3, and the\n route table includes the following two IPv4 routes:

\n \n

Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.

\n

For more information about route tables, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateRouteRequest": { @@ -17251,7 +17242,7 @@ "CarrierGatewayId": { "target": "com.amazonaws.ec2#CarrierGatewayId", "traits": { - "smithy.api#documentation": "

The ID of the carrier gateway.

\n

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

" + "smithy.api#documentation": "

The ID of the carrier gateway.

\n

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

" } }, "NetworkInterfaceId": { @@ -17369,7 +17360,7 @@ "target": "com.amazonaws.ec2#CreateSecurityGroupResult" }, "traits": { - "smithy.api#documentation": "

Creates a security group.

\n

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

\n

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

\n

You can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.

\n

For more information about VPC security group limits, see Amazon VPC Limits.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Creates a security group.

\n

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

\n

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

\n

You can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.

\n

For more information about VPC security group limits, see Amazon VPC Limits.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#CreateSecurityGroupRequest": { @@ -17379,7 +17370,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A description for the security group. This is informational only.

\n\t\t

Constraints: Up to 255 characters in length

\n\t\t

Constraints for EC2-Classic: ASCII characters

\n\t\t

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "smithy.api#documentation": "

A description for the security group. This is informational only.

\n

Constraints: Up to 255 characters in length

\n

Constraints for EC2-Classic: ASCII characters

\n

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "smithy.api#required": {}, "smithy.api#xmlName": "GroupDescription" } @@ -17447,7 +17438,7 @@ "target": "com.amazonaws.ec2#Snapshot" }, "traits": { - "smithy.api#documentation": "

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.

\n \n \n

You can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.

\n \t\n

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.

\n

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the\n instance before taking the snapshot.

\n

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.

\n

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.

\n

You can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.

\n

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.

\n

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the\n instance before taking the snapshot.

\n

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.

\n

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateSnapshotRequest": { @@ -17462,7 +17453,7 @@ "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create a local \n \tsnapshot.

\n \t \n \t

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create a local \n \tsnapshot.

\n \n

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

" } }, "VolumeId": { @@ -17501,7 +17492,7 @@ "target": "com.amazonaws.ec2#CreateSnapshotsResult" }, "traits": { - "smithy.api#documentation": "

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.\n Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot\n each that is crash-consistent across the instance.

\n \n

You can include all of the volumes currently attached to the instance, or you can exclude \n the root volume or specific data (non-root) volumes from the multi-volume snapshot set.

\n \t\n

You can create multi-volume snapshots of instances in a Region and instances on an \n \tOutpost. If you create snapshots from an instance in a Region, the snapshots must be stored \n \tin the same Region as the instance. If you create snapshots from an instance on an Outpost, \n \tthe snapshots can be stored on the same Outpost as the instance, or in the Region for that \n \tOutpost.

" + "smithy.api#documentation": "

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.\n Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot\n each that is crash-consistent across the instance.

\n

You can include all of the volumes currently attached to the instance, or you can exclude \n the root volume or specific data (non-root) volumes from the multi-volume snapshot set.

\n

You can create multi-volume snapshots of instances in a Region and instances on an \n \tOutpost. If you create snapshots from an instance in a Region, the snapshots must be stored \n \tin the same Region as the instance. If you create snapshots from an instance on an Outpost, \n \tthe snapshots can be stored on the same Outpost as the instance, or in the Region for that \n \tOutpost.

" } }, "com.amazonaws.ec2#CreateSnapshotsRequest": { @@ -17524,7 +17515,7 @@ "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create the local \n \t\tsnapshots.

\n \t \n \t

For more information, see \n \t\tCreate multi-volume local snapshots from instances on an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost on which to create the local \n \t\tsnapshots.

\n \n

For more information, see \n \t\tCreate multi-volume local snapshots from instances on an Outpost in the \n \t\tAmazon Elastic Compute Cloud User Guide.

" } }, "TagSpecifications": { @@ -17636,7 +17627,7 @@ "target": "com.amazonaws.ec2#CreateStoreImageTaskResult" }, "traits": { - "smithy.api#documentation": "

Stores an AMI as a single object in an Amazon S3 bucket.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Stores an AMI as a single object in an Amazon S3 bucket.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreateStoreImageTaskRequest": { @@ -17697,7 +17688,7 @@ "target": "com.amazonaws.ec2#CreateSubnetResult" }, "traits": { - "smithy.api#documentation": "

Creates a subnet in a specified VPC.

\n

You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you\n can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP\n addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the\n CIDR block of an existing subnet in the VPC.

\n

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an\n IPv6 CIDR block that uses a /64 prefix length.

\n \n

Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR\n block. They're not available for use.

\n \n

If you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.

\n

When you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.

\n

For more information about subnets, see Your VPC and subnets in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates a subnet in a specified VPC.

\n

You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you\n can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP\n addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the\n CIDR block of an existing subnet in the VPC.

\n

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an\n IPv6 CIDR block that uses a /64 prefix length.

\n \n

Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR\n block. They're not available for use.

\n \n

If you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.

\n

When you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.

\n

For more information about subnets, see Your VPC and subnets in the\n Amazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateSubnetCidrReservation": { @@ -17735,7 +17726,7 @@ "target": "com.amazonaws.ec2#SubnetCidrReservationType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of reservation.

\n

The following are valid values:

\n ", + "smithy.api#documentation": "

The type of reservation.

\n

The following are valid values:

\n ", "smithy.api#required": {} } }, @@ -17806,7 +17797,7 @@ "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.

\n

This parameter is required for an IPv6 only subnet.

" + "smithy.api#documentation": "

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a\n /64 prefix length.

\n

This parameter is required for an IPv6 only subnet.

" } }, "OutpostArn": { @@ -17865,7 +17856,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.

\n \n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n resource-level permissions for Amazon EC2 API actions in the Amazon\n Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.

\n

For more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n resource-level permissions for Amazon EC2 API actions in the Amazon\n Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateTagsRequest": { @@ -17885,7 +17876,7 @@ "target": "com.amazonaws.ec2#ResourceIdList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n \t

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", "smithy.api#required": {}, "smithy.api#xmlName": "ResourceId" } @@ -18303,7 +18294,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayResult" }, "traits": { - "smithy.api#documentation": "

Creates a transit gateway.

\n

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks.\n After the transit gateway enters the available state, you can attach your VPCs and VPN\n connections to the transit gateway.

\n

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

\n

To attach a VPN connection, use CreateCustomerGateway to create a customer \n gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to\n CreateVpnConnection.

\n

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table\n and the default propagation route table. You can use CreateTransitGatewayRouteTable to create\n additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. \n You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource \n attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

" + "smithy.api#documentation": "

Creates a transit gateway.

\n

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks.\n After the transit gateway enters the available state, you can attach your VPCs and VPN\n connections to the transit gateway.

\n

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

\n

To attach a VPN connection, use CreateCustomerGateway to create a customer \n gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to\n CreateVpnConnection.

\n

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table\n and the default propagation route table. You can use CreateTransitGatewayRouteTable to create\n additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. \n You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource \n attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

" } }, "com.amazonaws.ec2#CreateTransitGatewayConnect": { @@ -18315,7 +18306,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayConnectResult" }, "traits": { - "smithy.api#documentation": "

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

\n

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

" + "smithy.api#documentation": "

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

\n

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

" } }, "com.amazonaws.ec2#CreateTransitGatewayConnectPeer": { @@ -18327,7 +18318,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayConnectPeerResult" }, "traits": { - "smithy.api#documentation": "

Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.

\n

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

\n

For more information, see Connect peers in the Transit Gateways Guide.

" + "smithy.api#documentation": "

Creates a Connect peer for a specified transit gateway Connect attachment between a\n transit gateway and an appliance.

\n

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

\n

For more information, see Connect peers in the Transit Gateways Guide.

" } }, "com.amazonaws.ec2#CreateTransitGatewayConnectPeerRequest": { @@ -18473,7 +18464,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainResult" }, "traits": { - "smithy.api#documentation": "

Creates a multicast domain using the specified transit gateway.

\n

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

" + "smithy.api#documentation": "

Creates a multicast domain using the specified transit gateway.

\n

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

" } }, "com.amazonaws.ec2#CreateTransitGatewayMulticastDomainRequest": { @@ -18558,7 +18549,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult" }, "traits": { - "smithy.api#documentation": "

Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The peer transit gateway can be in \n your account or a different Amazon Web Services account.

\n

After you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.

" + "smithy.api#documentation": "

Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The peer transit gateway can be in \n your account or a different Amazon Web Services account.

\n

After you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.

" } }, "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest": { @@ -19743,7 +19734,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n \t

Valid Range: Minimum value of 125. Maximum value of 1000.

" + "smithy.api#documentation": "

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" } }, "ClientToken": { @@ -19764,7 +19755,7 @@ "target": "com.amazonaws.ec2#CreateVpcResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create\n\t\t\tuses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4\n\t\t\taddresses). For more information about how large to make your VPC, see Your VPC and\n\t\t\t\tsubnets in the Amazon Virtual Private Cloud User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).

\n\t

By default, each instance you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create\n\t\t\tuses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4\n\t\t\taddresses). For more information about how large to make your VPC, see Your VPC and\n\t\t\t\tsubnets in the Amazon Virtual Private Cloud User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).

\n

By default, each instance you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateVpcEndpoint": { @@ -19788,7 +19779,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationResult" }, "traits": { - "smithy.api#documentation": "

Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Create a Topic in\n the Amazon Simple Notification Service Developer Guide.

\n

You can create a connection notification for interface endpoints only.

" + "smithy.api#documentation": "

Creates a connection notification for a specified VPC endpoint or VPC endpoint\n service. A connection notification notifies you of specific endpoint events. You must\n create an SNS topic to receive notifications. For more information, see Create a Topic in\n the Amazon Simple Notification Service Developer Guide.

\n

You can create a connection notification for interface endpoints only.

" } }, "com.amazonaws.ec2#CreateVpcEndpointConnectionNotificationRequest": { @@ -19873,7 +19864,7 @@ "VpcEndpointType": { "target": "com.amazonaws.ec2#VpcEndpointType", "traits": { - "smithy.api#documentation": "

The type of endpoint.

\n

Default: Gateway

" + "smithy.api#documentation": "

The type of endpoint.

\n

Default: Gateway

" } }, "VpcId": { @@ -19942,7 +19933,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.

\n

To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.

\n

Default: true\n

" + "smithy.api#documentation": "

(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.

\n

To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.

\n

Default: true\n

" } }, "TagSpecifications": { @@ -19990,7 +19981,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n IAM users, and IAM roles) can connect.

\n

Before you create an endpoint service, you must create one of the following for your service:

\n \n

If you set the private DNS name, you must prove that you own the private DNS domain\n name.

\n\t

For more information, see the Amazon Web Services PrivateLink \n\t Guide.

" + "smithy.api#documentation": "

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n IAM users, and IAM roles) can connect.

\n

Before you create an endpoint service, you must create one of the following for your service:

\n \n

If you set the private DNS name, you must prove that you own the private DNS domain\n name.

\n

For more information, see the Amazon Web Services PrivateLink \n\t Guide.

" } }, "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { @@ -20127,7 +20118,7 @@ "PeerRegion": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.

\n\t\t

Default: The Region in which you make the request.

" + "smithy.api#documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.

\n

Default: The Region in which you make the request.

" } }, "TagSpecifications": { @@ -20180,7 +20171,7 @@ "Ipv6CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" + "smithy.api#documentation": "

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

\n

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

" } }, "Ipv4IpamPoolId": { @@ -20262,7 +20253,7 @@ "target": "com.amazonaws.ec2#CreateVpnConnectionResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPN connection between an existing virtual private gateway or transit\n gateway and a customer gateway. The supported connection type is\n ipsec.1.

\n

The response includes information that you need to give to your network administrator\n to configure your customer gateway.

\n \n

We strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway device.

\n \n

If you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + "smithy.api#documentation": "

Creates a VPN connection between an existing virtual private gateway or transit\n gateway and a customer gateway. The supported connection type is\n ipsec.1.

\n

The response includes information that you need to give to your network administrator\n to configure your customer gateway.

\n \n

We strongly recommend that you use HTTPS when calling this operation because the\n response contains sensitive cryptographic information for configuring your customer\n gateway device.

\n \n

If you decide to shut down your VPN connection for any reason and later create a new\n VPN connection, you must reconfigure your customer gateway with the new information\n returned from this call.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon\n EC2 doesn't return an error.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" } }, "com.amazonaws.ec2#CreateVpnConnectionRequest": { @@ -20351,7 +20342,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + "smithy.api#documentation": "

Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" } }, "com.amazonaws.ec2#CreateVpnConnectionRouteRequest": { @@ -20387,7 +20378,7 @@ "target": "com.amazonaws.ec2#CreateVpnGatewayResult" }, "traits": { - "smithy.api#documentation": "

Creates a virtual private gateway. A virtual private gateway is the endpoint on the\n VPC side of your VPN connection. You can create a virtual private gateway before\n creating the VPC itself.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + "smithy.api#documentation": "

Creates a virtual private gateway. A virtual private gateway is the endpoint on the\n VPC side of your VPN connection. You can create a virtual private gateway before\n creating the VPC itself.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" } }, "com.amazonaws.ec2#CreateVpnGatewayRequest": { @@ -20419,7 +20410,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If\n you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a\n 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

\n

Default: 64512

" + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If\n you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a\n 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

\n

Default: 64512

" } }, "DryRun": { @@ -20460,7 +20451,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CpuCredits", - "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", "smithy.api#xmlName": "cpuCredits" } } @@ -20476,7 +20467,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#documentation": "

The credit option for CPU usage of a T instance.

\n

Valid values: standard | unlimited\n

", "smithy.api#required": {} } } @@ -20646,7 +20637,7 @@ "Statistic": { "target": "com.amazonaws.ec2#StatisticType", "traits": { - "smithy.api#documentation": "

Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:

\n\n " + "smithy.api#documentation": "

Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:

\n " } }, "Period": { @@ -20834,7 +20825,7 @@ "target": "com.amazonaws.ec2#DeleteCarrierGatewayResult" }, "traits": { - "smithy.api#documentation": "

Deletes a carrier gateway.

\n \n

If you do not delete the route that contains the carrier gateway as the\n Target, the route is a blackhole route. For information about how to delete a route, see \n DeleteRoute.

\n " + "smithy.api#documentation": "

Deletes a carrier gateway.

\n \n

If you do not delete the route that contains the carrier gateway as the\n Target, the route is a blackhole route. For information about how to delete a route, see \n DeleteRoute.

\n " } }, "com.amazonaws.ec2#DeleteCarrierGatewayRequest": { @@ -21334,7 +21325,7 @@ "target": "com.amazonaws.ec2#DeleteFleetsResult" }, "traits": { - "smithy.api#documentation": "

Deletes the specified EC2 Fleet.

\n

After you delete an EC2 Fleet, it launches no new instances.

\n

You must specify whether a deleted EC2 Fleet should also terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.

\n

For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. A deleted instant fleet with running instances is not\n supported.

\n

\n Restrictions\n

\n \n \n

For more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Deletes the specified EC2 Fleet.

\n

After you delete an EC2 Fleet, it launches no new instances.

\n

You must specify whether a deleted EC2 Fleet should also terminate its instances. If you\n choose to terminate the instances, the EC2 Fleet enters the deleted_terminating\n state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances\n continue to run until they are interrupted or you terminate them manually.

\n

For instant fleets, EC2 Fleet must terminate the instances when the fleet is\n deleted. A deleted instant fleet with running instances is not\n supported.

\n

\n Restrictions\n

\n \n

For more information, see Delete an EC2\n Fleet in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DeleteFleetsRequest": { @@ -21416,7 +21407,7 @@ "target": "com.amazonaws.ec2#FlowLogIdList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", + "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", "smithy.api#required": {}, "smithy.api#xmlName": "FlowLogId" } @@ -21787,13 +21778,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" } } } @@ -21837,13 +21828,13 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" } }, "Versions": { @@ -22946,7 +22937,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes a security group.

\n

If you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Deletes a security group.

\n

If you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#DeleteSecurityGroupRequest": { @@ -23152,7 +23143,7 @@ "traits": { "aws.protocols#ec2QueryName": "ResourceId", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n \t

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "smithy.api#documentation": "

The IDs of the resources, separated by spaces.

\n

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", "smithy.api#required": {}, "smithy.api#xmlName": "resourceId" } @@ -23161,7 +23152,7 @@ "target": "com.amazonaws.ec2#TagList", "traits": { "aws.protocols#ec2QueryName": "Tag", - "smithy.api#documentation": "

The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.

\n

If you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).

\n

Constraints: Up to 1000 tags.

", + "smithy.api#documentation": "

The tags to delete. Specify a tag key and an optional tag value to delete\n specific tags. If you specify a tag key without a tag value, we delete any tag with this\n key regardless of its value. If you specify a tag key with an empty string as the tag\n value, we delete the tag only if its value is an empty string.

\n

If you omit this parameter, we delete all user-defined tags for the specified\n resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:\n prefix).

\n

Constraints: Up to 1000 tags.

", "smithy.api#xmlName": "tag" } } @@ -24235,7 +24226,7 @@ "target": "com.amazonaws.ec2#DeleteVpcEndpointsResult" }, "traits": { - "smithy.api#documentation": "

Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.

\n \n

The following rules apply when you delete a VPC endpoint:

\n " + "smithy.api#documentation": "

Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.

\n \n

The following rules apply when you delete a VPC endpoint:

\n " } }, "com.amazonaws.ec2#DeleteVpcEndpointsRequest": { @@ -24363,7 +24354,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the specified VPN connection.

\n

If you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.

\n

For certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.

" + "smithy.api#documentation": "

Deletes the specified VPN connection.

\n

If you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.

\n

For certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.

" } }, "com.amazonaws.ec2#DeleteVpnConnectionRequest": { @@ -24644,7 +24635,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.

\n \n \n

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon Elastic Compute Cloud User Guide.

\n \n

When you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.

\n \t

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.

" + "smithy.api#documentation": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.

\n

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.

\n

When you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.

\n

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.

" } }, "com.amazonaws.ec2#DeregisterImageRequest": { @@ -24861,7 +24852,7 @@ "target": "com.amazonaws.ec2#DescribeAccountAttributesResult" }, "traits": { - "smithy.api#documentation": "

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

\n \n \n

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.

\n " + "smithy.api#documentation": "

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

\n \n \n

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide.

\n " } }, "com.amazonaws.ec2#DescribeAccountAttributesRequest": { @@ -25132,7 +25123,7 @@ "target": "com.amazonaws.ec2#DescribeAggregateIdFormatResult" }, "traits": { - "smithy.api#documentation": "

Describes the longer ID format settings for all resource types in a specific\n Region. This request is useful for performing a quick audit to determine whether a\n specific Region is fully opted in for longer IDs (17-character IDs).

\n \n

This request only returns information about resource types that support longer IDs.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc |\n vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

" + "smithy.api#documentation": "

Describes the longer ID format settings for all resource types in a specific\n Region. This request is useful for performing a quick audit to determine whether a\n specific Region is fully opted in for longer IDs (17-character IDs).

\n

This request only returns information about resource types that support longer IDs.

\n

The following resource types support longer IDs: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc |\n vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway.

" } }, "com.amazonaws.ec2#DescribeAggregateIdFormatRequest": { @@ -25526,7 +25517,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25616,7 +25607,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t \t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25682,7 +25673,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25740,7 +25731,7 @@ "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.

\n\t \n\t

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n\t ", + "smithy.api#documentation": "

Describes one or more of your linked EC2-Classic instances. This request only returns\n\t\t\tinformation about EC2-Classic instances linked to a VPC through ClassicLink. You cannot\n\t\t\tuse this request to return information about other instances.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -25765,7 +25756,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25792,7 +25783,7 @@ "aws.protocols#ec2QueryName": "MaxResults", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

\n\t\t

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

\n

Constraint: If the value is greater than 1000, we return only 1000 items.

", "smithy.api#xmlName": "maxResults" } }, @@ -25883,7 +25874,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n\t ", + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25960,7 +25951,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n\t ", + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -26064,7 +26055,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n\t ", + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -26141,7 +26132,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n\t ", + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -26252,7 +26243,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n\t ", + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -26500,7 +26491,7 @@ "target": "com.amazonaws.ec2#DescribeCustomerGatewaysResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your VPN customer gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", + "smithy.api#documentation": "

Describes one or more of your VPN customer gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", "smithy.waiters#waitable": { "CustomerGatewayAvailable": { "acceptors": [ @@ -26546,14 +26537,14 @@ "CustomerGatewayIds": { "target": "com.amazonaws.ec2#CustomerGatewayIdStringList", "traits": { - "smithy.api#documentation": "

One or more customer gateway IDs.

\n

Default: Describes all your customer gateways.

", + "smithy.api#documentation": "

One or more customer gateway IDs.

\n

Default: Describes all your customer gateways.

", "smithy.api#xmlName": "CustomerGatewayId" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -26597,7 +26588,7 @@ "target": "com.amazonaws.ec2#DescribeDhcpOptionsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your DHCP options sets.

\n\t\t

For more information, see DHCP options sets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#documentation": "

Describes one or more of your DHCP options sets.

\n

For more information, see DHCP options sets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -26622,14 +26613,14 @@ "DhcpOptionsIds": { "target": "com.amazonaws.ec2#DhcpOptionsIdStringList", "traits": { - "smithy.api#documentation": "

The IDs of one or more DHCP options sets.

\n\t\t

Default: Describes all your DHCP options sets.

", + "smithy.api#documentation": "

The IDs of one or more DHCP options sets.

\n

Default: Describes all your DHCP options sets.

", "smithy.api#xmlName": "DhcpOptionsId" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -26743,7 +26734,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n \t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } } @@ -26813,7 +26804,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -27062,7 +27053,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

Use the following filters to streamline results.

\n\t\t ", + "smithy.api#documentation": "

Use the following filters to streamline results.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -27778,7 +27769,7 @@ "target": "com.amazonaws.ec2#DescribeFlowLogsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more flow logs.

\n

To view the published flow log records, you must view the log destination. For example, \n the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.

", + "smithy.api#documentation": "

Describes one or more flow logs.

\n

To view the published flow log records, you must view the log destination. For example, \n the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -27801,13 +27792,13 @@ "Filter": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n " + "smithy.api#documentation": "

One or more filters.

\n " } }, "FlowLogIds": { "target": "com.amazonaws.ec2#FlowLogIdList", "traits": { - "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", + "smithy.api#documentation": "

One or more flow log IDs.

\n

Constraint: Maximum of 1000 flow log IDs.

", "smithy.api#xmlName": "FlowLogId" } }, @@ -27958,7 +27949,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n\t\t ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -28008,7 +27999,7 @@ "target": "com.amazonaws.ec2#DescribeHostReservationOfferingsResult" }, "traits": { - "smithy.api#documentation": "

Describes the Dedicated Host reservations that are available to purchase.

\n

The results describe all of the Dedicated Host reservation offerings, including\n offerings that might not match the instance family and Region of your Dedicated Hosts.\n When purchasing an offering, ensure that the instance family and Region of the offering\n matches that of the Dedicated Hosts with which it is to be associated. For more\n information about supported instance types, see Dedicated Hosts\n in the Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Describes the Dedicated Host reservations that are available to purchase.

\n

The results describe all of the Dedicated Host reservation offerings, including\n offerings that might not match the instance family and Region of your Dedicated Hosts.\n When purchasing an offering, ensure that the instance family and Region of the offering\n matches that of the Dedicated Hosts with which it is to be associated. For more\n information about supported instance types, see Dedicated Hosts\n in the Amazon EC2 User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28023,7 +28014,7 @@ "Filter": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n " + "smithy.api#documentation": "

The filters.

\n " } }, "MaxDuration": { @@ -28119,7 +28110,7 @@ "Filter": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n " + "smithy.api#documentation": "

The filters.

\n " } }, "HostReservationIdSet": { @@ -28174,7 +28165,7 @@ "target": "com.amazonaws.ec2#DescribeHostsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

\n

The results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.

", + "smithy.api#documentation": "

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

\n

The results describe only the Dedicated Hosts in the Region you're currently using.\n All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have\n recently been released are listed with the state released.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28190,7 +28181,7 @@ "target": "com.amazonaws.ec2#FilterList", "traits": { "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "filter" } }, @@ -28208,7 +28199,7 @@ "aws.protocols#ec2QueryName": "MaxResults", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

\n

You cannot specify this parameter and the host IDs parameter in the same\n request.

", + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

\n

You cannot specify this parameter and the host IDs parameter in the same\n request.

", "smithy.api#xmlName": "maxResults" } }, @@ -28284,7 +28275,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -28428,7 +28419,7 @@ "target": "com.amazonaws.ec2#ImageAttributeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The AMI attribute.

\n \t

\n Note: The blockDeviceMapping attribute is deprecated. \n \t Using this attribute returns the Client.AuthFailure error. To get information about \n \t the block device mappings for an AMI, use the DescribeImages action.

", + "smithy.api#documentation": "

The AMI attribute.

\n

\n Note: The blockDeviceMapping attribute is deprecated. \n \t Using this attribute returns the Client.AuthFailure error. To get information about \n \t the block device mappings for an AMI, use the DescribeImages action.

", "smithy.api#required": {} } }, @@ -28464,7 +28455,13 @@ "target": "com.amazonaws.ec2#DescribeImagesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

\n

The images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

", + "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

\n

The images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + }, "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -28531,7 +28528,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -28566,6 +28563,20 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } } } }, @@ -28579,6 +28590,14 @@ "smithy.api#documentation": "

Information about the images.

", "smithy.api#xmlName": "imagesSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } } } }, @@ -28751,7 +28770,7 @@ "target": "com.amazonaws.ec2#InstanceAttribute" }, "traits": { - "smithy.api#documentation": "

Describes the specified attribute of the specified instance. You can specify only one\n attribute at a time. Valid attribute values are: instanceType |\n kernel | ramdisk | userData |\n disableApiTermination | instanceInitiatedShutdownBehavior\n | rootDeviceName | blockDeviceMapping |\n productCodes | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport\n

" + "smithy.api#documentation": "

Describes the specified attribute of the specified instance. You can specify only one\n attribute at a time. Valid attribute values are: instanceType |\n kernel | ramdisk | userData |\n disableApiTermination | instanceInitiatedShutdownBehavior\n | rootDeviceName | blockDeviceMapping |\n productCodes | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport\n

" } }, "com.amazonaws.ec2#DescribeInstanceAttributeRequest": { @@ -28762,7 +28781,7 @@ "traits": { "aws.protocols#ec2QueryName": "Attribute", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance attribute.

\n

Note: The enaSupport attribute is not supported at this time.

", + "smithy.api#documentation": "

The instance attribute.

\n

Note: The enaSupport attribute is not supported at this time.

", "smithy.api#required": {}, "smithy.api#xmlName": "attribute" } @@ -28798,7 +28817,7 @@ "target": "com.amazonaws.ec2#DescribeInstanceCreditSpecificationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.

\n

If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.

\n

If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Describes the credit option for CPU usage of the specified burstable performance\n instances. The credit options are standard and\n unlimited.

\n

If you do not specify an instance ID, Amazon EC2 returns burstable performance\n instances with the unlimited credit option, as well as instances that were\n previously configured as T2, T3, and T3a with the unlimited credit option.\n For example, if you resize a T2 instance, while it is configured as\n unlimited, to an M4 instance, Amazon EC2 returns the M4\n instance.

\n

If you specify one or more instance IDs, Amazon EC2 returns the credit option\n (standard or unlimited) of those instances. If you specify\n an instance ID that is not valid, such as an instance that is not a burstable\n performance instance, an error is returned.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If an Availability Zone is experiencing a service disruption and you specify instance\n IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If\n you specify only instance IDs in an unaffected zone, the call works normally.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -28831,14 +28850,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { - "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 1000 explicitly specified instance IDs.

", + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 1000 explicitly specified instance IDs.

", "smithy.api#xmlName": "InstanceId" } }, @@ -29009,7 +29028,7 @@ "target": "com.amazonaws.ec2#DescribeInstanceStatusResult" }, "traits": { - "smithy.api#documentation": "

Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.

\n

Instance status includes the following components:

\n ", + "smithy.api#documentation": "

Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.

\n

Instance status includes the following components:

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29065,14 +29084,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { - "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

", + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

\n

Constraints: Maximum 100 explicitly specified instance IDs.

", "smithy.api#xmlName": "InstanceId" } }, @@ -29106,7 +29125,7 @@ "aws.protocols#ec2QueryName": "IncludeAllInstances", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

When true, includes the health status for all instances. When\n false, includes the health status for running instances only.

\n

Default: false\n

", + "smithy.api#documentation": "

When true, includes the health status for all instances. When\n false, includes the health status for running instances only.

\n

Default: false\n

", "smithy.api#xmlName": "includeAllInstances" } } @@ -29297,7 +29316,7 @@ "target": "com.amazonaws.ec2#DescribeInstancesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

", + "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.

\n

If you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29459,14 +29478,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { - "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

", + "smithy.api#documentation": "

The instance IDs.

\n

Default: Describes all your instances.

", "smithy.api#xmlName": "InstanceId" } }, @@ -29581,7 +29600,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -29599,7 +29618,7 @@ "target": "com.amazonaws.ec2#InternetGatewayIdList", "traits": { "aws.protocols#ec2QueryName": "InternetGatewayId", - "smithy.api#documentation": "

One or more internet gateway IDs.

\n

Default: Describes all your internet gateways.

", + "smithy.api#documentation": "

One or more internet gateway IDs.

\n

Default: Describes all your internet gateways.

", "smithy.api#xmlName": "internetGatewayId" } }, @@ -29933,7 +29952,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } } @@ -30004,7 +30023,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -30037,7 +30056,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

If true, the public key material is included in the response.

\n

Default: false\n

" + "smithy.api#documentation": "

If true, the public key material is included in the response.

\n

Default: false\n

" } } } @@ -30087,19 +30106,19 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateId or the LaunchTemplateName, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateId or the LaunchTemplateName, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateName or the LaunchTemplateId, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" + "smithy.api#documentation": "

The name of the launch template.

\n

To describe one or more versions of a specified launch template, you must specify\n either the LaunchTemplateName or the LaunchTemplateId, but not\n both.

\n

To describe all the latest or default launch template versions in your account, you\n must omit this parameter.

" } }, "Versions": { "target": "com.amazonaws.ec2#VersionStringList", "traits": { - "smithy.api#documentation": "

One or more versions of the launch template. Valid values depend on whether you are\n describing a specified launch template (by ID or name) or all launch templates in your\n account.

\n

To describe one or more versions of a specified launch template, valid values are\n $Latest, $Default, and numbers.

\n

To describe all launch templates in your account that are defined as the latest\n version, the valid value is $Latest. To describe all launch templates in\n your account that are defined as the default version, the valid value is\n $Default. You can specify $Latest and\n $Default in the same request. You cannot specify numbers.

", + "smithy.api#documentation": "

One or more versions of the launch template. Valid values depend on whether you are\n describing a specified launch template (by ID or name) or all launch templates in your\n account.

\n

To describe one or more versions of a specified launch template, valid values are\n $Latest, $Default, and numbers.

\n

To describe all launch templates in your account that are defined as the latest\n version, the valid value is $Latest. To describe all launch templates in\n your account that are defined as the default version, the valid value is\n $Default. You can specify $Latest and\n $Default in the same request. You cannot specify numbers.

", "smithy.api#xmlName": "LaunchTemplateVersion" } }, @@ -30132,7 +30151,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } } @@ -30215,7 +30234,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -30745,7 +30764,7 @@ "target": "com.amazonaws.ec2#DescribeManagedPrefixListsResult" }, "traits": { - "smithy.api#documentation": "

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

", + "smithy.api#documentation": "

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -30768,7 +30787,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -31033,7 +31052,7 @@ "Filter": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n " + "smithy.api#documentation": "

One or more filters.

\n " } }, "MaxResults": { @@ -31089,7 +31108,7 @@ "target": "com.amazonaws.ec2#DescribeNetworkAclsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your network ACLs.

\n\t\t

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#documentation": "

Describes one or more of your network ACLs.

\n

For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31114,7 +31133,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -31131,7 +31150,7 @@ "NetworkAclIds": { "target": "com.amazonaws.ec2#NetworkAclIdStringList", "traits": { - "smithy.api#documentation": "

One or more network ACL IDs.

\n\t\t

Default: Describes all your network ACLs.

", + "smithy.api#documentation": "

One or more network ACL IDs.

\n

Default: Describes all your network ACLs.

", "smithy.api#xmlName": "NetworkAclId" } }, @@ -31665,7 +31684,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -31773,7 +31792,7 @@ "target": "com.amazonaws.ec2#FilterList", "traits": { "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "filter" } }, @@ -31790,7 +31809,7 @@ "NetworkInterfaceIds": { "target": "com.amazonaws.ec2#NetworkInterfaceIdList", "traits": { - "smithy.api#documentation": "

The network interface IDs.

\n\t\t

Default: Describes all your network interfaces.

", + "smithy.api#documentation": "

The network interface IDs.

\n

Default: Describes all your network interfaces.

", "smithy.api#xmlName": "NetworkInterfaceId" } }, @@ -31855,7 +31874,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -31873,7 +31892,7 @@ "target": "com.amazonaws.ec2#PlacementGroupStringList", "traits": { "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The names of the placement groups.

\n

Default: Describes all your placement groups, or only those otherwise\n specified.

", + "smithy.api#documentation": "

The names of the placement groups.

\n

Default: Describes all your placement groups, or only those otherwise\n specified.

", "smithy.api#xmlName": "groupName" } }, @@ -31908,7 +31927,7 @@ "target": "com.amazonaws.ec2#DescribePrefixListsResult" }, "traits": { - "smithy.api#documentation": "

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

", + "smithy.api#documentation": "

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31931,7 +31950,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -32107,7 +32126,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } } @@ -32143,7 +32162,7 @@ "target": "com.amazonaws.ec2#DescribeRegionsResult" }, "traits": { - "smithy.api#documentation": "

Describes the Regions that are enabled for your account, or all Regions.

\n

For a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.

\n

For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

" + "smithy.api#documentation": "

Describes the Regions that are enabled for your account, or all Regions.

\n

For a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.

\n

For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

" } }, "com.amazonaws.ec2#DescribeRegionsRequest": { @@ -32307,7 +32326,7 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesListingsResult" }, "traits": { - "smithy.api#documentation": "

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

\n\t\t

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

\n\t\t

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

\n\t\t

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

\n

For more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

\n

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

\n

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

\n

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

\n

For more information, see Reserved Instance Marketplace \n in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest": { @@ -32366,7 +32385,7 @@ "target": "com.amazonaws.ec2#DescribeReservedInstancesModificationsResult" }, "traits": { - "smithy.api#documentation": "

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

\n \t

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

\n

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32481,7 +32500,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum duration (in seconds) to filter when searching for offerings.

\n\t\t

Default: 94608000 (3 years)

" + "smithy.api#documentation": "

The maximum duration (in seconds) to filter when searching for offerings.

\n

Default: 94608000 (3 years)

" } }, "MaxInstanceCount": { @@ -32489,7 +32508,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances to filter when searching for offerings.

\n\t\t

Default: 20

" + "smithy.api#documentation": "

The maximum number of instances to filter when searching for offerings.

\n

Default: 20

" } }, "MinDuration": { @@ -32497,7 +32516,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum duration (in seconds) to filter when searching for offerings.

\n\t\t

Default: 2592000 (1 month)

" + "smithy.api#documentation": "

The minimum duration (in seconds) to filter when searching for offerings.

\n

Default: 2592000 (1 month)

" } }, "OfferingClass": { @@ -32543,7 +32562,7 @@ "aws.protocols#ec2QueryName": "MaxResults", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n\t\t

Default: 100

", + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n

Default: 100

", "smithy.api#xmlName": "maxResults" } }, @@ -32663,7 +32682,7 @@ "target": "com.amazonaws.ec2#DescribeRouteTablesResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your route tables.

\n

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

\n\t\t

For more information, see Route tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", + "smithy.api#documentation": "

Describes one or more of your route tables.

\n

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

\n

For more information, see Route tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32688,7 +32707,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -32705,7 +32724,7 @@ "RouteTableIds": { "target": "com.amazonaws.ec2#RouteTableIdStringList", "traits": { - "smithy.api#documentation": "

One or more route table IDs.

\n\t\t

Default: Describes all your route tables.

", + "smithy.api#documentation": "

One or more route table IDs.

\n

Default: Describes all your route tables.

", "smithy.api#xmlName": "RouteTableId" } }, @@ -33042,7 +33061,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -33107,7 +33126,7 @@ "target": "com.amazonaws.ec2#DescribeSecurityGroupsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified security groups or all of your security groups.

\n

A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n ", + "smithy.api#documentation": "

Describes the specified security groups or all of your security groups.

\n

A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -33158,7 +33177,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

\n ", + "smithy.api#documentation": "

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -33647,7 +33666,7 @@ "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse" }, "traits": { - "smithy.api#documentation": "

Describes the events for the specified Spot Fleet request during the specified\n time.

\n

Spot Fleet events are delayed by up to 30 seconds before they can be described. This\n ensures that you can query by the last evaluated time and not miss a recorded event.\n Spot Fleet events are available for 48 hours.

\n

For more information, see Monitor fleet events using Amazon\n EventBridge in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Describes the events for the specified Spot Fleet request during the specified\n time.

\n

Spot Fleet events are delayed by up to 30 seconds before they can be described. This\n ensures that you can query by the last evaluated time and not miss a recorded event.\n Spot Fleet events are available for 48 hours.

\n

For more information, see Monitor fleet events using Amazon\n EventBridge in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults": { @@ -33739,7 +33758,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "LastEvaluatedTime", - "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more results, this value is not\n present.

", + "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more results, this value is not\n present.

", "smithy.api#xmlName": "lastEvaluatedTime" } }, @@ -33781,7 +33800,7 @@ "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse" }, "traits": { - "smithy.api#documentation": "

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.

", + "smithy.api#documentation": "

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -33867,7 +33886,7 @@ "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of results returned. This paginates the output, which makes the list\n more manageable and returns the results faster. If the list of results exceeds your\n MaxResults value, then that number of results is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n results.

\n

Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.

", + "smithy.api#documentation": "

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of results returned. This paginates the output, which makes the list\n more manageable and returns the results faster. If the list of results exceeds your\n MaxResults value, then that number of results is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n results.

\n

Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -33958,7 +33977,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -34031,7 +34050,7 @@ "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryResult" }, "traits": { - "smithy.api#documentation": "

Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide for Linux Instances.

\n

When you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.

", + "smithy.api#documentation": "

Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide for Linux Instances.

\n

When you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -34046,7 +34065,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -34247,7 +34266,7 @@ "target": "com.amazonaws.ec2#DescribeStoreImageTasksResult" }, "traits": { - "smithy.api#documentation": "

Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.

\n

For each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.

\n

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon Elastic Compute Cloud User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.

\n

For each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.

\n

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.

\n

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.

\n

For more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -34379,14 +34398,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, "SubnetIds": { "target": "com.amazonaws.ec2#SubnetIdStringList", "traits": { - "smithy.api#documentation": "

One or more subnet IDs.

\n\t\t

Default: Describes all your subnets.

", + "smithy.api#documentation": "

One or more subnet IDs.

\n

Default: Describes all your subnets.

", "smithy.api#xmlName": "SubnetId" } }, @@ -34865,7 +34884,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -34944,7 +34963,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -35023,7 +35042,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -35102,7 +35121,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -35555,7 +35574,7 @@ "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult" }, "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Describes one or more network interface trunk associations.

", + "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Describes one or more network interface trunk associations.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -35595,7 +35614,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -36438,7 +36457,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -36589,7 +36608,7 @@ "target": "com.amazonaws.ec2#DescribeVpcClassicLinkResult" }, "traits": { - "smithy.api#documentation": "

Describes the ClassicLink status of one or more VPCs.

\n\t \n\t

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n\t " + "smithy.api#documentation": "

Describes the ClassicLink status of one or more VPCs.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupport": { @@ -36686,7 +36705,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -36760,7 +36779,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -36833,7 +36852,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -36913,7 +36932,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -36994,7 +37013,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n\t\t ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -37044,7 +37063,7 @@ "target": "com.amazonaws.ec2#DescribeVpcEndpointServicesResult" }, "traits": { - "smithy.api#documentation": "

Describes available services to which you can create a VPC endpoint.

\n

When the service provider and the consumer have different accounts in multiple\n Availability Zones, and the consumer views the VPC endpoint service information, the\n response only includes the common Availability Zones. For example, when the service\n provider account uses us-east-1a and us-east-1c and the\n consumer uses us-east-1a and us-east-1b, the response includes\n the VPC endpoint services in the common Availability Zone,\n us-east-1a.

" + "smithy.api#documentation": "

Describes available services to which you can create a VPC endpoint.

\n

When the service provider and the consumer have different accounts in multiple\n Availability Zones, and the consumer views the VPC endpoint service information, the\n response only includes the common Availability Zones. For example, when the service\n provider account uses us-east-1a and us-east-1c and the\n consumer uses us-east-1a and us-east-1b, the response includes\n the VPC endpoint services in the common Availability Zone,\n us-east-1a.

" } }, "com.amazonaws.ec2#DescribeVpcEndpointServicesRequest": { @@ -37068,7 +37087,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -37077,7 +37096,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" + "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" } }, "NextToken": { @@ -37162,7 +37181,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -37171,7 +37190,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" + "smithy.api#documentation": "

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

\n

Constraint: If the value is greater than 1,000, we return only 1,000 items.

" } }, "NextToken": { @@ -37286,7 +37305,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -37415,14 +37434,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, "VpcIds": { "target": "com.amazonaws.ec2#VpcIdStringList", "traits": { - "smithy.api#documentation": "

One or more VPC IDs.

\n\t\t

Default: Describes all your VPCs.

", + "smithy.api#documentation": "

One or more VPC IDs.

\n

Default: Describes all your VPCs.

", "smithy.api#xmlName": "VpcId" } }, @@ -37482,7 +37501,7 @@ "target": "com.amazonaws.ec2#DescribeVpnConnectionsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your VPN connections.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", + "smithy.api#documentation": "

Describes one or more of your VPN connections.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

", "smithy.waiters#waitable": { "VpnConnectionAvailable": { "acceptors": [ @@ -37553,14 +37572,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, "VpnConnectionIds": { "target": "com.amazonaws.ec2#VpnConnectionIdStringList", "traits": { - "smithy.api#documentation": "

One or more VPN connection IDs.

\n

Default: Describes your VPN connections.

", + "smithy.api#documentation": "

One or more VPN connection IDs.

\n

Default: Describes your VPN connections.

", "smithy.api#xmlName": "VpnConnectionId" } }, @@ -37604,7 +37623,7 @@ "target": "com.amazonaws.ec2#DescribeVpnGatewaysResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your virtual private gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + "smithy.api#documentation": "

Describes one or more of your virtual private gateways.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" } }, "com.amazonaws.ec2#DescribeVpnGatewaysRequest": { @@ -37613,14 +37632,14 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, "VpnGatewayIds": { "target": "com.amazonaws.ec2#VpnGatewayIdStringList", "traits": { - "smithy.api#documentation": "

One or more virtual private gateway IDs.

\n

Default: Describes all your virtual private gateways.

", + "smithy.api#documentation": "

One or more virtual private gateway IDs.

\n

Default: Describes all your virtual private gateways.

", "smithy.api#xmlName": "VpnGatewayId" } }, @@ -37747,7 +37766,7 @@ "target": "com.amazonaws.ec2#DetachClassicLinkVpcResult" }, "traits": { - "smithy.api#documentation": "\n\t

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n\t \n\t\t

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" } }, "com.amazonaws.ec2#DetachClassicLinkVpcRequest": { @@ -37888,7 +37907,7 @@ "aws.protocols#ec2QueryName": "Force", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether to force a detachment.

\n \n \n ", + "smithy.api#documentation": "

Specifies whether to force a detachment.

\n \n \n ", "smithy.api#xmlName": "force" } } @@ -37996,13 +38015,13 @@ } }, "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "target": "com.amazonaws.ec2#InstanceIdForResolver", "traits": { "smithy.api#documentation": "

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

" } }, "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", + "target": "com.amazonaws.ec2#VolumeIdWithResolver", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the volume.

", @@ -38030,7 +38049,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).

\n

You must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.

" + "smithy.api#documentation": "

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).

\n

You must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.

" } }, "com.amazonaws.ec2#DetachVpnGatewayRequest": { @@ -38409,7 +38428,7 @@ "target": "com.amazonaws.ec2#DisableFastLaunchResult" }, "traits": { - "smithy.api#documentation": "

Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tWhen you disable faster launching, the AMI uses the standard launch process for each \n\t\t\tinstance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

\n\t\t \n\t\t\t

To change these settings, you must own the AMI.

\n\t\t " + "smithy.api#documentation": "

Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tWhen you disable faster launching, the AMI uses the standard launch process for each \n\t\t\tinstance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

\n \n

To change these settings, you must own the AMI.

\n " } }, "com.amazonaws.ec2#DisableFastLaunchRequest": { @@ -38788,7 +38807,7 @@ "target": "com.amazonaws.ec2#DisableImageDeprecationResult" }, "traits": { - "smithy.api#documentation": "

Cancels the deprecation of the specified AMI.

\n

For more information, see Deprecate an AMI in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Cancels the deprecation of the specified AMI.

\n

For more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DisableImageDeprecationRequest": { @@ -39038,7 +39057,7 @@ "target": "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportResult" }, "traits": { - "smithy.api#documentation": "

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to\n\t\t\tpublic IP addresses when addressed between a linked EC2-Classic instance and instances\n\t\t\tin the VPC to which it's linked. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n

You must specify a VPC ID in the request.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to\n\t\t\tpublic IP addresses when addressed between a linked EC2-Classic instance and instances\n\t\t\tin the VPC to which it's linked. For more information, see ClassicLink in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

\n

You must specify a VPC ID in the request.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#DisableVpcClassicLinkDnsSupportRequest": { @@ -39117,7 +39136,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n\t\t\t

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" } }, "com.amazonaws.ec2#DisassociateAddressRequest": { @@ -39156,7 +39175,7 @@ "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkResult" }, "traits": { - "smithy.api#documentation": "

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the \n\t\t\tlast target network from a Client VPN, the following happens:

\n\t\t " + "smithy.api#documentation": "

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the \n\t\t\tlast target network from a Client VPN, the following happens:

\n " } }, "com.amazonaws.ec2#DisassociateClientVpnTargetNetworkRequest": { @@ -39270,7 +39289,7 @@ "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileResult" }, "traits": { - "smithy.api#documentation": "

Disassociates an IAM instance profile from a running or stopped instance.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" + "smithy.api#documentation": "

Disassociates an IAM instance profile from a running or stopped instance.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" } }, "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest": { @@ -39362,7 +39381,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Disassociates a subnet or gateway from a route table.

\n\t\t

After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Disassociates a subnet or gateway from a route table.

\n

After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon Virtual Private Cloud User Guide.

" } }, "com.amazonaws.ec2#DisassociateRouteTableRequest": { @@ -39611,7 +39630,7 @@ "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceResult" }, "traits": { - "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Removes an association between a branch network interface with a trunk network interface.

" + "smithy.api#documentation": "\n

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Removes an association between a branch network interface with a trunk network interface.

" } }, "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest": { @@ -39674,7 +39693,7 @@ "target": "com.amazonaws.ec2#DisassociateVpcCidrBlockResult" }, "traits": { - "smithy.api#documentation": "

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must\n specify its association ID. You can get the association ID by using\n DescribeVpcs. You must detach or delete all gateways and resources that\n are associated with the CIDR block before you can disassociate it.

\n\t\t

You cannot disassociate the CIDR block with which you originally created the VPC (the\n\t\t\tprimary CIDR block).

" + "smithy.api#documentation": "

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must\n specify its association ID. You can get the association ID by using\n DescribeVpcs. You must detach or delete all gateways and resources that\n are associated with the CIDR block before you can disassociate it.

\n

You cannot disassociate the CIDR block with which you originally created the VPC (the\n\t\t\tprimary CIDR block).

" } }, "com.amazonaws.ec2#DisassociateVpcCidrBlockRequest": { @@ -40169,7 +40188,7 @@ "aws.protocols#ec2QueryName": "Iops", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 and io2 volumes, we guarantee 64,000 IOPS only for\n Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard\n volumes.

", + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes,\n this represents the number of IOPS that are provisioned for the volume. For gp2\n volumes, this represents the baseline performance of the volume and the rate at which\n the volume accumulates I/O credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 and io2 volumes, we guarantee 64,000 IOPS only for\n Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

This parameter is required for io1 and io2 volumes. The default for gp3 volumes\n is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard\n volumes.

", "smithy.api#xmlName": "iops" } }, @@ -40187,7 +40206,7 @@ "aws.protocols#ec2QueryName": "VolumeSize", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n ", + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. If you specify a snapshot, the default is the snapshot size. You can specify a\n volume size that is equal to or larger than the snapshot size.

\n

The following are the supported volumes sizes for each volume type:

\n ", "smithy.api#xmlName": "volumeSize" } }, @@ -40203,7 +40222,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", + "smithy.api#documentation": "

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", "smithy.api#xmlName": "kmsKeyId" } }, @@ -40213,7 +40232,7 @@ "aws.protocols#ec2QueryName": "Throughput", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

", + "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

\n

This parameter is valid only for gp3 volumes.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

", "smithy.api#xmlName": "throughput" } }, @@ -40221,7 +40240,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n \n CreateImage.

", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n \n CreateImage.

", "smithy.api#xmlName": "outpostArn" } }, @@ -40231,7 +40250,7 @@ "aws.protocols#ec2QueryName": "Encrypted", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.

\n

In no case can you remove encryption from an encrypted volume.

\n

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.

\n

This parameter is not returned by DescribeImageAttribute.

", + "smithy.api#documentation": "

Indicates whether the encryption state of an EBS volume is changed while being\n restored from a backing snapshot. The effect of setting the encryption state to true depends on \nthe volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.

\n

In no case can you remove encryption from an encrypted volume.

\n

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.

\n

This parameter is not returned by DescribeImageAttribute.

", "smithy.api#xmlName": "encrypted" } } @@ -40889,7 +40908,7 @@ } }, "traits": { - "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n\t\t

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" + "smithy.api#documentation": "

ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the \n\t\t\tmaximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. \n\t\t\tWith ENA Express, you can communicate between two EC2 instances in the same subnet within the same \n\t\t\taccount, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

\n

To improve the reliability of network packet delivery, ENA Express reorders network packets on the \n\t\t\treceiving end by default. However, some UDP-based applications are designed to handle network packets \n\t\t\tthat are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express \n\t\t\tis enabled, you can specify whether UDP network traffic uses it.

" } }, "com.amazonaws.ec2#EnaSrdSupported": { @@ -41061,7 +41080,7 @@ "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult" }, "traits": { - "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.

\n \t

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.

" + "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.

\n

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.

" } }, "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest": { @@ -41101,7 +41120,7 @@ "target": "com.amazonaws.ec2#EnableFastLaunchResult" }, "traits": { - "smithy.api#documentation": "

When you enable faster launching for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.

\n\t\t \n\t\t\t

To change these settings, you must own the AMI.

\n\t\t " + "smithy.api#documentation": "

When you enable faster launching for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.

\n \n

To change these settings, you must own the AMI.

\n " } }, "com.amazonaws.ec2#EnableFastLaunchRequest": { @@ -41498,7 +41517,7 @@ "target": "com.amazonaws.ec2#EnableImageDeprecationResult" }, "traits": { - "smithy.api#documentation": "

Enables deprecation of the specified AMI at the specified date and time.

\n

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Enables deprecation of the specified AMI at the specified date and time.

\n

For more information, see Deprecate an AMI in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#EnableImageDeprecationRequest": { @@ -42048,7 +42067,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "EventSubType", - "smithy.api#documentation": "

The event.

\n \n

\n error events:

\n \n \n

\n fleetRequestChange events:

\n \n \n

\n instanceChange events:

\n \n \n

\n Information events:

\n ", + "smithy.api#documentation": "

The event.

\n

\n error events:

\n \n

\n fleetRequestChange events:

\n \n

\n instanceChange events:

\n \n

\n Information events:

\n ", "smithy.api#xmlName": "eventSubType" } }, @@ -43356,7 +43375,7 @@ } }, "traits": { - "smithy.api#documentation": "

Request to create a launch template for a fast-launch enabled Windows AMI.

\n\t\t \n\t\t\t

Note - You can specify either the LaunchTemplateName or the \n\t\t\t\tLaunchTemplateId, but not both.

\n\t\t " + "smithy.api#documentation": "

Request to create a launch template for a fast-launch enabled Windows AMI.

\n \n

Note - You can specify either the LaunchTemplateName or the \n\t\t\t\tLaunchTemplateId, but not both.

\n " } }, "com.amazonaws.ec2#FastLaunchLaunchTemplateSpecificationResponse": { @@ -44258,7 +44277,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

", + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.

", "smithy.api#xmlName": "launchTemplateId" } }, @@ -44266,7 +44285,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

", + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.

", "smithy.api#xmlName": "launchTemplateName" } }, @@ -44274,13 +44293,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Version", - "smithy.api#documentation": "

The launch template version number, $Latest, or $Default.\n You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch\n template.

", + "smithy.api#documentation": "

The launch template version number, $Latest, or $Default.\n You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch\n template.

", "smithy.api#xmlName": "version" } } }, "traits": { - "smithy.api#documentation": "

The Amazon EC2 launch template that can be used by\n a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

\n

For information about launch templates,\n see Launch an instance from a launch template in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The Amazon EC2 launch template that can be used by\n a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

\n

For information about launch templates,\n see Launch an instance from a launch template in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest": { @@ -44627,7 +44646,7 @@ "aws.protocols#ec2QueryName": "MaxAggregationInterval", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.

\n

Valid Values: 60 | 600\n

", + "smithy.api#documentation": "

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

\n

When a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.

\n

Valid Values: 60 | 600\n

", "smithy.api#xmlName": "maxAggregationInterval" } }, @@ -44912,6 +44931,13 @@ "smithy.api#documentation": "

Indicates whether data retention support is enabled for the AFI.

", "smithy.api#xmlName": "dataRetentionSupport" } + }, + "InstanceTypes": { + "target": "com.amazonaws.ec2#InstanceTypesList", + "traits": { + "aws.protocols#ec2QueryName": "InstanceTypes", + "smithy.api#xmlName": "instanceTypes" + } } }, "traits": { @@ -45023,7 +45049,7 @@ "target": "com.amazonaws.ec2#FpgaImageStateCode", "traits": { "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The state. The following are the possible values:

\n\t\t ", + "smithy.api#documentation": "

The state. The following are the possible values:

\n ", "smithy.api#xmlName": "code" } }, @@ -45382,7 +45408,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

\n\t\t

Valid range: Minimum value of 1. Maximum value of 1000.

" + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

\n

Valid range: Minimum value of 1. Maximum value of 1000.

" } }, "DryRun": { @@ -45456,7 +45482,7 @@ "target": "com.amazonaws.ec2#CapacityReservationState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n\t\t\t ", + "smithy.api#documentation": "

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

\n ", "smithy.api#xmlName": "state" } }, @@ -45562,7 +45588,7 @@ "target": "com.amazonaws.ec2#GetConsoleOutputResult" }, "traits": { - "smithy.api#documentation": "

Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.

\n

By default, the console output returns buffered information that was posted shortly\n after an instance transition state (start, stop, reboot, or terminate). This information\n is available for at least one hour after the most recent post. Only the most recent 64\n KB of console output is available.

\n

You can optionally retrieve the latest serial console output at any time during the\n instance lifecycle. This option is supported on instance types that use the Nitro\n hypervisor.

\n

For more information, see Instance\n console output in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.

\n

By default, the console output returns buffered information that was posted shortly\n after an instance transition state (start, stop, reboot, or terminate). This information\n is available for at least one hour after the most recent post. Only the most recent 64\n KB of console output is available.

\n

You can optionally retrieve the latest serial console output at any time during the\n instance lifecycle. This option is supported on instance types that use the Nitro\n hypervisor.

\n

For more information, see Instance\n console output in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#GetConsoleOutputRequest": { @@ -45591,7 +45617,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

When enabled, retrieves the latest console output for the instance.

\n

Default: disabled (false)

" + "smithy.api#documentation": "

When enabled, retrieves the latest console output for the instance.

\n

Default: disabled (false)

" } } } @@ -45634,7 +45660,7 @@ "target": "com.amazonaws.ec2#GetConsoleScreenshotResult" }, "traits": { - "smithy.api#documentation": "

Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.

\n

The returned content is Base64-encoded.

" + "smithy.api#documentation": "

Retrieve a JPG-format screenshot of a running instance to help with\n troubleshooting.

\n

The returned content is Base64-encoded.

" } }, "com.amazonaws.ec2#GetConsoleScreenshotRequest": { @@ -45696,7 +45722,7 @@ "target": "com.amazonaws.ec2#GetDefaultCreditSpecificationResult" }, "traits": { - "smithy.api#documentation": "

Describes the default credit option for CPU usage of a burstable performance instance\n family.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Describes the default credit option for CPU usage of a burstable performance instance\n family.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#GetDefaultCreditSpecificationRequest": { @@ -45820,7 +45846,7 @@ "target": "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateResult" }, "traits": { - "smithy.api#documentation": "

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs \n with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. \n Based on the information that you provide, we configure resources in the template to do the following:

\n " + "smithy.api#documentation": "

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs \n with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. \n Based on the information that you provide, we configure resources in the template to do the following:

\n " } }, "com.amazonaws.ec2#GetFlowLogsIntegrationTemplateRequest": { @@ -45967,7 +45993,7 @@ "target": "com.amazonaws.ec2#GetHostReservationPurchasePreviewResult" }, "traits": { - "smithy.api#documentation": "

Preview a reservation purchase with configurations that match those of your Dedicated\n Host. You must have active Dedicated Hosts in your account before you purchase a\n reservation.

\n

This is a preview of the PurchaseHostReservation action and does not\n result in the offering being purchased.

" + "smithy.api#documentation": "

Preview a reservation purchase with configurations that match those of your Dedicated\n Host. You must have active Dedicated Hosts in your account before you purchase a\n reservation.

\n

This is a preview of the PurchaseHostReservation action and does not\n result in the offering being purchased.

" } }, "com.amazonaws.ec2#GetHostReservationPurchasePreviewRequest": { @@ -46129,7 +46155,7 @@ "target": "com.amazonaws.ec2#GetInstanceUefiDataResult" }, "traits": { - "smithy.api#documentation": "

A binary representation of the UEFI variable store. Only non-volatile variables are\n stored. This is a base64 encoded and zlib compressed binary value that must be properly\n encoded.

\n

When you use register-image to create\n an AMI, you can create an exact copy of your variable store by passing the UEFI data in\n the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on\n GitHub. You can use the tool to convert the UEFI data into a human-readable format\n (JSON), which you can inspect and modify, and then convert back into the binary format\n to use with register-image.

\n

For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

A binary representation of the UEFI variable store. Only non-volatile variables are\n stored. This is a base64 encoded and zlib compressed binary value that must be properly\n encoded.

\n

When you use register-image to create\n an AMI, you can create an exact copy of your variable store by passing the UEFI data in\n the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on\n GitHub. You can use the tool to convert the UEFI data into a human-readable format\n (JSON), which you can inspect and modify, and then convert back into the binary format\n to use with register-image.

\n

For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#GetInstanceUefiDataRequest": { @@ -46573,7 +46599,7 @@ "target": "com.amazonaws.ec2#GetLaunchTemplateDataResult" }, "traits": { - "smithy.api#documentation": "

Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.

\n

This action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes,\n DescribeInstanceAttribute, and DescribeElasticGpus. Or,\n you can allow describe* depending on your instance requirements.

" + "smithy.api#documentation": "

Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.

\n

This action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes,\n DescribeInstanceAttribute, and DescribeElasticGpus. Or,\n you can allow describe* depending on your instance requirements.

" } }, "com.amazonaws.ec2#GetLaunchTemplateDataRequest": { @@ -46915,7 +46941,7 @@ "target": "com.amazonaws.ec2#GetPasswordDataResult" }, "traits": { - "smithy.api#documentation": "

Retrieves the encrypted administrator password for a running Windows instance.

\n

The Windows password is generated at boot by the EC2Config service or\n EC2Launch scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.

\n

For the EC2Config service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword is enabled before bundling.

\n

The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.

\n

When you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.

", + "smithy.api#documentation": "

Retrieves the encrypted administrator password for a running Windows instance.

\n

The Windows password is generated at boot by the EC2Config service or\n EC2Launch scripts (Windows Server 2016 and later). This usually only\n happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the\n Amazon EC2 User Guide.

\n

For the EC2Config service, the password is not generated for rebundled\n AMIs unless Ec2SetPassword is enabled before bundling.

\n

The password is encrypted using the key pair that you specified when you launched the\n instance. You must provide the corresponding key pair file.

\n

When you launch an instance, password generation and encryption may take a few\n minutes. If you try to retrieve the password before it's available, the output returns\n an empty string. We recommend that you wait up to 15 minutes after launching an instance\n before trying to retrieve the generated password.

", "smithy.waiters#waitable": { "PasswordDataAvailable": { "acceptors": [ @@ -47290,7 +47316,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#documentation": "

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -47466,7 +47492,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -47695,7 +47721,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -48341,7 +48367,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

If you set this parameter to true, your instance is enabled for\n hibernation.

\n

Default: false\n

" + "smithy.api#documentation": "

If you set this parameter to true, your instance is enabled for\n hibernation.

\n

Default: false\n

" } } }, @@ -48364,7 +48390,7 @@ "target": "com.amazonaws.ec2#EventType", "traits": { "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The event type.

\n ", + "smithy.api#documentation": "

The event type.

\n ", "smithy.api#xmlName": "eventType" } }, @@ -49358,7 +49384,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PlatformDetails", - "smithy.api#documentation": "

The platform details associated with the billing code of the AMI. For more information,\n see Understand\n AMI billing information in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

The platform details associated with the billing code of the AMI. For more information,\n see Understand\n AMI billing information in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "platformDetails" } }, @@ -49496,7 +49522,7 @@ "target": "com.amazonaws.ec2#BootModeValues", "traits": { "aws.protocols#ec2QueryName": "BootMode", - "smithy.api#documentation": "

The boot mode of the image. For more information, see Boot modes in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

The boot mode of the image. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", "smithy.api#xmlName": "bootMode" } }, @@ -49504,7 +49530,7 @@ "target": "com.amazonaws.ec2#TpmSupportValues", "traits": { "aws.protocols#ec2QueryName": "TpmSupport", - "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0. \n For more information, see NitroTPM in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0. \n For more information, see NitroTPM in the\n Amazon EC2 User Guide.

", "smithy.api#xmlName": "tpmSupport" } }, @@ -49520,7 +49546,7 @@ "target": "com.amazonaws.ec2#ImdsSupportValues", "traits": { "aws.protocols#ec2QueryName": "ImdsSupport", - "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "imdsSupport" } } @@ -49616,7 +49642,7 @@ "target": "com.amazonaws.ec2#AttributeValue", "traits": { "aws.protocols#ec2QueryName": "UefiData", - "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

", "smithy.api#xmlName": "uefiData" } }, @@ -49632,7 +49658,7 @@ "target": "com.amazonaws.ec2#AttributeValue", "traits": { "aws.protocols#ec2QueryName": "ImdsSupport", - "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "imdsSupport" } } @@ -49736,7 +49762,7 @@ "Format": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: OVA | VHD | VHDX | VMDK | RAW \n

" + "smithy.api#documentation": "

The format of the disk image being imported.

\n

Valid values: OVA | VHD | VHDX | VMDK | RAW\n

" } }, "SnapshotId": { @@ -49948,7 +49974,7 @@ "target": "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListResult" }, "traits": { - "smithy.api#documentation": "

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

\n\t\t

Uploading a client certificate revocation list resets existing client connections.

" + "smithy.api#documentation": "

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

\n

Uploading a client certificate revocation list resets existing client connections.

" } }, "com.amazonaws.ec2#ImportClientVpnClientCertificateRevocationListRequest": { @@ -50801,7 +50827,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "", + "smithy.api#documentation": "", "smithy.api#xmlName": "keyFingerprint" } }, @@ -51306,7 +51332,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", + "smithy.api#documentation": "

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", "smithy.api#xmlName": "privateDnsName" } }, @@ -51338,7 +51364,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.

\n

A Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.

", + "smithy.api#documentation": "

The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.

\n

A Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.

", "smithy.api#xmlName": "ipAddress" } }, @@ -52111,7 +52137,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CpuCredits", - "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

", + "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

", "smithy.api#xmlName": "cpuCredits" } } @@ -52150,7 +52176,7 @@ "CpuCredits": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

\n

T3 instances with host tenancy do not support the unlimited\n CPU credit option.

" + "smithy.api#documentation": "

The credit option for CPU usage of the instance.

\n

Valid values: standard | unlimited\n

\n

T3 instances with host tenancy do not support the unlimited\n CPU credit option.

" } } }, @@ -52581,6 +52607,9 @@ "com.amazonaws.ec2#InstanceId": { "type": "string" }, + "com.amazonaws.ec2#InstanceIdForResolver": { + "type": "string" + }, "com.amazonaws.ec2#InstanceIdList": { "type": "list", "member": { @@ -52871,7 +52900,7 @@ "HttpTokens": { "target": "com.amazonaws.ec2#HttpTokensState", "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.

\n

If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.

\n

Default: optional\n

" + "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.

\n

If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.

\n

Default: optional\n

" } }, "HttpPutResponseHopLimit": { @@ -52879,13 +52908,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

" + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

" } }, "HttpEndpoint": { "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

\n

Default: enabled\n

" + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

\n

Default: enabled\n

" } }, "HttpProtocolIpv6": { @@ -52897,7 +52926,7 @@ "InstanceMetadataTags": { "target": "com.amazonaws.ec2#InstanceMetadataTagsState", "traits": { - "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" } } }, @@ -52912,7 +52941,7 @@ "target": "com.amazonaws.ec2#InstanceMetadataOptionsState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", + "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", "smithy.api#xmlName": "state" } }, @@ -52920,7 +52949,7 @@ "target": "com.amazonaws.ec2#HttpTokensState", "traits": { "aws.protocols#ec2QueryName": "HttpTokens", - "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.

\n

If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.

\n

Default: optional\n

", + "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.

\n

If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.

\n

Default: optional\n

", "smithy.api#xmlName": "httpTokens" } }, @@ -52930,7 +52959,7 @@ "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", "smithy.api#xmlName": "httpPutResponseHopLimit" } }, @@ -52938,7 +52967,7 @@ "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance\n metadata.

", + "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance\n metadata.

", "smithy.api#xmlName": "httpEndpoint" } }, @@ -53176,7 +53205,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "

The type of network interface.

\n\t

Valid values: interface | efa | trunk\n

", + "smithy.api#documentation": "

The type of network interface.

\n

Valid values: interface | efa | trunk\n

", "smithy.api#xmlName": "interfaceType" } }, @@ -53357,7 +53386,7 @@ "aws.protocols#ec2QueryName": "DeviceIndex", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The position of the network interface in the attachment order. \n A primary network interface has a device index of 0.

\n

If you specify a network interface when launching an instance, \n you must specify the device index.

", + "smithy.api#documentation": "

The position of the network interface in the attachment order. \n A primary network interface has a device index of 0.

\n

If you specify a network interface when launching an instance, \n you must specify the device index.

", "smithy.api#xmlName": "deviceIndex" } }, @@ -53390,7 +53419,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of the network interface.

\n

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

", + "smithy.api#documentation": "

The ID of the network interface.

\n

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

", "smithy.api#xmlName": "networkInterfaceId" } }, @@ -53433,13 +53462,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to assign a carrier IP address to the network interface.

\n

You can only assign a carrier IP address to a network interface that is in a subnet in\n a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer\n Guide.

" + "smithy.api#documentation": "

Indicates whether to assign a carrier IP address to the network interface.

\n

You can only assign a carrier IP address to a network interface that is in a subnet in\n a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer\n Guide.

" } }, "InterfaceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The type of network interface.

\n\t

Valid values: interface | efa\n

" + "smithy.api#documentation": "

The type of network interface.

\n

Valid values: interface | efa\n

" } }, "NetworkCardIndex": { @@ -53447,7 +53476,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

\n

If you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can’t specify the network card index when using this API. To specify the network\n card index, use RunInstances.

" + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

\n

If you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can’t specify the network card index when using this API. To specify the network\n card index, use RunInstances.

" } }, "Ipv4Prefixes": { @@ -53734,7 +53763,7 @@ "target": "com.amazonaws.ec2#AllowedInstanceTypeSet", "traits": { "aws.protocols#ec2QueryName": "AllowedInstanceTypeSet", - "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

\n \n

Default: All instance types

", + "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance types \n are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by\n an asterisk (*), to allow an instance type, size, or generation. The\n following are examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.

\n \n

Default: All instance types

", "smithy.api#xmlName": "allowedInstanceTypeSet" } } @@ -53973,7 +54002,7 @@ "aws.protocols#ec2QueryName": "Code", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The state of the instance as a 16-bit unsigned integer.

\n

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\n between 256 and 65,535. These numerical values are used for internal purposes and should\n be ignored.

\n

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\n between 0 and 255.

\n

The valid values for instance-state-code will all be in the range of the low byte and\n they are:

\n \n

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\n decimal.

", + "smithy.api#documentation": "

The state of the instance as a 16-bit unsigned integer.

\n

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\n between 256 and 65,535. These numerical values are used for internal purposes and should\n be ignored.

\n

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\n between 0 and 255.

\n

The valid values for instance-state-code will all be in the range of the low byte and\n they are:

\n \n

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\n decimal.

", "smithy.api#xmlName": "code" } }, @@ -54200,7 +54229,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the event.

\n

After a scheduled event is completed, it can still be described for up to a week. If\n the event has been completed, this description starts with the following text:\n [Completed].

", + "smithy.api#documentation": "

A description of the event.

\n

After a scheduled event is completed, it can still be described for up to a week. If\n the event has been completed, this description starts with the following text:\n [Completed].

", "smithy.api#xmlName": "description" } }, @@ -58129,6 +58158,15 @@ } } }, + "com.amazonaws.ec2#InstanceTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#InstanceUsage": { "type": "structure", "members": { @@ -60300,7 +60338,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "", + "smithy.api#documentation": "", "smithy.api#xmlName": "keyFingerprint" } }, @@ -60368,7 +60406,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair:

\n \n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n ", + "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair:

\n \n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n ", "smithy.api#xmlName": "keyFingerprint" } }, @@ -60408,7 +60446,7 @@ "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

If you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.

\n

If you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.

", + "smithy.api#documentation": "

If you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.

\n

If you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.

", "smithy.api#xmlName": "createTime" } } @@ -60885,7 +60923,7 @@ "CapacityReservationPreference": { "target": "com.amazonaws.ec2#CapacityReservationPreference", "traits": { - "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n " + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n " } }, "CapacityReservationTarget": { @@ -60906,7 +60944,7 @@ "target": "com.amazonaws.ec2#CapacityReservationPreference", "traits": { "aws.protocols#ec2QueryName": "CapacityReservationPreference", - "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n ", + "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n ", "smithy.api#xmlName": "capacityReservationPreference" } }, @@ -61114,7 +61152,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 and io2 volumes, we guarantee\n 64,000 IOPS only for Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

This parameter is supported for io1, io2, and gp3 volumes only. This parameter\n is not supported for gp2, st1, sc1, or standard volumes.

" + "smithy.api#documentation": "

The number of I/O operations per second (IOPS). For gp3,\n io1, and io2 volumes, this represents the number of IOPS that\n are provisioned for the volume. For gp2 volumes, this represents the\n baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 and io2 volumes, we guarantee\n 64,000 IOPS only for Instances built on the\n Nitro System. Other instance families guarantee performance up to\n 32,000 IOPS.

\n

This parameter is supported for io1, io2, and gp3 volumes only. This parameter\n is not supported for gp2, st1, sc1, or standard volumes.

" } }, "KmsKeyId": { @@ -61134,7 +61172,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:

\n " + "smithy.api#documentation": "

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume\n size. The following are the supported volumes sizes for each volume type:

\n " } }, "VolumeType": { @@ -61148,7 +61186,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" + "smithy.api#documentation": "

The throughput to provision for a gp3 volume, with a maximum of 1,000\n MiB/s.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" } } }, @@ -61172,7 +61210,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

" + "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

" } } }, @@ -61215,7 +61253,7 @@ "aws.protocols#ec2QueryName": "Count", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

", + "smithy.api#documentation": "

The number of elastic inference accelerators to attach to the instance.

\n

Default: 1

", "smithy.api#xmlName": "count" } } @@ -61334,7 +61372,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

If you set this parameter to true, the instance is enabled for\n hibernation.

\n

Default: false\n

" + "smithy.api#documentation": "

If you set this parameter to true, the instance is enabled for\n hibernation.

\n

Default: false\n

" } } }, @@ -61513,7 +61551,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataOptionsState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", + "smithy.api#documentation": "

The state of the metadata option changes.

\n

\n pending - The metadata options are being updated and the instance is not\n ready to process metadata traffic with the new selection.

\n

\n applied - The metadata options have been successfully applied on the\n instance.

", "smithy.api#xmlName": "state" } }, @@ -61521,7 +61559,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", "traits": { "aws.protocols#ec2QueryName": "HttpTokens", - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

", + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

", "smithy.api#xmlName": "httpTokens" } }, @@ -61531,7 +61569,7 @@ "aws.protocols#ec2QueryName": "HttpPutResponseHopLimit", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

\n

Possible values: Integers from 1 to 64

", "smithy.api#xmlName": "httpPutResponseHopLimit" } }, @@ -61539,7 +61577,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", "traits": { "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n ", + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n ", "smithy.api#xmlName": "httpEndpoint" } }, @@ -61547,7 +61585,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6", "traits": { "aws.protocols#ec2QueryName": "HttpProtocolIpv6", - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

", + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

", "smithy.api#xmlName": "httpProtocolIpv6" } }, @@ -61555,7 +61593,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState", "traits": { "aws.protocols#ec2QueryName": "InstanceMetadataTags", - "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

", + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

", "smithy.api#xmlName": "instanceMetadataTags" } } @@ -61570,7 +61608,7 @@ "HttpTokens": { "target": "com.amazonaws.ec2#LaunchTemplateHttpTokensState", "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

" + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

" } }, "HttpPutResponseHopLimit": { @@ -61578,25 +61616,25 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1\n

\n

Possible values: Integers from 1 to 64

" + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1\n

\n

Possible values: Integers from 1 to 64

" } }, "HttpEndpoint": { "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " } }, "HttpProtocolIpv6": { "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataProtocolIpv6", "traits": { - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

" + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

\n

Default: disabled\n

" } }, "InstanceMetadataTags": { "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataTagsState", "traits": { - "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" } } }, @@ -61664,7 +61702,7 @@ "aws.protocols#ec2QueryName": "AssociateCarrierIpAddress", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to associate a Carrier IP address with eth0 for a new network\n interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

", + "smithy.api#documentation": "

Indicates whether to associate a Carrier IP address with eth0 for a new network\n interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

", "smithy.api#xmlName": "associateCarrierIpAddress" } }, @@ -61850,7 +61888,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Associates a Carrier IP address with eth0 for a new network interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

" + "smithy.api#documentation": "

Associates a Carrier IP address with eth0 for a new network interface.

\n

Use this option when you launch an instance in a Wavelength Zone and want to associate\n a Carrier IP address with the network interface. For more information about Carrier IP\n addresses, see Carrier IP addresses in the Wavelength Developer\n Guide.

" } }, "AssociatePublicIpAddress": { @@ -61893,7 +61931,7 @@ "InterfaceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa. For more information, see Elastic Fabric Adapter in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you are not creating an EFA, specify interface or omit this\n parameter.

\n

Valid values: interface | efa\n

" + "smithy.api#documentation": "

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa. For more information, see Elastic Fabric Adapter in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you are not creating an EFA, specify interface or omit this\n parameter.

\n

Valid values: interface | efa\n

" } }, "Ipv6AddressCount": { @@ -62076,7 +62114,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to \n increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", "smithy.api#xmlName": "spotPrice" } }, @@ -62112,7 +62150,7 @@ "aws.protocols#ec2QueryName": "Priority", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

", + "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

", "smithy.api#xmlName": "priority" } }, @@ -62365,19 +62403,19 @@ "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" } }, "Version": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The launch template version number, $Latest, or\n $Default.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the\n launch template.

\n

Default: The default version of the launch template.

" + "smithy.api#documentation": "

The launch template version number, $Latest, or\n $Default.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the\n launch template.

\n

Default: The default version of the launch template.

" } } }, @@ -62392,7 +62430,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "MaxPrice", - "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n ", + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n ", "smithy.api#xmlName": "maxPrice" } }, @@ -62441,7 +62479,7 @@ "MaxPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " + "smithy.api#documentation": "

The maximum hourly price you're willing to pay for the Spot Instances. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " } }, "SpotInstanceType": { @@ -62461,7 +62499,7 @@ "ValidUntil": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ). Supported only for\n persistent requests.

\n \n

Default: 7 days from the current date

" + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ). Supported only for\n persistent requests.

\n \n

Default: 7 days from the current date

" } }, "InstanceInterruptionBehavior": { @@ -62514,7 +62552,7 @@ "ResourceType": { "target": "com.amazonaws.ec2#ResourceType", "traits": { - "smithy.api#documentation": "

The type of resource to tag.

\n

The Valid Values are all the resource types that can be tagged. However,\n when creating a launch template, you can specify tags for the following resource types\n only: instance | volume | elastic-gpu |\n network-interface | spot-instances-request\n

\n

To tag a resource after it has been created, see CreateTags.

" + "smithy.api#documentation": "

The type of resource to tag.

\n

The Valid Values are all the resource types that can be tagged. However,\n when creating a launch template, you can specify tags for the following resource types\n only: instance | volume | elastic-gpu |\n network-interface | spot-instances-request\n

\n

To tag a resource after it has been created, see CreateTags.

" } }, "Tags": { @@ -62714,7 +62752,7 @@ "target": "com.amazonaws.ec2#ListImagesInRecycleBinResult" }, "traits": { - "smithy.api#documentation": "

Lists one or more AMIs that are currently in the Recycle Bin. For more information, \n see Recycle\n Bin in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

Lists one or more AMIs that are currently in the Recycle Bin. For more information, \n see Recycle\n Bin in the Amazon EC2 User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -64344,7 +64382,7 @@ "target": "com.amazonaws.ec2#ModifyCapacityReservationFleetResult" }, "traits": { - "smithy.api#documentation": "

Modifies a Capacity Reservation Fleet.

\n\t\t

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically \n\t\t\tcreates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet \n\t\t\tto meet the new total target capacity. When you modify the end date for the Fleet, the end dates for \n\t\t\tall of the individual Capacity Reservations in the Fleet are updated accordingly.

" + "smithy.api#documentation": "

Modifies a Capacity Reservation Fleet.

\n

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically \n\t\t\tcreates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet \n\t\t\tto meet the new total target capacity. When you modify the end date for the Fleet, the end dates for \n\t\t\tall of the individual Capacity Reservations in the Fleet are updated accordingly.

" } }, "com.amazonaws.ec2#ModifyCapacityReservationFleetRequest": { @@ -64369,7 +64407,7 @@ "EndDate": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation \n\t\t\tFleet expires, its state changes to expired and all of the Capacity Reservations in the \n\t\t\tFleet expire.

\t\n\t\t

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you \n\t\t\tspecify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed \n\t\t\tto expire between 13:30:55 and 14:30:55 on 5/31/2019.

\n\t\t

You can't specify EndDate and \n\t\t\tRemoveEndDate in the same request.

" + "smithy.api#documentation": "

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation \n\t\t\tFleet expires, its state changes to expired and all of the Capacity Reservations in the \n\t\t\tFleet expire.

\n

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you \n\t\t\tspecify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed \n\t\t\tto expire between 13:30:55 and 14:30:55 on 5/31/2019.

\n

You can't specify EndDate and \n\t\t\tRemoveEndDate in the same request.

" } }, "DryRun": { @@ -64385,7 +64423,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the \n\t\t\tend date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly \n\t\t\tcancel it using the CancelCapacityReservationFleet action.

\n\t\t

You can't specify RemoveEndDate and \n\t\t\tEndDate in the same request.

" + "smithy.api#documentation": "

Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the \n\t\t\tend date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly \n\t\t\tcancel it using the CancelCapacityReservationFleet action.

\n

You can't specify RemoveEndDate and \n\t\t\tEndDate in the same request.

" } } } @@ -64427,13 +64465,13 @@ "EndDate": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n\t\t

The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

\n\t\t

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

" + "smithy.api#documentation": "

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity\n\t\t\tis released and you can no longer launch instances into it. The Capacity Reservation's state changes to\n\t\t\t\texpired when it reaches its end date and time.

\n

The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify \n\t\t\t5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

\n

You must provide an EndDate value if EndDateType is\n\t\t\t\tlimited. Omit EndDate if EndDateType is\n\t\t\t\tunlimited.

" } }, "EndDateType": { "target": "com.amazonaws.ec2#EndDateType", "traits": { - "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n\t\t " + "smithy.api#documentation": "

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end\n\t\t\ttypes:

\n " } }, "Accept": { @@ -64507,7 +64545,7 @@ "ConnectionLogOptions": { "target": "com.amazonaws.ec2#ConnectionLogOptions", "traits": { - "smithy.api#documentation": "

Information about the client connection logging options.

\n\t\t

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n\t\t " + "smithy.api#documentation": "

Information about the client connection logging options.

\n

If you enable client connection logging, data about client connections is sent to a\n\t\t\tCloudwatch Logs log stream. The following information is logged:

\n " } }, "DnsServers": { @@ -64521,7 +64559,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n\t

Valid Values: 443 | 1194\n

\n\t

Default Value: 443\n

" + "smithy.api#documentation": "

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

\n

Valid Values: 443 | 1194\n

\n

Default Value: 443\n

" } }, "Description": { @@ -64535,7 +64573,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the VPN is split-tunnel.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n \tClient VPN Administrator Guide.

" + "smithy.api#documentation": "

Indicates whether the VPN is split-tunnel.

\n

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the \n \tClient VPN Administrator Guide.

" } }, "DryRun": { @@ -64576,7 +64614,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n\t\t

Valid values: 8 | 10 | 12 | 24\n

\n\t\t

Default value: 24\n

" + "smithy.api#documentation": "

The maximum VPN session duration time in hours.

\n

Valid values: 8 | 10 | 12 | 24\n

\n

Default value: 24\n

" } }, "ClientLoginBannerOptions": { @@ -64611,7 +64649,7 @@ "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecificationResult" }, "traits": { - "smithy.api#documentation": "

Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per Amazon Web Services Region, and\n is specified per instance family. All new burstable performance instances in the account\n launch using the default credit option.

\n

\n ModifyDefaultCreditSpecification is an asynchronous operation, which\n works at an Amazon Web Services Region level and modifies the credit option for each\n Availability Zone. All zones in a Region are updated within five minutes. But if\n instances are launched during this operation, they might not get the new credit option\n until the zone is updated. To verify whether the update has occurred, you can call\n GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per Amazon Web Services Region, and\n is specified per instance family. All new burstable performance instances in the account\n launch using the default credit option.

\n

\n ModifyDefaultCreditSpecification is an asynchronous operation, which\n works at an Amazon Web Services Region level and modifies the credit option for each\n Availability Zone. All zones in a Region are updated within five minutes. But if\n instances are launched during this operation, they might not get the new credit option\n until the zone is updated. To verify whether the update has occurred, you can call\n GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest": { @@ -64637,7 +64675,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The credit option for CPU usage of the instance family.

\n

Valid Values: standard | unlimited\n

", + "smithy.api#documentation": "

The credit option for CPU usage of the instance family.

\n

Valid Values: standard | unlimited\n

", "smithy.api#required": {} } } @@ -64665,7 +64703,7 @@ "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdResult" }, "traits": { - "smithy.api#documentation": "

Changes the default KMS key for EBS encryption by default for your account in this Region.

\n \t

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

\n

If you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.

\n

For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Changes the default KMS key for EBS encryption by default for your account in this Region.

\n

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

\n

If you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.

\n

For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest": { @@ -64675,7 +64713,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

\n

Amazon EBS does not support asymmetric KMS keys.

", + "smithy.api#documentation": "

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.\n If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is\n specified, the encrypted state must be true.

\n

You can specify the KMS key using any of the following:

\n \n

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, \n the action can appear to complete, but eventually fails.

\n

Amazon EBS does not support asymmetric KMS keys.

", "smithy.api#required": {} } }, @@ -64881,7 +64919,7 @@ "target": "com.amazonaws.ec2#ModifyHostsResult" }, "traits": { - "smithy.api#documentation": "

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled,\n any instances that you launch with a tenancy of host but without a specific\n host ID are placed onto any available Dedicated Host in your account that has\n auto-placement enabled. When auto-placement is disabled, you need to provide a host ID\n to have the instance launch onto a specific host. If no host ID is provided, the\n instance is launched onto a suitable host with auto-placement enabled.

\n

You can also use this API action to modify a Dedicated Host to support either multiple\n instance types in an instance family, or to support a specific instance type\n only.

" + "smithy.api#documentation": "

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled,\n any instances that you launch with a tenancy of host but without a specific\n host ID are placed onto any available Dedicated Host in your account that has\n auto-placement enabled. When auto-placement is disabled, you need to provide a host ID\n to have the instance launch onto a specific host. If no host ID is provided, the\n instance is launched onto a suitable host with auto-placement enabled.

\n

You can also use this API action to modify a Dedicated Host to support either multiple\n instance types in an instance family, or to support a specific instance type\n only.

" } }, "com.amazonaws.ec2#ModifyHostsRequest": { @@ -64914,13 +64952,13 @@ "InstanceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support only a specific instance type.

\n\n

If you want to modify a Dedicated Host to support multiple instance types in its\n current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

" + "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support only a specific instance type.

\n

If you want to modify a Dedicated Host to support multiple instance types in its\n current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

" } }, "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support multiple instance types within its\n current instance family.

\n\n

If you want to modify a Dedicated Host to support a specific instance type only, omit\n this parameter and specify InstanceType instead. You\n cannot specify InstanceFamily and InstanceType in the same request.

" + "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Host. Specify this\n parameter to modify a Dedicated Host to support multiple instance types within its\n current instance family.

\n

If you want to modify a Dedicated Host to support a specific instance type only, omit\n this parameter and specify InstanceType instead. You\n cannot specify InstanceFamily and InstanceType in the same request.

" } } } @@ -64989,7 +65027,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.

\n

This request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.

\n

This setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.

" + "smithy.api#documentation": "

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.

\n

This request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.

\n

This setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.

" } }, "com.amazonaws.ec2#ModifyIdentityIdFormatRequest": { @@ -65037,7 +65075,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.\n You can use the Attribute parameter to specify the attribute or one of the following parameters: \n Description or LaunchPermission.

\n \t

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.

" + "smithy.api#documentation": "

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.\n You can use the Attribute parameter to specify the attribute or one of the following parameters: \n Description or LaunchPermission.

\n

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.

" } }, "com.amazonaws.ec2#ModifyImageAttributeRequest": { @@ -65140,7 +65178,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.

\n

\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance in a VPC can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.

\n

To modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.

\n

\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance in a VPC can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.

\n

To modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ModifyInstanceAttributeRequest": { @@ -65156,7 +65194,7 @@ "target": "com.amazonaws.ec2#InstanceAttributeName", "traits": { "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#documentation": "

The name of the attribute to modify.

\n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

\n ", + "smithy.api#documentation": "

The name of the attribute to modify.

\n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

\n ", "smithy.api#xmlName": "attribute" } }, @@ -65164,7 +65202,7 @@ "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", "traits": { "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.

", "smithy.api#xmlName": "blockDeviceMapping" } }, @@ -65198,7 +65236,7 @@ "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the\n instance.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the\n instance.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", "smithy.api#xmlName": "enaSupport" } }, @@ -65255,7 +65293,7 @@ "target": "com.amazonaws.ec2#AttributeValue", "traits": { "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", "smithy.api#xmlName": "sriovNetSupport" } }, @@ -65278,7 +65316,7 @@ "DisableApiStop": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n Protection.

\n

" + "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n Protection.

\n

" } } } @@ -65348,7 +65386,7 @@ "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecificationResult" }, "traits": { - "smithy.api#documentation": "

Modifies the credit option for CPU usage on a running or stopped burstable performance\n instance. The credit options are standard and\n unlimited.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Modifies the credit option for CPU usage on a running or stopped burstable performance\n instance. The credit options are standard and\n unlimited.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ModifyInstanceCreditSpecificationRequest": { @@ -65613,7 +65651,7 @@ "HttpTokens": { "target": "com.amazonaws.ec2#HttpTokensState", "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.

\n

If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.

" + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a session token on your request. If you retrieve the IAM\n role credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid session token, the\n version 2.0 role credentials are returned.

\n

If the state is required, you must send a session token with any instance\n metadata retrieval requests. In this state, retrieving the IAM role\n credentials always returns the version 2.0 credentials; the version 1.0 credentials are\n not available.

" } }, "HttpPutResponseHopLimit": { @@ -65621,13 +65659,13 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel. If no parameter is specified,\n the existing state is maintained.

\n

Possible values: Integers from 1 to 64

" + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel. If no parameter is specified,\n the existing state is maintained.

\n

Possible values: Integers from 1 to 64

" } }, "HttpEndpoint": { "target": "com.amazonaws.ec2#InstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is\n not specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is\n not specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" } }, "DryRun": { @@ -65647,7 +65685,7 @@ "InstanceMetadataTags": { "target": "com.amazonaws.ec2#InstanceMetadataTagsState", "traits": { - "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" + "smithy.api#documentation": "

Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.

\n

Default: disabled\n

" } } } @@ -65682,7 +65720,7 @@ "target": "com.amazonaws.ec2#ModifyInstancePlacementResult" }, "traits": { - "smithy.api#documentation": "

Modifies the placement attributes for a specified instance. You can do the\n following:

\n \n

At least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.

\n

To modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.

" + "smithy.api#documentation": "

Modifies the placement attributes for a specified instance. You can do the\n following:

\n \n

At least one attribute for affinity, host ID, tenancy, or placement group name must be\n specified in the request. Affinity and tenancy can be modified in the same\n request.

\n

To modify the host ID, tenancy, placement group, or partition for an instance, the\n instance must be in the stopped state.

" } }, "com.amazonaws.ec2#ModifyInstancePlacementRequest": { @@ -65699,7 +65737,7 @@ "GroupName": { "target": "com.amazonaws.ec2#PlacementGroupName", "traits": { - "smithy.api#documentation": "

The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.

\n

To remove an instance from a placement group, specify an empty string (\"\").

" + "smithy.api#documentation": "

The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.

\n

To remove an instance from a placement group, specify an empty string (\"\").

" } }, "HostId": { @@ -65724,7 +65762,7 @@ "target": "com.amazonaws.ec2#HostTenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy for the instance.

\n\n \n

For T3 instances, you can't change the tenancy from dedicated to\n host, or from host to dedicated.\n Attempting to make one of these unsupported tenancy changes results in the\n InvalidTenancy error code.

\n ", + "smithy.api#documentation": "

The tenancy for the instance.

\n \n

For T3 instances, you can't change the tenancy from dedicated to\n host, or from host to dedicated.\n Attempting to make one of these unsupported tenancy changes results in the\n InvalidTenancy error code.

\n ", "smithy.api#xmlName": "tenancy" } }, @@ -66100,19 +66138,19 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.

\n

Constraint: Maximum 128 ASCII characters.

" } }, "LaunchTemplateId": { "target": "com.amazonaws.ec2#LaunchTemplateId", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the LaunchTemplateId or the\n LaunchTemplateName, but not both.

" } }, "LaunchTemplateName": { "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the LaunchTemplateName or the\n LaunchTemplateId, but not both.

" } }, "DefaultVersion": { @@ -66212,7 +66250,7 @@ "target": "com.amazonaws.ec2#ModifyManagedPrefixListResult" }, "traits": { - "smithy.api#documentation": "

Modifies the specified managed prefix list.

\n

Adding or removing entries in a prefix list creates a new version of the prefix list.\n Changing the name of the prefix list does not affect the version.

\n

If you specify a current version number that does not match the true current version\n number, the request fails.

" + "smithy.api#documentation": "

Modifies the specified managed prefix list.

\n

Adding or removing entries in a prefix list creates a new version of the prefix list.\n Changing the name of the prefix list does not affect the version.

\n

If you specify a current version number that does not match the true current version\n number, the request fails.

" } }, "com.amazonaws.ec2#ModifyManagedPrefixListRequest": { @@ -66267,7 +66305,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of entries for the prefix list. You cannot modify the entries \n of a prefix list and modify the size of a prefix list at the same time.

\n

If any of the resources that reference the prefix list cannot support the new\n maximum size, the modify operation fails. Check the state message for the IDs of \n the first ten resources that do not support the new maximum size.

" + "smithy.api#documentation": "

The maximum number of entries for the prefix list. You cannot modify the entries \n of a prefix list and modify the size of a prefix list at the same time.

\n

If any of the resources that reference the prefix list cannot support the new\n maximum size, the modify operation fails. Check the state message for the IDs of \n the first ten resources that do not support the new maximum size.

" } } } @@ -66439,7 +66477,7 @@ "target": "com.amazonaws.ec2#ModifyReservedInstancesResult" }, "traits": { - "smithy.api#documentation": "

Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.

\n\t\t

For more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Modifies the configuration of your Reserved Instances, such as the Availability Zone, \n instance count, or instance type. The Reserved Instances to be modified must be identical, \n except for Availability Zone, network platform, and instance type.

\n

For more information, see Modifying Reserved\n\t\t\t\tInstances in the Amazon EC2 User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#ModifyReservedInstancesRequest": { @@ -66685,7 +66723,7 @@ "target": "com.amazonaws.ec2#ModifySpotFleetRequestResponse" }, "traits": { - "smithy.api#documentation": "

Modifies the specified Spot Fleet request.

\n

You can only modify a Spot Fleet request of type maintain.

\n

While the Spot Fleet request is being modified, it is in the modifying\n state.

\n

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.

\n

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.

\n

If you are finished with your Spot Fleet for now, but will use it again later, you can\n set the target capacity to 0.

" + "smithy.api#documentation": "

Modifies the specified Spot Fleet request.

\n

You can only modify a Spot Fleet request of type maintain.

\n

While the Spot Fleet request is being modified, it is in the modifying\n state.

\n

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.

\n

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.

\n

If you are finished with your Spot Fleet for now, but will use it again later, you can\n set the target capacity to 0.

" } }, "com.amazonaws.ec2#ModifySpotFleetRequestRequest": { @@ -66772,7 +66810,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

\n\t \n\t

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n\t \n\t

For more information about Amazon Web Services Outposts, see the following:

\n\t \n\t " + "smithy.api#documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

\n

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n

For more information about Amazon Web Services Outposts, see the following:

\n " } }, "com.amazonaws.ec2#ModifySubnetAttributeRequest": { @@ -66781,7 +66819,7 @@ "AssignIpv6AddressOnCreation": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "

Specify true to indicate that network interfaces created in the\n specified subnet should be assigned an IPv6 address. This includes a network interface\n that's created when launching an instance into the subnet (the instance therefore\n receives an IPv6 address).

\n

If you enable the IPv6 addressing feature for your subnet, your network interface\n or instance only receives an IPv6 address if it's created using version\n 2016-11-15 or later of the Amazon EC2 API.

" + "smithy.api#documentation": "

Specify true to indicate that network interfaces created in the\n specified subnet should be assigned an IPv6 address. This includes a network interface\n that's created when launching an instance into the subnet (the instance therefore\n receives an IPv6 address).

\n

If you enable the IPv6 addressing feature for your subnet, your network interface\n or instance only receives an IPv6 address if it's created using version\n 2016-11-15 or later of the Amazon EC2 API.

" } }, "MapPublicIpOnLaunch": { @@ -66803,13 +66841,13 @@ "MapCustomerOwnedIpOnLaunch": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.

\n

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

" + "smithy.api#documentation": "

Specify true to indicate that network interfaces attached to instances created in the\n specified subnet should be assigned a customer-owned IPv4 address.

\n

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

" } }, "CustomerOwnedIpv4Pool": { "target": "com.amazonaws.ec2#CoipPoolId", "traits": { - "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

\n

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

" + "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

\n

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

" } }, "EnableDns64": { @@ -67192,7 +67230,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

\n

The modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.

" + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

\n

The modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.

" } } }, @@ -68060,7 +68098,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 1,000.

\n

Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.

\n \t

Valid Range: Minimum value of 125. Maximum value of 1000.

" + "smithy.api#documentation": "

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. \n The maximum value is 1,000.

\n

Default: The existing value is retained if the source and target volume type is gp3.\n Otherwise, the default value is 125.

\n

Valid Range: Minimum value of 125. Maximum value of 1000.

" } }, "MultiAttachEnabled": { @@ -68327,7 +68365,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.

\n\t

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.

" + "smithy.api#documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.

\n

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { @@ -68495,7 +68533,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult" }, "traits": { - "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers \n\t (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.

\n\t

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" + "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers \n\t (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.

\n

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { @@ -68629,7 +68667,7 @@ "target": "com.amazonaws.ec2#ModifyVpcTenancyResult" }, "traits": { - "smithy.api#documentation": "

Modifies the instance tenancy attribute of the specified VPC. You can change the\n instance tenancy attribute of a VPC to default only. You cannot change the\n instance tenancy attribute to dedicated.

\n

After you modify the tenancy of the VPC, any new instances that you launch into the\n VPC have a tenancy of default, unless you specify otherwise during launch.\n The tenancy of any existing instances in the VPC is not affected.

\n

For more information, see Dedicated Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Modifies the instance tenancy attribute of the specified VPC. You can change the\n instance tenancy attribute of a VPC to default only. You cannot change the\n instance tenancy attribute to dedicated.

\n

After you modify the tenancy of the VPC, any new instances that you launch into the\n VPC have a tenancy of default, unless you specify otherwise during launch.\n The tenancy of any existing instances in the VPC is not affected.

\n

For more information, see Dedicated Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#ModifyVpcTenancyRequest": { @@ -68685,7 +68723,7 @@ "target": "com.amazonaws.ec2#ModifyVpnConnectionResult" }, "traits": { - "smithy.api#documentation": "

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To\n modify the target gateway, the following migration options are available:

\n \n

Before you perform the migration to the new gateway, you must configure the new\n gateway. Use CreateVpnGateway to create a virtual private gateway, or\n CreateTransitGateway to create a transit gateway.

\n

This step is required when you migrate from a virtual private gateway with static\n routes to a transit gateway.

\n

You must delete the static routes before you migrate to the new gateway.

\n\n

Keep a copy of the static route before you delete it. You will need to add back these\n routes to the transit gateway after the VPN connection migration is complete.

\n\n

After you migrate to the new gateway, you might need to modify your VPC route table.\n Use CreateRoute and DeleteRoute to make the changes\n described in Update VPC route\n tables in the Amazon Web Services Site-to-Site VPN User Guide.

\n

When the new gateway is a transit gateway, modify the transit gateway route table to\n allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection.\n Use CreateTransitGatewayRoute to add the routes.

\n

If you deleted VPN static routes, you must add the static routes to the transit\n gateway route table.

\n

After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will\n be temporarily unavailable for a brief period while we provision the new\n endpoints.

" + "smithy.api#documentation": "

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To\n modify the target gateway, the following migration options are available:

\n \n

Before you perform the migration to the new gateway, you must configure the new\n gateway. Use CreateVpnGateway to create a virtual private gateway, or\n CreateTransitGateway to create a transit gateway.

\n

This step is required when you migrate from a virtual private gateway with static\n routes to a transit gateway.

\n

You must delete the static routes before you migrate to the new gateway.

\n

Keep a copy of the static route before you delete it. You will need to add back these\n routes to the transit gateway after the VPN connection migration is complete.

\n

After you migrate to the new gateway, you might need to modify your VPC route table.\n Use CreateRoute and DeleteRoute to make the changes\n described in Update VPC route\n tables in the Amazon Web Services Site-to-Site VPN User Guide.

\n

When the new gateway is a transit gateway, modify the transit gateway route table to\n allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection.\n Use CreateTransitGatewayRoute to add the routes.

\n

If you deleted VPN static routes, you must add the static routes to the transit\n gateway route table.

\n

After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will\n be temporarily unavailable for a brief period while we provision the new\n endpoints.

" } }, "com.amazonaws.ec2#ModifyVpnConnectionOptions": { @@ -68697,7 +68735,7 @@ "target": "com.amazonaws.ec2#ModifyVpnConnectionOptionsResult" }, "traits": { - "smithy.api#documentation": "

Modifies the connection options for your Site-to-Site VPN connection.

\n

When you modify the VPN connection options, the VPN endpoint IP addresses on the\n Amazon Web Services side do not change, and the tunnel options do not change. Your\n VPN connection will be temporarily unavailable for a brief period while the VPN\n connection is updated.

" + "smithy.api#documentation": "

Modifies the connection options for your Site-to-Site VPN connection.

\n

When you modify the VPN connection options, the VPN endpoint IP addresses on the\n Amazon Web Services side do not change, and the tunnel options do not change. Your\n VPN connection will be temporarily unavailable for a brief period while the VPN\n connection is updated.

" } }, "com.amazonaws.ec2#ModifyVpnConnectionOptionsRequest": { @@ -68714,25 +68752,25 @@ "LocalIpv4NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" } }, "RemoteIpv4NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" } }, "LocalIpv6NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" } }, "RemoteIpv6NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" + "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" } }, "DryRun": { @@ -68932,19 +68970,19 @@ "TunnelInsideCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " } }, "TunnelInsideIpv6Cidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" } }, "PreSharedKey": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" } }, "Phase1LifetimeSeconds": { @@ -68952,7 +68990,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" } }, "Phase2LifetimeSeconds": { @@ -68960,7 +68998,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" } }, "RekeyMarginTimeSeconds": { @@ -68968,7 +69006,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" } }, "RekeyFuzzPercentage": { @@ -68976,7 +69014,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" + "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" } }, "ReplayWindowSize": { @@ -68984,7 +69022,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" + "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" } }, "DPDTimeoutSeconds": { @@ -68992,68 +69030,68 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" } }, "DPDTimeoutAction": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" + "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" } }, "Phase1EncryptionAlgorithms": { "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", "smithy.api#xmlName": "Phase1EncryptionAlgorithm" } }, "Phase2EncryptionAlgorithms": { "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", "smithy.api#xmlName": "Phase2EncryptionAlgorithm" } }, "Phase1IntegrityAlgorithms": { "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", "smithy.api#xmlName": "Phase1IntegrityAlgorithm" } }, "Phase2IntegrityAlgorithms": { "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", "smithy.api#xmlName": "Phase2IntegrityAlgorithm" } }, "Phase1DHGroupNumbers": { "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", "smithy.api#xmlName": "Phase1DHGroupNumber" } }, "Phase2DHGroupNumbers": { "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", "smithy.api#xmlName": "Phase2DHGroupNumber" } }, "IKEVersions": { "target": "com.amazonaws.ec2#IKEVersionsRequestList", "traits": { - "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", "smithy.api#xmlName": "IKEVersion" } }, "StartupAction": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" + "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" } }, "LogOptions": { @@ -69076,7 +69114,7 @@ "target": "com.amazonaws.ec2#MonitorInstancesResult" }, "traits": { - "smithy.api#documentation": "

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitor your instances using\n CloudWatch in the Amazon EC2 User Guide.

\n

To disable detailed monitoring, see UnmonitorInstances.

" + "smithy.api#documentation": "

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is\n enabled. For more information, see Monitor your instances using\n CloudWatch in the Amazon EC2 User Guide.

\n

To disable detailed monitoring, see UnmonitorInstances.

" } }, "com.amazonaws.ec2#MonitorInstancesRequest": { @@ -70782,7 +70820,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "CarrierIp", - "smithy.api#documentation": "

The carrier IP address associated with the network interface.

\n

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

", + "smithy.api#documentation": "

The carrier IP address associated with the network interface.

\n

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

", "smithy.api#xmlName": "carrierIp" } } @@ -72640,7 +72678,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the instance.

\n

If not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#documentation": "

The Availability Zone of the instance.

\n

If not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.

\n

This parameter is not supported for CreateFleet.

", "smithy.api#xmlName": "availabilityZone" } }, @@ -72648,7 +72686,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Affinity", - "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", + "smithy.api#documentation": "

The affinity setting for the instance on the Dedicated Host.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", "smithy.api#xmlName": "affinity" } }, @@ -72666,7 +72704,7 @@ "aws.protocols#ec2QueryName": "PartitionNumber", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of the partition that the instance is in. Valid only if the placement group\n strategy is set to partition.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#documentation": "

The number of the partition that the instance is in. Valid only if the placement group\n strategy is set to partition.

\n

This parameter is not supported for CreateFleet.

", "smithy.api#xmlName": "partitionNumber" } }, @@ -72674,7 +72712,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The ID of the Dedicated Host on which the instance resides.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", + "smithy.api#documentation": "

The ID of the Dedicated Host on which the instance resides.

\n

This parameter is not supported for CreateFleet or ImportInstance.

", "smithy.api#xmlName": "hostId" } }, @@ -72682,7 +72720,7 @@ "target": "com.amazonaws.ec2#Tenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware.

\n

This parameter is not supported for CreateFleet. The\n host tenancy is not supported for ImportInstance or\n for T3 instances that are configured for the unlimited CPU credit\n option.

", + "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware.

\n

This parameter is not supported for CreateFleet. The\n host tenancy is not supported for ImportInstance or\n for T3 instances that are configured for the unlimited CPU credit\n option.

", "smithy.api#xmlName": "tenancy" } }, @@ -72698,7 +72736,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "HostResourceGroupArn", - "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

\n

If you specify this parameter, either omit the Tenancy parameter or set it to host.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#documentation": "

The ARN of the host resource group in which to launch the instances.

\n

If you specify this parameter, either omit the Tenancy parameter or set it to host.

\n

This parameter is not supported for CreateFleet.

", "smithy.api#xmlName": "hostResourceGroupArn" } }, @@ -73525,7 +73563,7 @@ "target": "com.amazonaws.ec2#DnsNameState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

>Consumers\n of the endpoint service can use the private name only when the state is\n verified.

", + "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

>Consumers\n of the endpoint service can use the private name only when the state is\n verified.

", "smithy.api#xmlName": "state" } }, @@ -73901,7 +73939,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.

\n

Default: true

" + "smithy.api#documentation": "

(IPv6 only) Indicate whether the address range will be publicly advertised to the\n internet.

\n

Default: true

" } }, "Description": { @@ -74533,7 +74571,7 @@ "target": "com.amazonaws.ec2#PurchaseReservedInstancesOfferingResult" }, "traits": { - "smithy.api#documentation": "

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.

\n\t\t

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.

\n

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.

\n \t

For more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower \n hourly rate compared to On-Demand instance pricing.

\n

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings \n\t\t\tthat match your specifications. After you've purchased a Reserved Instance, you can check for your\n\t\t\tnew Reserved Instance with DescribeReservedInstances.

\n

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a\n purchase time, the default is the current time.

\n

For more information, see Reserved Instances and \n \t Reserved Instance Marketplace \n \t in the Amazon EC2 User Guide.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#PurchaseReservedInstancesOfferingRequest": { @@ -74719,7 +74757,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#RebootInstancesRequest": { @@ -74911,7 +74949,7 @@ "target": "com.amazonaws.ec2#RegisterImageResult" }, "traits": { - "smithy.api#documentation": "

Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.

\n \n \t

For Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.

\n \n\n

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. \n If you make changes to an image, deregister the previous image and register the new image.

\n\n

\n Register a snapshot of a root device volume\n

\n \t

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.

\n

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.

\n \n \t

\n Amazon Web Services Marketplace product codes\n

\n \t

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.

\n

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:

\n
    \n
  1. \n

    Launch an instance from an existing AMI with that billing product code.

    \n
    2. \n
  2. \n

    Customize the instance.

    \n
    3. \n
  3. \n

    Create an AMI from the instance using CreateImage.

    \n
    4. \n
\n

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.

\n \n

For Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.

\n \n

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. \n If you make changes to an image, deregister the previous image and register the new image.

\n

\n Register a snapshot of a root device volume\n

\n

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.

\n

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.

\n

\n Amazon Web Services Marketplace product codes\n

\n

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.

\n

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:

\n
    \n
  1. \n

    Launch an instance from an existing AMI with that billing product code.

    \n
    2. \n
  2. \n

    Customize the instance.

    \n
    3. \n
  3. \n

    Create an AMI from the instance using CreateImage.

    \n
    4. \n
\n

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#RegisterImageRequest": { @@ -74927,14 +74965,14 @@ "target": "com.amazonaws.ec2#ArchitectureValues", "traits": { "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the AMI.

\n \t

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

", + "smithy.api#documentation": "

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

", "smithy.api#xmlName": "architecture" } }, "BlockDeviceMappings": { "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", "traits": { - "smithy.api#documentation": "

The block device mapping entries.

\n \t

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

\n

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region \n \t of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost \n \t only. For more information, \n \t \tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#documentation": "

The block device mapping entries.

\n

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

\n

If you create an AMI on an Outpost, then all backing snapshots must be on the same\n Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can\n be used to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "BlockDeviceMapping" } }, @@ -74987,7 +75025,7 @@ "BillingProducts": { "target": "com.amazonaws.ec2#BillingProductList", "traits": { - "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise,\n \tyou can use the Amazon Web Services Marketplace to bill for the use of an AMI.

", + "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product codes.

\n

If your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based\n products in the Amazon Web Services Marketplace Seller Guide.

", "smithy.api#xmlName": "BillingProduct" } }, @@ -75026,25 +75064,25 @@ "BootMode": { "target": "com.amazonaws.ec2#BootModeValues", "traits": { - "smithy.api#documentation": "

The boot mode of the AMI. For more information, see Boot modes in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The boot mode of the AMI. For more information, see Boot modes in the\n Amazon EC2 User Guide.

" } }, "TpmSupport": { "target": "com.amazonaws.ec2#TpmSupportValues", "traits": { - "smithy.api#documentation": "

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon EC2 User Guide.

" } }, "UefiData": { "target": "com.amazonaws.ec2#StringType", "traits": { - "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" } }, "ImdsSupport": { "target": "com.amazonaws.ec2#ImdsSupportValues", "traits": { - "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon Elastic Compute Cloud User Guide.

\n \n

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

\n " + "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.

\n \n

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

\n " } } }, @@ -75144,7 +75182,7 @@ "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersResult" }, "traits": { - "smithy.api#documentation": "

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For information about\n supported instances, see Multicast\n Consideration in Amazon VPC Transit Gateways.

\n

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.

" + "smithy.api#documentation": "

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated\n with a supported EC2 instance that receives multicast traffic. For information about\n supported instances, see Multicast\n Consideration in Amazon VPC Transit Gateways.

\n

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added\n to the transit gateway multicast group.

" } }, "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupMembersRequest": { @@ -75200,7 +75238,7 @@ "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesResult" }, "traits": { - "smithy.api#documentation": "

Registers sources (network interfaces) with the specified transit gateway multicast group.

\n

A multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For information about supported instances, see Multicast\n Considerations in Amazon VPC Transit Gateways.

\n

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.

" + "smithy.api#documentation": "

Registers sources (network interfaces) with the specified transit gateway multicast group.

\n

A multicast source is a network interface attached to a supported instance that sends\n multicast traffic. For information about supported instances, see Multicast\n Considerations in Amazon VPC Transit Gateways.

\n

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast\n group.

" } }, "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSourcesRequest": { @@ -75556,7 +75594,7 @@ "target": "com.amazonaws.ec2#ReleaseHostsResult" }, "traits": { - "smithy.api#documentation": "

When you no longer want to use an On-Demand Dedicated Host it can be released.\n On-Demand billing is stopped and the host goes into released state. The\n host ID of Dedicated Hosts that have been released can no longer be specified in another\n request, for example, to modify the host. You must stop or terminate all instances on a\n host before it can be released.

\n

When Dedicated Hosts are released, it may take some time for them to stop counting\n toward your limit and you may receive capacity errors when trying to allocate new\n Dedicated Hosts. Wait a few minutes and then try again.

\n

Released hosts still appear in a DescribeHosts response.

" + "smithy.api#documentation": "

When you no longer want to use an On-Demand Dedicated Host it can be released.\n On-Demand billing is stopped and the host goes into released state. The\n host ID of Dedicated Hosts that have been released can no longer be specified in another\n request, for example, to modify the host. You must stop or terminate all instances on a\n host before it can be released.

\n

When Dedicated Hosts are released, it may take some time for them to stop counting\n toward your limit and you may receive capacity errors when trying to allocate new\n Dedicated Hosts. Wait a few minutes and then try again.

\n

Released hosts still appear in a DescribeHosts response.

" } }, "com.amazonaws.ec2#ReleaseHostsRequest": { @@ -75722,7 +75760,7 @@ "target": "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationResult" }, "traits": { - "smithy.api#documentation": "

Replaces an IAM instance profile for the specified running instance. You can use\n this action to change the IAM instance profile that's associated with an instance\n without having to disassociate the existing IAM instance profile first.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" + "smithy.api#documentation": "

Replaces an IAM instance profile for the specified running instance. You can use\n this action to change the IAM instance profile that's associated with an instance\n without having to disassociate the existing IAM instance profile first.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" } }, "com.amazonaws.ec2#ReplaceIamInstanceProfileAssociationRequest": { @@ -75768,7 +75806,7 @@ "target": "com.amazonaws.ec2#ReplaceNetworkAclAssociationResult" }, "traits": { - "smithy.api#documentation": "

Changes which network ACL a subnet is associated with. By default when you create a\n\t\t\tsubnet, it's automatically associated with the default network ACL. For more\n\t\t\tinformation, see Network\n\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.

\n

This is an idempotent operation.

" + "smithy.api#documentation": "

Changes which network ACL a subnet is associated with. By default when you create a\n\t\t\tsubnet, it's automatically associated with the default network ACL. For more\n\t\t\tinformation, see Network\n\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.

\n

This is an idempotent operation.

" } }, "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest": { @@ -75858,7 +75896,7 @@ "aws.protocols#ec2QueryName": "Egress", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n\t\t

Default: If no value is specified, we replace the ingress rule.

", + "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n

Default: If no value is specified, we replace the ingress rule.

", "smithy.api#required": {}, "smithy.api#xmlName": "egress" } @@ -76439,7 +76477,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.

\n

Use of this action does not change the value returned by DescribeInstanceStatus.

" + "smithy.api#documentation": "

Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.

\n

Use of this action does not change the value returned by DescribeInstanceStatus.

" } }, "com.amazonaws.ec2#ReportInstanceStatusRequest": { @@ -76486,7 +76524,7 @@ "traits": { "aws.protocols#ec2QueryName": "ReasonCode", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The reason codes that describe the health state of your instance.

\n ", + "smithy.api#documentation": "

The reason codes that describe the health state of your instance.

\n ", "smithy.api#required": {}, "smithy.api#xmlName": "reasonCode" } @@ -76593,7 +76631,7 @@ "KernelId": { "target": "com.amazonaws.ec2#KernelId", "traits": { - "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "EbsOptimized": { @@ -76633,13 +76671,13 @@ "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you specify InstanceType, you can't specify\n InstanceRequirements.

" + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.

\n

If you specify InstanceType, you can't specify\n InstanceRequirements.

" } }, "KeyName": { "target": "com.amazonaws.ec2#KeyPairName", "traits": { - "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " } }, "Monitoring": { @@ -76657,7 +76695,7 @@ "RamDiskId": { "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "smithy.api#documentation": "

The ID of the RAM disk.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

The ID of the RAM disk.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "DisableApiTermination": { @@ -76671,19 +76709,19 @@ "InstanceInitiatedShutdownBehavior": { "target": "com.amazonaws.ec2#ShutdownBehavior", "traits": { - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

" + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

" } }, "UserData": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Linux instance at\n launch (Linux) or Work with instance\n user data (Windows) in the Amazon Elastic Compute Cloud User Guide.

\n\n

If you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

" + "smithy.api#documentation": "

The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Linux instance at\n launch (Linux) or Work with instance\n user data (Windows) in the Amazon Elastic Compute Cloud User Guide.

\n

If you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

" } }, "TagSpecifications": { "target": "com.amazonaws.ec2#LaunchTemplateTagSpecificationRequestList", "traits": { - "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

\n \n

To tag the launch template itself, you must use the TagSpecification parameter.

\n ", + "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

\n \n

To tag the launch template itself, you must use the TagSpecification parameter.

\n ", "smithy.api#xmlName": "TagSpecification" } }, @@ -76761,7 +76799,7 @@ "EnclaveOptions": { "target": "com.amazonaws.ec2#LaunchTemplateEnclaveOptionsRequest", "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

" + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

" } }, "InstanceRequirements": { @@ -76792,7 +76830,7 @@ } }, "traits": { - "smithy.api#documentation": "

The information to include in the launch template.

\n \n

You must specify at least one parameter for the launch template data.

\n ", + "smithy.api#documentation": "

The information to include in the launch template.

\n \n

You must specify at least one parameter for the launch template data.

\n ", "smithy.api#sensitive": {} } }, @@ -76805,7 +76843,7 @@ "target": "com.amazonaws.ec2#RequestSpotFleetResponse" }, "traits": { - "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide.

\n \n \n

We strongly discourage using the RequestSpotFleet API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.

\n " + "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide.

\n \n

We strongly discourage using the RequestSpotFleet API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide.

\n " } }, "com.amazonaws.ec2#RequestSpotFleetRequest": { @@ -76861,7 +76899,7 @@ "target": "com.amazonaws.ec2#RequestSpotInstancesResult" }, "traits": { - "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

\n \n \n

We strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.

\n \n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.

\n " + "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

\n \n

We strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide for Linux Instances.

\n " } }, "com.amazonaws.ec2#RequestSpotInstancesRequest": { @@ -76871,7 +76909,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", - "smithy.api#documentation": "

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.

\n

If there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

", + "smithy.api#documentation": "

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.

\n

If there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

", "smithy.api#xmlName": "availabilityZoneGroup" } }, @@ -76909,7 +76947,7 @@ "aws.protocols#ec2QueryName": "InstanceCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of Spot Instances to launch.

\n

Default: 1

", + "smithy.api#documentation": "

The maximum number of Spot Instances to launch.

\n

Default: 1

", "smithy.api#xmlName": "instanceCount" } }, @@ -76917,7 +76955,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "LaunchGroup", - "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.

\n

Default: Instances are launched and terminated individually

", + "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.

\n

Default: Instances are launched and terminated individually

", "smithy.api#xmlName": "launchGroup" } }, @@ -76931,7 +76969,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", "smithy.api#xmlName": "spotPrice" } }, @@ -76939,7 +76977,7 @@ "target": "com.amazonaws.ec2#SpotInstanceType", "traits": { "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The Spot Instance request type.

\n

Default: one-time\n

", + "smithy.api#documentation": "

The Spot Instance request type.

\n

Default: one-time\n

", "smithy.api#xmlName": "type" } }, @@ -76947,7 +76985,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date of the request. If this is a one-time request, the request becomes\n active at this date and time and remains active until all instances launch, the request\n expires, or the request is canceled. If the request is persistent, the request becomes\n active at this date and time and remains active until it expires or is canceled.

\n

The specified start date and time cannot be equal to the current date and time. You\n must specify a start date and time that occurs after the current date and time.

", + "smithy.api#documentation": "

The start date of the request. If this is a one-time request, the request becomes\n active at this date and time and remains active until all instances launch, the request\n expires, or the request is canceled. If the request is persistent, the request becomes\n active at this date and time and remains active until it expires or is canceled.

\n

The specified start date and time cannot be equal to the current date and time. You\n must specify a start date and time that occurs after the current date and time.

", "smithy.api#xmlName": "validFrom" } }, @@ -76955,7 +76993,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", "smithy.api#xmlName": "validUntil" } }, @@ -78307,7 +78345,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.

\n

The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.

" + "smithy.api#documentation": "

Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.

\n

The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.

" } }, "com.amazonaws.ec2#ResetInstanceAttributeRequest": { @@ -78318,7 +78356,7 @@ "traits": { "aws.protocols#ec2QueryName": "Attribute", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attribute to reset.

\n \n

You can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.

\n ", + "smithy.api#documentation": "

The attribute to reset.

\n \n

You can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.

\n ", "smithy.api#required": {}, "smithy.api#xmlName": "attribute" } @@ -79000,6 +79038,12 @@ "traits": { "smithy.api#enumValue": "vpn-connection-device-type" } + }, + "vpc_block_public_access_exclusion": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vpc-block-public-access-exclusion" + } } } }, @@ -79380,7 +79424,7 @@ "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinResult" }, "traits": { - "smithy.api#documentation": "

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest": { @@ -79614,7 +79658,7 @@ "target": "com.amazonaws.ec2#RestoreSnapshotTierResult" }, "traits": { - "smithy.api#documentation": "

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore \n period or restore type for a snapshot that was previously temporarily restored.

\n \n

For more information see \n Restore an archived snapshot and \n modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore \n period or restore type for a snapshot that was previously temporarily restored.

\n

For more information see \n Restore an archived snapshot and \n modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#RestoreSnapshotTierRequest": { @@ -79783,7 +79827,7 @@ "target": "com.amazonaws.ec2#RevokeSecurityGroupEgressResult" }, "traits": { - "smithy.api#documentation": "

[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC.\n This action does not apply to security groups for use in EC2-Classic.

\n\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

[Default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n\n

Rule changes are propagated to instances within the security group as quickly as possible. However, \n a small delay might occur.

" + "smithy.api#documentation": "

[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC.\n This action does not apply to security groups for use in EC2-Classic.

\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

[Default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, \n a small delay might occur.

" } }, "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest": { @@ -79910,7 +79954,7 @@ "target": "com.amazonaws.ec2#RevokeSecurityGroupIngressResult" }, "traits": { - "smithy.api#documentation": "

Removes the specified inbound (ingress) rules from a security group.

\n\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n\n

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

\n \n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Removes the specified inbound (ingress) rules from a security group.

\n

You can specify rules using either rule IDs or security group rule properties. If you use\n rule properties, the values that you specify (for example, ports) must match the existing rule's \n values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, \n security group, or prefix list). For the TCP and UDP protocols, you must also specify the \n destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type \n and code. If the security group rule has a description, you do not need to specify the description \n to revoke the rule.

\n

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is\n returned, and the output describes the security group rules that were not revoked.

\n

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

\n

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#RevokeSecurityGroupIngressRequest": { @@ -80470,7 +80514,7 @@ "target": "com.amazonaws.ec2#Reservation" }, "traits": { - "smithy.api#documentation": "

Launches the specified number of instances using an AMI for which you have\n permissions.

\n

You can specify a number of options, or leave the default options. The following rules\n apply:

\n \n

You can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.

\n

To ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.

\n

An instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.

\n

Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.

\n

For troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a\n VPC. For more information, see Migrate from EC2-Classic to a\n VPC in the Amazon EC2 User Guide.

\n " + "smithy.api#documentation": "

Launches the specified number of instances using an AMI for which you have\n permissions.

\n

You can specify a number of options, or leave the default options. The following rules\n apply:

\n \n

You can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.

\n

To ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.

\n

An instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.

\n

Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.

\n

For troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a\n VPC. For more information, see Migrate from EC2-Classic to a\n VPC in the Amazon EC2 User Guide.

\n " } }, "com.amazonaws.ec2#RunInstancesMonitoringEnabled": { @@ -80511,7 +80555,7 @@ "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.

\n

Default: m1.small\n

" + "smithy.api#documentation": "

The instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.

\n

Default: m1.small\n

" } }, "Ipv6AddressCount": { @@ -80519,26 +80563,26 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

[EC2-VPC] The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

" + "smithy.api#documentation": "

[EC2-VPC] The number of IPv6 addresses to associate with the primary network\n interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You\n cannot specify this option and the option to assign specific IPv6 addresses in the same\n request. You can specify this option if you've specified a minimum number of instances\n to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

" } }, "Ipv6Addresses": { "target": "com.amazonaws.ec2#InstanceIpv6AddressList", "traits": { - "smithy.api#documentation": "

[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#documentation": "

[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the\n primary network interface. You cannot specify this option and the option to assign a\n number of IPv6 addresses in the same request. You cannot specify this option if you've\n specified a minimum number of instances to launch.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", "smithy.api#xmlName": "Ipv6Address" } }, "KernelId": { "target": "com.amazonaws.ec2#KernelId", "traits": { - "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " + "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " } }, "KeyName": { "target": "com.amazonaws.ec2#KeyPairName", "traits": { - "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " } }, "MaxCount": { @@ -80546,7 +80590,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.

", + "smithy.api#documentation": "

The maximum number of instances to launch. If you specify more instances than Amazon\n EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible\n number of instances above MinCount.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 FAQ.

", "smithy.api#required": {} } }, @@ -80555,7 +80599,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of instances to launch. If you specify a minimum that is more\n instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2\n launches no instances.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 General FAQ.

", + "smithy.api#documentation": "

The minimum number of instances to launch. If you specify a minimum that is more\n instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2\n launches no instances.

\n

Constraints: Between 1 and the maximum number you're allowed for the specified\n instance type. For more information about the default limits, and how to request an\n increase, see How many instances can I\n run in Amazon EC2 in the Amazon EC2 General FAQ.

", "smithy.api#required": {} } }, @@ -80574,27 +80618,27 @@ "RamdiskId": { "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "smithy.api#documentation": "

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and\n search for the kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " + "smithy.api#documentation": "

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and\n search for the kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " } }, "SecurityGroupIds": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

", + "smithy.api#documentation": "

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

", "smithy.api#xmlName": "SecurityGroupId" } }, "SecurityGroups": { "target": "com.amazonaws.ec2#SecurityGroupStringList", "traits": { - "smithy.api#documentation": "

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you\n must use security group IDs instead.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

\n

Default: Amazon EC2 uses the default security group.

", + "smithy.api#documentation": "

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you\n must use security group IDs instead.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface.

\n

Default: Amazon EC2 uses the default security group.

", "smithy.api#xmlName": "SecurityGroup" } }, "SubnetId": { "target": "com.amazonaws.ec2#SubnetId", "traits": { - "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet to launch the instance into.

\n

If you specify a network interface, you must specify any subnets as part of the\n network interface.

" + "smithy.api#documentation": "

[EC2-VPC] The ID of the subnet to launch the instance into.

\n

If you specify a network interface, you must specify any subnets as part of the\n network interface.

" } }, "UserData": { @@ -80615,7 +80659,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.

\n\n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.

\n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", "smithy.api#idempotencyToken": {}, "smithy.api#xmlName": "clientToken" } @@ -80626,7 +80670,7 @@ "aws.protocols#ec2QueryName": "DisableApiTermination", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

\n

Default: false\n

", + "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

\n

Default: false\n

", "smithy.api#xmlName": "disableApiTermination" } }, @@ -80646,7 +80690,7 @@ "aws.protocols#ec2QueryName": "EbsOptimized", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", "smithy.api#xmlName": "ebsOptimized" } }, @@ -80662,7 +80706,7 @@ "target": "com.amazonaws.ec2#ShutdownBehavior", "traits": { "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" } }, @@ -80678,7 +80722,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#documentation": "

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", "smithy.api#xmlName": "privateIpAddress" } }, @@ -80691,14 +80735,14 @@ "ElasticInferenceAccelerators": { "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", "traits": { - "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

", + "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

", "smithy.api#xmlName": "ElasticInferenceAccelerator" } }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

", + "smithy.api#documentation": "

The tags to apply to the resources that are created during instance launch.

\n

You can specify tags for the following resources only:

\n \n

To tag a resource after it has been created, see CreateTags.

", "smithy.api#xmlName": "TagSpecification" } }, @@ -80711,13 +80755,13 @@ "InstanceMarketOptions": { "target": "com.amazonaws.ec2#InstanceMarketOptionsRequest", "traits": { - "smithy.api#documentation": "

The market (purchasing) option for the instances.

\n

For RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.

" + "smithy.api#documentation": "

The market (purchasing) option for the instances.

\n

For RunInstances, persistent Spot Instance requests are\n only supported when InstanceInterruptionBehavior is set\n to either hibernate or stop.

" } }, "CreditSpecification": { "target": "com.amazonaws.ec2#CreditSpecificationRequest", "traits": { - "smithy.api#documentation": "

The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

\n

Default: standard (T2 instances) or unlimited (T3/T3a/T4g\n instances)

\n

For T3 instances with host tenancy, only standard is\n supported.

" + "smithy.api#documentation": "

The credit option for CPU usage of the burstable performance instance. Valid values\n are standard and unlimited. To change this attribute after\n launch, use \n ModifyInstanceCreditSpecification. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

\n

Default: standard (T2 instances) or unlimited (T3/T3a/T4g\n instances)

\n

For T3 instances with host tenancy, only standard is\n supported.

" } }, "CpuOptions": { @@ -80735,7 +80779,7 @@ "HibernationOptions": { "target": "com.amazonaws.ec2#HibernationOptionsRequest", "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon EC2 User Guide.

\n

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.

" + "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon EC2 User Guide.

\n

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same\n instance.

" } }, "LicenseSpecifications": { @@ -80754,7 +80798,7 @@ "EnclaveOptions": { "target": "com.amazonaws.ec2#EnclaveOptionsRequest", "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.

" + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.

" } }, "PrivateDnsNameOptions": { @@ -81381,7 +81425,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \t\tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n \t\tvolumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n \t\tinstances built on the Nitro System. Other instance families guarantee performance up to\n \t\t32,000 IOPS. For more information, see Amazon EBS volume types in the\n \t\tAmazon EC2 User Guide.

\n \t

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

" + "smithy.api#documentation": "

The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum\n \t\tratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for\n \t\tvolumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on\n \t\tinstances built on the Nitro System. Other instance families guarantee performance up to\n \t\t32,000 IOPS. For more information, see Amazon EBS volume types in the\n \t\tAmazon EC2 User Guide.

\n

This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

" } }, "SnapshotId": { @@ -81829,7 +81873,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", + "smithy.api#documentation": "

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -82162,7 +82206,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

", + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

", "smithy.api#xmlName": "ipProtocol" } }, @@ -82256,7 +82300,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the description of a security group rule.

\n

You can use this when you want to update the security group rule description for either an inbound or outbound rule.

" + "smithy.api#documentation": "

Describes the description of a security group rule.

\n

You can use this when you want to update the security group rule description for either an inbound or outbound rule.

" } }, "com.amazonaws.ec2#SecurityGroupRuleDescriptionList": { @@ -82295,7 +82339,7 @@ "IpProtocol": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

" + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number (see Protocol Numbers).

\n

Use -1 to specify all protocols.

" } }, "FromPort": { @@ -82346,7 +82390,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a security group rule.

\n

You must specify exactly one of the following parameters, based on the rule type:

\n \n

When you modify a rule, you cannot change the rule type. For example, if the rule \n uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 \n address range.

" + "smithy.api#documentation": "

Describes a security group rule.

\n

You must specify exactly one of the following parameters, based on the rule type:

\n \n

When you modify a rule, you cannot change the rule type. For example, if the rule \n uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 \n address range.

" } }, "com.amazonaws.ec2#SecurityGroupRuleUpdate": { @@ -82413,7 +82457,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).

\n\n

In general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.

\n\n

Before sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.

\n\n

For more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).

" + "smithy.api#documentation": "

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).

\n

In general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.

\n

Before sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.

\n

For more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).

" } }, "com.amazonaws.ec2#SendDiagnosticInterruptRequest": { @@ -82718,7 +82762,7 @@ "target": "com.amazonaws.ec2#DnsNameState", "traits": { "aws.protocols#ec2QueryName": "PrivateDnsNameVerificationState", - "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

Consumers of the endpoint service cannot use the private name when the state is not verified.

", + "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

Consumers of the endpoint service cannot use the private name when the state is not verified.

", "smithy.api#xmlName": "privateDnsNameVerificationState" } }, @@ -83654,7 +83698,7 @@ "target": "com.amazonaws.ec2#ReplacementStrategy", "traits": { "aws.protocols#ec2QueryName": "ReplacementStrategy", - "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - Spot Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\n does not terminate the instances that receive a rebalance notification. You can\n terminate the old instances, or you can leave them running. You are charged for all\n instances while they are running.

\n

\n launch-before-terminate - Spot Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", + "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - Spot Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\n does not terminate the instances that receive a rebalance notification. You can\n terminate the old instances, or you can leave them running. You are charged for all\n instances while they are running.

\n

\n launch-before-terminate - Spot Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", "smithy.api#xmlName": "replacementStrategy" } }, @@ -83664,7 +83708,7 @@ "aws.protocols#ec2QueryName": "TerminationDelay", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

", + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

\n

Required when ReplacementStrategy is set to launch-before-terminate.

\n

Not valid when ReplacementStrategy is set to launch.

\n

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

", "smithy.api#xmlName": "terminationDelay" } } @@ -83860,7 +83904,7 @@ "aws.protocols#ec2QueryName": "WeightedCapacity", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.

\n

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.

", + "smithy.api#documentation": "

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.

\n

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.

", "smithy.api#xmlName": "weightedCapacity" } }, @@ -83966,7 +84010,7 @@ "target": "com.amazonaws.ec2#AllocationStrategy", "traits": { "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.

\n \n
\n
priceCapacityOptimized (recommended)
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacityOptimized
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowestPrice
\n
\n

Spot Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n \n

Default: lowestPrice\n

", + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the Spot Fleet launch configuration. For more information, see Allocation\n strategies for Spot Instances in the Amazon EC2 User Guide.

\n
\n
priceCapacityOptimized (recommended)
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacityOptimized
\n
\n

Spot Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacityOptimizedPrioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacityOptimizedPrioritized is supported only if your Spot Fleet uses a\n launch template. Note that if the OnDemandAllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

Spot Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowestPrice
\n
\n

Spot Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowestPrice\n

", "smithy.api#xmlName": "allocationStrategy" } }, @@ -84052,7 +84096,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", "smithy.api#xmlName": "spotPrice" } }, @@ -84149,7 +84193,7 @@ "target": "com.amazonaws.ec2#LoadBalancersConfig", "traits": { "aws.protocols#ec2QueryName": "LoadBalancersConfig", - "smithy.api#documentation": "

One or more Classic Load Balancers and target groups to attach to the Spot Fleet\n request. Spot Fleet registers the running Spot Instances with the specified Classic Load\n Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the\n following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\n M3, and T1.

", + "smithy.api#documentation": "

One or more Classic Load Balancers and target groups to attach to the Spot Fleet\n request. Spot Fleet registers the running Spot Instances with the specified Classic Load\n Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the\n following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\n M3, and T1.

", "smithy.api#xmlName": "loadBalancersConfig" } }, @@ -84159,7 +84203,7 @@ "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

\n

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of\n pools that you specified.

", + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

\n

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of\n pools that you specified.

", "smithy.api#xmlName": "instancePoolsToUseCount" } }, @@ -84365,7 +84409,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", "smithy.api#xmlName": "spotPrice" } }, @@ -84413,7 +84457,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", "smithy.api#xmlName": "validUntil" } }, @@ -84581,7 +84625,7 @@ "MaxPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The maximum hourly price that you're willing to pay for a Spot Instance. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " + "smithy.api#documentation": "

The maximum hourly price that you're willing to pay for a Spot Instance. We do not\n recommend using this parameter because it can lead to increased interruptions. If you do\n not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your Spot Instances will be interrupted more\n frequently than if you do not specify this parameter.

\n " } }, "SpotInstanceType": { @@ -84601,7 +84645,7 @@ "ValidUntil": { "target": "com.amazonaws.ec2#DateTime", "traits": { - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n Supported only for persistent requests.

\n " + "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n Supported only for persistent requests.

\n " } }, "InstanceInterruptionBehavior": { @@ -84622,7 +84666,7 @@ "target": "com.amazonaws.ec2#SpotAllocationStrategy", "traits": { "aws.protocols#ec2QueryName": "AllocationStrategy", - "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n \n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price
\n
\n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n \n

Default: lowest-price\n

", + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price
\n
\n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowest-price\n

", "smithy.api#xmlName": "allocationStrategy" } }, @@ -84701,7 +84745,7 @@ "AllocationStrategy": { "target": "com.amazonaws.ec2#SpotAllocationStrategy", "traits": { - "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n \n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price
\n
\n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n \n

Default: lowest-price\n

" + "smithy.api#documentation": "

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance\n pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the\n Amazon EC2 User Guide.

\n
\n
price-capacity-optimized (recommended)
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.

\n
\n
capacity-optimized
\n
\n

EC2 Fleet identifies the pools with \n the highest capacity availability for the number of instances that are launching. This means \n that we will request Spot Instances from the pools that we believe have the lowest chance of interruption \n in the near term. To give certain\n instance types a higher chance of launching first, use\n capacity-optimized-prioritized. Set a priority for each instance type by\n using the Priority parameter for LaunchTemplateOverrides. You can\n assign the same priority to different LaunchTemplateOverrides. EC2 implements\n the priorities on a best-effort basis, but optimizes for capacity first.\n capacity-optimized-prioritized is supported only if your EC2 Fleet uses a\n launch template. Note that if the On-Demand AllocationStrategy is set to\n prioritized, the same priority is applied when fulfilling On-Demand\n capacity.

\n
\n
diversified
\n
\n

EC2 Fleet requests instances from all of the Spot Instance pools that you\n specify.

\n
\n
lowest-price
\n
\n

EC2 Fleet requests instances from the lowest priced Spot Instance pool that\n has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances\n come from the next lowest priced pool that has available capacity. If a pool runs out of\n capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your\n request by drawing from the next lowest priced pool. To ensure that your desired capacity is\n met, you might receive Spot Instances from several pools. Because this strategy only considers instance \n price and not capacity availability, it might lead to high interruption rates.

\n
\n
\n

Default: lowest-price\n

" } }, "MaintenanceStrategies": { @@ -84766,7 +84810,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

\n

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas;\n for example, \"us-west-2a, us-west-2b\".

", + "smithy.api#documentation": "

The Availability Zone.

\n

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas;\n for example, \"us-west-2a, us-west-2b\".

", "smithy.api#xmlName": "availabilityZone" } }, @@ -84885,7 +84929,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", "smithy.api#xmlName": "spotPrice" } }, @@ -84899,7 +84943,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n " + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n " } }, "com.amazonaws.ec2#SpotPriceHistoryList": { @@ -85071,7 +85115,7 @@ "target": "com.amazonaws.ec2#StartInstancesResult" }, "traits": { - "smithy.api#documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n\n

If you attempt to start a T3 instance with host tenancy and the\n unlimted CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.

\n\n

For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n

If you attempt to start a T3 instance with host tenancy and the\n unlimted CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.

\n

For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#StartInstancesRequest": { @@ -85266,7 +85310,7 @@ "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult" }, "traits": { - "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server.

" + "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server.

" } }, "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest": { @@ -85373,7 +85417,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "

The message for the state change.

\n ", + "smithy.api#documentation": "

The message for the state change.

\n ", "smithy.api#xmlName": "message" } } @@ -85482,7 +85526,7 @@ "target": "com.amazonaws.ec2#StopInstancesResult" }, "traits": { - "smithy.api#documentation": "

Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#StopInstancesRequest": { @@ -85502,7 +85546,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon EC2 User Guide.

\n

Default: false\n

" + "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon EC2 User Guide.

\n

Default: false\n

" } }, "DryRun": { @@ -85521,7 +85565,7 @@ "aws.protocols#ec2QueryName": "Force", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Forces the instances to stop. The instances do not have an opportunity to flush file\n system caches or file system metadata. If you use this option, you must perform file\n system check and repair procedures. This option is not recommended for Windows\n instances.

\n

Default: false\n

", + "smithy.api#documentation": "

Forces the instances to stop. The instances do not have an opportunity to flush file\n system caches or file system metadata. If you use this option, you must perform file\n system check and repair procedures. This option is not recommended for Windows\n instances.

\n

Default: false\n

", "smithy.api#xmlName": "force" } } @@ -86928,7 +86972,7 @@ "target": "com.amazonaws.ec2#TerminateInstancesResult" }, "traits": { - "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.

\n\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n \n\n

For example, say you have the following instances:

\n \n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n \n\n\n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n \n

For example, say you have the following instances:

\n \n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n \n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#TerminateInstancesRequest": { @@ -86938,7 +86982,7 @@ "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the instances.

\n

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into\n smaller batches.

", + "smithy.api#documentation": "

The IDs of the instances.

\n

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into\n smaller batches.

", "smithy.api#required": {}, "smithy.api#xmlName": "InstanceId" } @@ -90742,7 +90786,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Currently available in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Information about an association between a branch network interface with a trunk network interface.

" + "smithy.api#documentation": "\n

Currently available in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Information about an association between a branch network interface with a trunk network interface.

" } }, "com.amazonaws.ec2#TrunkInterfaceAssociationId": { @@ -91584,7 +91628,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group. In a request, use this parameter for a security group\n in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the\n security group ID.

\n

For a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.

", + "smithy.api#documentation": "

The name of the security group. In a request, use this parameter for a security group\n in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the\n security group ID.

\n

For a referenced security group in another VPC, this value is not returned if the\n referenced security group is deleted.

", "smithy.api#xmlName": "groupName" } }, @@ -91600,7 +91644,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group\n in another Amazon Web Services account.

", + "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group\n in another Amazon Web Services account.

", "smithy.api#xmlName": "userId" } }, @@ -91622,7 +91666,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a security group and Amazon Web Services account ID pair.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " + "smithy.api#documentation": "

Describes a security group and Amazon Web Services account ID pair.

\n \n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n " } }, "com.amazonaws.ec2#UserIdGroupPairList": { @@ -93301,6 +93345,9 @@ } } }, + "com.amazonaws.ec2#VolumeIdWithResolver": { + "type": "string" + }, "com.amazonaws.ec2#VolumeList": { "type": "list", "member": { @@ -94193,7 +94240,7 @@ } }, "traits": { - "smithy.api#documentation": "\n\t

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n\t \n\t\t

Describes whether a VPC is enabled for ClassicLink.

" + "smithy.api#documentation": "\n

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

\n \n

Describes whether a VPC is enabled for ClassicLink.

" } }, "com.amazonaws.ec2#VpcClassicLinkIdList": { @@ -95206,7 +95253,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OutsideIpAddressType", - "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

", + "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

", "smithy.api#xmlName": "outsideIpAddressType" } }, @@ -95247,7 +95294,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicate whether to enable acceleration for the VPN connection.

\n

Default: false\n

" + "smithy.api#documentation": "

Indicate whether to enable acceleration for the VPN connection.

\n

Default: false\n

" } }, "StaticRoutesOnly": { @@ -95256,14 +95303,14 @@ "aws.protocols#ec2QueryName": "StaticRoutesOnly", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "

Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.

\n

Default: false\n

", + "smithy.api#documentation": "

Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.

\n

Default: false\n

", "smithy.api#xmlName": "staticRoutesOnly" } }, "TunnelInsideIpVersion": { "target": "com.amazonaws.ec2#TunnelInsideIpVersion", "traits": { - "smithy.api#documentation": "

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

\n

Default: ipv4\n

" + "smithy.api#documentation": "

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

\n

Default: ipv4\n

" } }, "TunnelOptions": { @@ -95275,37 +95322,37 @@ "LocalIpv4NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + "smithy.api#documentation": "

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" } }, "RemoteIpv4NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" + "smithy.api#documentation": "

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: 0.0.0.0/0\n

" } }, "LocalIpv6NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" + "smithy.api#documentation": "

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

\n

Default: ::/0\n

" } }, "RemoteIpv6NetworkCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" + "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" } }, "OutsideIpAddressType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway device.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

" + "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway device.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

" } }, "TransportTransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { - "smithy.api#documentation": "

The transit gateway attachment ID to use for the VPN tunnel.

\n

Required if OutsideIpAddressType is set to PrivateIpv4.

" + "smithy.api#documentation": "

The transit gateway attachment ID to use for the VPN tunnel.

\n

Required if OutsideIpAddressType is set to PrivateIpv4.

" } } }, @@ -95545,19 +95592,19 @@ "TunnelInsideCidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " + "smithy.api#documentation": "

The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same virtual private gateway.

\n

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The\n following CIDR blocks are reserved and cannot be used:

\n " } }, "TunnelInsideIpv6Cidr": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" + "smithy.api#documentation": "

The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be\n unique across all VPN connections that use the same transit gateway.

\n

Constraints: A size /126 CIDR block from the local fd00::/8 range.

" } }, "PreSharedKey": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" + "smithy.api#documentation": "

The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and customer gateway.

\n

Constraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).

" } }, "Phase1LifetimeSeconds": { @@ -95565,7 +95612,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" + "smithy.api#documentation": "

The lifetime for phase 1 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 28,800.

\n

Default: 28800\n

" } }, "Phase2LifetimeSeconds": { @@ -95573,7 +95620,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" + "smithy.api#documentation": "

The lifetime for phase 2 of the IKE negotiation, in seconds.

\n

Constraints: A value between 900 and 3,600. The value must be less than the value for\n Phase1LifetimeSeconds.

\n

Default: 3600\n

" } }, "RekeyMarginTimeSeconds": { @@ -95581,7 +95628,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" + "smithy.api#documentation": "

The margin time, in seconds, before the phase 2 lifetime expires, during which the\n Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time\n of the rekey is randomly selected based on the value for\n RekeyFuzzPercentage.

\n

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

\n

Default: 540\n

" } }, "RekeyFuzzPercentage": { @@ -95589,7 +95636,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" + "smithy.api#documentation": "

The percentage of the rekey window (determined by RekeyMarginTimeSeconds)\n during which the rekey time is randomly selected.

\n

Constraints: A value between 0 and 100.

\n

Default: 100\n

" } }, "ReplayWindowSize": { @@ -95597,7 +95644,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" + "smithy.api#documentation": "

The number of packets in an IKE replay window.

\n

Constraints: A value between 64 and 2048.

\n

Default: 1024\n

" } }, "DPDTimeoutSeconds": { @@ -95605,68 +95652,68 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" + "smithy.api#documentation": "

The number of seconds after which a DPD timeout occurs.

\n

Constraints: A value greater than or equal to 30.

\n

Default: 30\n

" } }, "DPDTimeoutAction": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" + "smithy.api#documentation": "

The action to take after DPD timeout occurs. Specify restart to restart\n the IKE initiation. Specify clear to end the IKE session.

\n

Valid Values: clear | none | restart\n

\n

Default: clear\n

" } }, "Phase1EncryptionAlgorithms": { "target": "com.amazonaws.ec2#Phase1EncryptionAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", "smithy.api#xmlName": "Phase1EncryptionAlgorithm" } }, "Phase2EncryptionAlgorithms": { "target": "com.amazonaws.ec2#Phase2EncryptionAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", + "smithy.api#documentation": "

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2\n IKE negotiations.

\n

Valid values: AES128 | AES256 | AES128-GCM-16 |\n AES256-GCM-16\n

", "smithy.api#xmlName": "Phase2EncryptionAlgorithm" } }, "Phase1IntegrityAlgorithms": { "target": "com.amazonaws.ec2#Phase1IntegrityAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", "smithy.api#xmlName": "Phase1IntegrityAlgorithm" } }, "Phase2IntegrityAlgorithms": { "target": "com.amazonaws.ec2#Phase2IntegrityAlgorithmsRequestList", "traits": { - "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", + "smithy.api#documentation": "

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE\n negotiations.

\n

Valid values: SHA1 | SHA2-256 | SHA2-384 |\n SHA2-512\n

", "smithy.api#xmlName": "Phase2IntegrityAlgorithm" } }, "Phase1DHGroupNumbers": { "target": "com.amazonaws.ec2#Phase1DHGroupNumbersRequestList", "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 1 IKE negotiations.

\n

Valid values: 2 | 14 | 15 | 16 |\n 17 | 18 | 19 | 20 |\n 21 | 22 | 23 | 24\n

", "smithy.api#xmlName": "Phase1DHGroupNumber" } }, "Phase2DHGroupNumbers": { "target": "com.amazonaws.ec2#Phase2DHGroupNumbersRequestList", "traits": { - "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", + "smithy.api#documentation": "

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for\n phase 2 IKE negotiations.

\n

Valid values: 2 | 5 | 14 | 15 |\n 16 | 17 | 18 | 19 |\n 20 | 21 | 22 | 23 |\n 24\n

", "smithy.api#xmlName": "Phase2DHGroupNumber" } }, "IKEVersions": { "target": "com.amazonaws.ec2#IKEVersionsRequestList", "traits": { - "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", + "smithy.api#documentation": "

The IKE versions that are permitted for the VPN tunnel.

\n

Valid values: ikev1 | ikev2\n

", "smithy.api#xmlName": "IKEVersion" } }, "StartupAction": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" + "smithy.api#documentation": "

The action to take when the establishing the tunnel for the VPN connection. By\n default, your customer gateway device must initiate the IKE negotiation and bring up the\n tunnel. Specify start for Amazon Web Services to initiate the IKE\n negotiation.

\n

Valid Values: add | start\n

\n

Default: add\n

" } }, "LogOptions": { diff --git a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json index 1a7aadcfce9..84a400d2e78 100644 --- a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json +++ b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json @@ -264,7 +264,7 @@ "name": "ecs" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Elastic Container Service\n\t\t

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes\n\t\t\tit easy to run, stop, and manage Docker containers. You can host your cluster on a\n\t\t\tserverless infrastructure that's managed by Amazon ECS by launching your services or tasks on\n\t\t\tFargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)\n\t\t\tor External (on-premises) instances that you manage.

\n\t\t

Amazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls. This makes it easy to get the state of your cluster from a centralized service,\n\t\t\tand gives you access to many familiar Amazon EC2 features.

\n\t\t

You can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. With Amazon ECS, you\n\t\t\tdon't need to operate your own cluster management and configuration management systems.\n\t\t\tYou also don't need to worry about scaling your management infrastructure.

", + "smithy.api#documentation": "Amazon Elastic Container Service\n

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes\n\t\t\tit easy to run, stop, and manage Docker containers. You can host your cluster on a\n\t\t\tserverless infrastructure that's managed by Amazon ECS by launching your services or tasks on\n\t\t\tFargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)\n\t\t\tor External (on-premises) instances that you manage.

\n

Amazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls. This makes it easy to get the state of your cluster from a centralized service,\n\t\t\tand gives you access to many familiar Amazon EC2 features.

\n

You can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. With Amazon ECS, you\n\t\t\tdon't need to operate your own cluster management and configuration management systems.\n\t\t\tYou also don't need to worry about scaling your management infrastructure.

", "smithy.api#title": "Amazon EC2 Container Service", "smithy.api#xmlNamespace": { "uri": "http://ecs.amazonaws.com/doc/2014-11-13/" @@ -323,15 +323,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -594,9 +585,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": true } }, { @@ -607,9 +598,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": false } }, { @@ -620,9 +611,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": true } }, { @@ -633,9 +624,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": false } }, { @@ -646,9 +637,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -659,9 +650,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -672,9 +663,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -685,9 +676,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -698,9 +689,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -711,9 +702,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -724,9 +715,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -737,9 +728,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -750,9 +741,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": true } }, { @@ -763,9 +754,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": false } }, { @@ -776,9 +767,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": true } }, { @@ -789,9 +780,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": false } }, { @@ -802,9 +793,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -815,9 +806,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -828,9 +819,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -841,9 +832,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -854,9 +845,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -867,9 +858,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -880,9 +871,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -893,9 +884,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -906,9 +897,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -919,9 +910,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -932,9 +923,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -945,9 +936,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -958,9 +949,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -971,9 +962,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -984,9 +975,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -997,9 +988,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -1008,9 +999,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-west-1" + "Region": "us-iso-west-1", + "UseDualStack": true } }, { @@ -1021,9 +1012,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-west-1" + "Region": "us-iso-west-1", + "UseDualStack": false } }, { @@ -1032,9 +1023,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-west-1" + "Region": "us-iso-west-1", + "UseDualStack": true } }, { @@ -1045,9 +1036,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-west-1" + "Region": "us-iso-west-1", + "UseDualStack": false } }, { @@ -1058,9 +1049,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": true } }, { @@ -1071,9 +1062,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": false } }, { @@ -1084,9 +1075,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": true } }, { @@ -1097,9 +1088,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": false } }, { @@ -1110,9 +1101,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -1123,9 +1114,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -1136,9 +1127,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -1149,9 +1140,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -1162,9 +1153,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -1175,9 +1166,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -1188,9 +1179,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -1201,9 +1192,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -1214,9 +1205,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -1227,9 +1218,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -1240,9 +1231,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -1253,9 +1244,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -1266,9 +1257,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1279,9 +1270,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1292,9 +1283,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1305,9 +1296,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1318,9 +1309,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1331,9 +1322,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1344,9 +1335,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1357,9 +1348,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1370,9 +1361,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -1383,9 +1374,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -1396,9 +1387,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -1409,9 +1400,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -1422,9 +1413,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -1435,9 +1426,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -1448,9 +1439,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -1461,9 +1452,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -1474,9 +1465,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -1487,9 +1478,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -1500,9 +1491,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -1513,9 +1504,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -1526,9 +1517,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -1539,9 +1530,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -1552,9 +1543,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -1565,9 +1556,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -1578,9 +1569,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -1591,9 +1582,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -1604,9 +1595,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -1617,9 +1608,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -1630,9 +1621,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -1643,9 +1634,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -1656,9 +1647,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -1669,9 +1660,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -1682,9 +1673,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -1695,9 +1686,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -1708,9 +1699,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -1721,9 +1712,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -1734,9 +1725,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -1747,9 +1738,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -1760,9 +1751,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -1773,9 +1764,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -1786,9 +1777,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -1799,9 +1790,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -1812,9 +1803,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -1825,9 +1816,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -1838,9 +1829,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -1851,9 +1842,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -1864,9 +1855,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -1877,9 +1868,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -1890,9 +1881,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -1903,9 +1894,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -1916,9 +1907,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -1929,9 +1920,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -1942,9 +1933,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -1955,9 +1946,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -1968,9 +1959,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -1981,9 +1972,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -1992,9 +1983,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -2005,9 +1996,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -2016,9 +2007,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -2029,9 +2020,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -2042,9 +2033,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -2055,9 +2046,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -2068,9 +2059,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -2081,9 +2072,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -2094,9 +2085,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": true } }, { @@ -2107,9 +2098,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": false } }, { @@ -2120,9 +2111,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": true } }, { @@ -2133,9 +2124,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": false } }, { @@ -2146,9 +2137,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -2159,9 +2150,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -2172,9 +2163,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -2185,9 +2176,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -2198,9 +2189,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -2211,9 +2202,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -2224,9 +2215,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -2237,9 +2228,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -2250,9 +2241,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -2263,9 +2254,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -2276,9 +2267,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -2289,9 +2280,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -2300,9 +2291,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -2313,9 +2304,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -2324,9 +2315,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -2337,9 +2328,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -2350,9 +2341,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2362,9 +2353,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2374,9 +2365,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -2567,7 +2558,7 @@ "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { - "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is disabled.

\n\t\t \n\t\t\t

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.

\n\t\t \n\t\t

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

\n\t\t

When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.

" + "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is disabled.

\n \n

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.

\n \n

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

\n

When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.

" } } }, @@ -2587,7 +2578,7 @@ "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { - "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.

\n\t\t \n\t\t\t

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.

\n\t\t \n\t\t

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.

\n\t\t

When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.

" + "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.

\n \n

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.

\n \n

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.

\n

When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.

" } } }, @@ -2601,14 +2592,14 @@ "subnets": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The IDs of the subnets associated with the task or service. There's a limit of 16\n\t\t\tsubnets that can be specified per AwsVpcConfiguration.

\n\t\t\n\t\t \n\t\t\t

All specified subnets must be from the same VPC.

\n\t\t ", + "smithy.api#documentation": "

The IDs of the subnets associated with the task or service. There's a limit of 16\n\t\t\tsubnets that can be specified per AwsVpcConfiguration.

\n \n

All specified subnets must be from the same VPC.

\n ", "smithy.api#required": {} } }, "securityGroups": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups associated with the task or service. If you don't\n\t\t\tspecify a security group, the default security group for the VPC is used. There's a\n\t\t\tlimit of 5 security groups that can be specified per\n\t\t\tAwsVpcConfiguration.

\n\t\t\n\t\t \n\t\t\t

All specified security groups must be from the same VPC.

\n\t\t " + "smithy.api#documentation": "

The IDs of the security groups associated with the task or service. If you don't\n\t\t\tspecify a security group, the default security group for the VPC is used. There's a\n\t\t\tlimit of 5 security groups that can be specified per\n\t\t\tAwsVpcConfiguration.

\n \n

All specified security groups must be from the same VPC.

\n " } }, "assignPublicIp": { @@ -2693,7 +2684,7 @@ "updateStatus": { "target": "com.amazonaws.ecs#CapacityProviderUpdateStatus", "traits": { - "smithy.api#documentation": "

The update status of the capacity provider. The following are the possible states that\n\t\t\tis returned.

\n\t\t
\n
DELETE_IN_PROGRESS
\n
\n\t\t\t\t\t

The capacity provider is in the process of being deleted.

\n\t\t\t\t
\n
DELETE_COMPLETE
\n
\n\t\t\t\t\t

The capacity provider was successfully deleted and has an\n\t\t\t\t\t\t\tINACTIVE status.

\n\t\t\t\t
\n
DELETE_FAILED
\n
\n\t\t\t\t\t

The capacity provider can't be deleted. The update status reason provides\n\t\t\t\t\t\tfurther details about why the delete failed.

\n\t\t\t\t
\n
" + "smithy.api#documentation": "

The update status of the capacity provider. The following are the possible states that\n\t\t\tis returned.

\n
\n
DELETE_IN_PROGRESS
\n
\n

The capacity provider is in the process of being deleted.

\n
\n
DELETE_COMPLETE
\n
\n

The capacity provider was successfully deleted and has an\n\t\t\t\t\t\t\tINACTIVE status.

\n
\n
DELETE_FAILED
\n
\n

The capacity provider can't be deleted. The update status reason provides\n\t\t\t\t\t\tfurther details about why the delete failed.

\n
\n
" } }, "updateStatusReason": { @@ -2705,7 +2696,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n " } } }, @@ -2767,7 +2758,7 @@ "target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.

\n\t\t

If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 can't be used to place\n\t\t\ttasks. If you specify multiple capacity providers in a strategy that all have a weight\n\t\t\tof 0, any RunTask or CreateService actions using\n\t\t\tthe capacity provider strategy will fail.

\n\t\t

An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1, then when the\n\t\t\t\tbase is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1 for\n\t\t\t\tcapacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that's run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.

" + "smithy.api#documentation": "

The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.

\n

If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 can't be used to place\n\t\t\ttasks. If you specify multiple capacity providers in a strategy that all have a weight\n\t\t\tof 0, any RunTask or CreateService actions using\n\t\t\tthe capacity provider strategy will fail.

\n

An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1, then when the\n\t\t\t\tbase is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1 for\n\t\t\t\tcapacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that's run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.

" } }, "base": { @@ -2779,7 +2770,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n\t\t

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.

\n\t\t

A capacity provider strategy may contain a maximum of 6 capacity providers.

" + "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "com.amazonaws.ecs#CapacityProviderStrategyItemBase": { @@ -2885,7 +2876,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the cluster. The following are the possible states that are\n\t\t\treturned.

\n\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

The cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.

\n\t\t\t\t
\n
PROVISIONING
\n
\n\t\t\t\t\t

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being created.

\n\t\t\t\t
\n
DEPROVISIONING
\n
\n\t\t\t\t\t

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being deleted.

\n\t\t\t\t
\n
FAILED
\n
\n\t\t\t\t\t

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider have failed to create.

\n\t\t\t\t
\n
INACTIVE
\n
\n\t\t\t\t\t

The cluster has been deleted. Clusters with an INACTIVE\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future. We don't\n\t\t\t\t\t\trecommend that you rely on INACTIVE clusters persisting.

\n\t\t\t\t
\n
" + "smithy.api#documentation": "

The status of the cluster. The following are the possible states that are\n\t\t\treturned.

\n
\n
ACTIVE
\n
\n

The cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.

\n
\n
PROVISIONING
\n
\n

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being created.

\n
\n
DEPROVISIONING
\n
\n

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being deleted.

\n
\n
FAILED
\n
\n

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider have failed to create.

\n
\n
INACTIVE
\n
\n

The cluster has been deleted. Clusters with an INACTIVE\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future. We don't\n\t\t\t\t\t\trecommend that you rely on INACTIVE clusters persisting.

\n
\n
" } }, "registeredContainerInstancesCount": { @@ -2919,13 +2910,13 @@ "statistics": { "target": "com.amazonaws.ecs#Statistics", "traits": { - "smithy.api#documentation": "

Additional information about your clusters that are separated by launch type. They\n\t\t\tinclude the following:

\n\t\t " + "smithy.api#documentation": "

Additional information about your clusters that are separated by launch type. They\n\t\t\tinclude the following:

\n " } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n " } }, "settings": { @@ -2955,13 +2946,13 @@ "attachmentsStatus": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that are returned.

\n\t\t
\n
UPDATE_IN_PROGRESS
\n
\n\t\t\t\t\t

The available capacity providers for the cluster are updating.

\n\t\t\t\t
\n
UPDATE_COMPLETE
\n
\n\t\t\t\t\t

The capacity providers have successfully updated.

\n\t\t\t\t
\n
UPDATE_FAILED
\n
\n\t\t\t\t\t

The capacity provider updates failed.

\n\t\t\t\t
\n
" + "smithy.api#documentation": "

The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that are returned.

\n
\n
UPDATE_IN_PROGRESS
\n
\n

The available capacity providers for the cluster are updating.

\n
\n
UPDATE_COMPLETE
\n
\n

The capacity providers have successfully updated.

\n
\n
UPDATE_FAILED
\n
\n

The capacity provider updates failed.

\n
\n
" } }, "serviceConnectDefaults": { "target": "com.amazonaws.ecs#ClusterServiceConnectDefaults", "traits": { - "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } }, @@ -3083,7 +3074,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest": { @@ -3092,13 +3083,13 @@ "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than\n\t\t\t(>), less than (<), or slash (/).

\n\t\t

If you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.

\n\t\t

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.

\n\t\t

If you update the service with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.

\n\t\t

For more information about Cloud Map, see Working\n\t\t\t\twith Services in the Cloud Map Developer Guide.

", + "smithy.api#documentation": "

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace that's used when you create a service and don't specify\n\t\t\ta Service Connect configuration. The namespace name can include up to 1024 characters.\n\t\t\tThe name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than\n\t\t\t(>), less than (<), or slash (/).

\n

If you enter an existing namespace name or ARN, then that namespace will be used.\n\t\t\tAny namespace type is supported. The namespace must be in this account and this Amazon Web Services\n\t\t\tRegion.

\n

If you enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a\n\t\t\tCloud Map namespace with the \"API calls\" method of instance discovery only. This instance\n\t\t\tdiscovery method is the \"HTTP\" namespace type in the Command Line Interface. Other types of instance\n\t\t\tdiscovery aren't used by Service Connect.

\n

If you update the service with an empty string \"\" for the namespace name,\n\t\t\tthe cluster configuration for Service Connect is removed. Note that the namespace will\n\t\t\tremain in Cloud Map and must be deleted separately.

\n

For more information about Cloud Map, see Working\n\t\t\t\twith Services in the Cloud Map Developer Guide.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#ClusterSetting": { @@ -3220,7 +3211,7 @@ "imageDigest": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container image manifest digest.

\n\t\t \n\t\t\t

The imageDigest is only returned if the container is using an image\n\t\t\t\thosted in Amazon ECR, otherwise it is omitted.

\n\t\t " + "smithy.api#documentation": "

The container image manifest digest.

\n \n

The imageDigest is only returned if the container is using an image\n\t\t\t\thosted in Amazon ECR, otherwise it is omitted.

\n " } }, "runtimeId": { @@ -3341,7 +3332,7 @@ "image": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. By default, images in the Docker Hub registry are available. Other repositories\n\t\t\tare specified with either \n\t\t\t\t repository-url/image:tag\n\t\t\t or \n\t\t\t\t repository-url/image@digest\n\t\t\t . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\tIMAGE parameter of docker\n\t\t\t\trun.

\n\t\t " + "smithy.api#documentation": "

The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. By default, images in the Docker Hub registry are available. Other repositories\n\t\t\tare specified with either \n repository-url/image:tag\n or \n repository-url/image@digest\n . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\tIMAGE parameter of docker\n\t\t\t\trun.

\n " } }, "repositoryCredentials": { @@ -3354,43 +3345,43 @@ "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of cpu units reserved for the container. This parameter maps\n\t\t\tto CpuShares in the Create a container section of the\n\t\t\tDocker Remote API and the --cpu-shares option to docker run.

\n\t\t

This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu value.

\n\t\t \n\t\t\t

You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.

\n\t\t \n\t\t

Linux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that's the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task is\n\t\t\tguaranteed a minimum of 512 CPU units when needed. Moreover, each container could float\n\t\t\tto higher CPU usage if the other container was not using it. If both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.

\n\t\t

On Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. For more\n\t\t\tinformation, see CPU share\n\t\t\t\tconstraint in the Docker documentation. The minimum valid CPU share value\n\t\t\tthat the Linux kernel allows is 2. However, the CPU parameter isn't required, and you\n\t\t\tcan use CPU values below 2 in your container definitions. For CPU values below 2\n\t\t\t(including null), the behavior varies based on your Amazon ECS container agent\n\t\t\tversion:

\n\t\t \n\t\t

On Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that's\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0, which Windows interprets as 1% of one CPU.

" + "smithy.api#documentation": "

The number of cpu units reserved for the container. This parameter maps\n\t\t\tto CpuShares in the Create a container section of the\n\t\t\tDocker Remote API and the --cpu-shares option to docker run.

\n

This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu value.

\n \n

You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.

\n \n

Linux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that's the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task is\n\t\t\tguaranteed a minimum of 512 CPU units when needed. Moreover, each container could float\n\t\t\tto higher CPU usage if the other container was not using it. If both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.

\n

On Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. For more\n\t\t\tinformation, see CPU share\n\t\t\t\tconstraint in the Docker documentation. The minimum valid CPU share value\n\t\t\tthat the Linux kernel allows is 2. However, the CPU parameter isn't required, and you\n\t\t\tcan use CPU values below 2 in your container definitions. For CPU values below 2\n\t\t\t(including null), the behavior varies based on your Amazon ECS container agent\n\t\t\tversion:

\n \n

On Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that's\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0, which Windows interprets as 1% of one CPU.

" } }, "memory": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the Create a container section of the\n\t\t\tDocker Remote API and the --memory option to docker run.

\n\t\t

If using the Fargate launch type, this parameter is optional.

\n\t\t

If using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.

\n\t\t

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.

\n\t\t

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.

" + "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the Create a container section of the\n\t\t\tDocker Remote API and the --memory option to docker run.

\n

If using the Fargate launch type, this parameter is optional.

\n

If using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.

\n

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.

\n

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.

" } }, "memoryReservation": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation in the Create a container section of\n\t\t\tthe Docker Remote API and the --memory-reservation option to docker run.

\n\t\t

If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of memory or memoryReservation in a container\n\t\t\tdefinition. If you specify both, memory must be greater than\n\t\t\t\tmemoryReservation. If you specify memoryReservation, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\twhere the container is placed. Otherwise, the value of memory is\n\t\t\tused.

\n\t\t

For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation of 128 MiB, and a memory hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.

\n\t\t

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.

\n\t\t

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.

" + "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation in the Create a container section of\n\t\t\tthe Docker Remote API and the --memory-reservation option to docker run.

\n

If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of memory or memoryReservation in a container\n\t\t\tdefinition. If you specify both, memory must be greater than\n\t\t\t\tmemoryReservation. If you specify memoryReservation, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\twhere the container is placed. Otherwise, the value of memory is\n\t\t\tused.

\n

For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation of 128 MiB, and a memory hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.

\n

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.

\n

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.

" } }, "links": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The links parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge. The name:internalName\n\t\t\tconstruct is analogous to name:alias in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to\n\t\t\t\tLegacy container links\n\t\t\tin the Docker documentation. This parameter maps to Links in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--link option to docker\n\t\t\trun.

\n\t\t \n

This parameter is not supported for Windows containers.

\n \n\t\t \n\t\t\t

Containers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.

\n\t\t " + "smithy.api#documentation": "

The links parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge. The name:internalName\n\t\t\tconstruct is analogous to name:alias in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to\n\t\t\t\tLegacy container links\n\t\t\tin the Docker documentation. This parameter maps to Links in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--link option to docker\n\t\t\trun.

\n \n

This parameter is not supported for Windows containers.

\n \n \n

Containers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.

\n " } }, "portMappings": { "target": "com.amazonaws.ecs#PortMappingList", "traits": { - "smithy.api#documentation": "

The list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.

\n\t\t

For task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.

\n\t\t

Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you\n\t\t\tcan't access a container's mapped port from the host itself.

\n\t\t

This parameter maps to PortBindings in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--publish option to docker\n\t\t\t\trun. If the network mode of a task definition is set to none,\n\t\t\tthen you can't specify port mappings. If the network mode of a task definition is set to\n\t\t\t\thost, then host ports must either be undefined or they must match the\n\t\t\tcontainer port in the port mapping.

\n\t\t \n\t\t\t

After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.

\n\t\t " + "smithy.api#documentation": "

The list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.

\n

For task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.

\n

Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you\n\t\t\tcan't access a container's mapped port from the host itself.

\n

This parameter maps to PortBindings in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--publish option to docker\n\t\t\t\trun. If the network mode of a task definition is set to none,\n\t\t\tthen you can't specify port mappings. If the network mode of a task definition is set to\n\t\t\t\thost, then host ports must either be undefined or they must match the\n\t\t\tcontainer port in the port mapping.

\n \n

After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.

\n " } }, "essential": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If the essential parameter of a container is marked as true,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential parameter of a container is marked\n\t\t\tas false, its failure doesn't affect the rest of the containers in a task.\n\t\t\tIf this parameter is omitted, a container is assumed to be essential.

\n\t\t

All tasks must have at least one essential container. If you have an application\n\t\t\tthat's composed of multiple containers, group containers that are used for a common\n\t\t\tpurpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

If the essential parameter of a container is marked as true,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential parameter of a container is marked\n\t\t\tas false, its failure doesn't affect the rest of the containers in a task.\n\t\t\tIf this parameter is omitted, a container is assumed to be essential.

\n

All tasks must have at least one essential container. If you have an application\n\t\t\tthat's composed of multiple containers, group containers that are used for a common\n\t\t\tpurpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.

" } }, "entryPoint": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "\n\t\t\t

Early versions of the Amazon ECS container agent don't properly handle\n\t\t\t\t\tentryPoint parameters. If you have problems using\n\t\t\t\t\tentryPoint, update your container agent or enter your commands and\n\t\t\t\targuments as command array items instead.

\n\t\t \n\t\t

The entry point that's passed to the container. This parameter maps to\n\t\t\t\tEntrypoint in the Create a container section of the\n\t\t\tDocker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

" + "smithy.api#documentation": "\n

Early versions of the Amazon ECS container agent don't properly handle\n\t\t\t\t\tentryPoint parameters. If you have problems using\n\t\t\t\t\tentryPoint, update your container agent or enter your commands and\n\t\t\t\targuments as command array items instead.

\n \n

The entry point that's passed to the container. This parameter maps to\n\t\t\t\tEntrypoint in the Create a container section of the\n\t\t\tDocker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

" } }, "command": { @@ -3402,19 +3393,19 @@ "environment": { "target": "com.amazonaws.ecs#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The environment variables to pass to a container. This parameter maps to\n\t\t\t\tEnv in the Create a container section of the\n\t\t\tDocker Remote API and the --env option to docker run.

\n\t\t \n\t\t\t

We don't recommend that you use plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.

\n\t\t " + "smithy.api#documentation": "

The environment variables to pass to a container. This parameter maps to\n\t\t\t\tEnv in the Create a container section of the\n\t\t\tDocker Remote API and the --env option to docker run.

\n \n

We don't recommend that you use plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.

\n " } }, "environmentFiles": { "target": "com.amazonaws.ecs#EnvironmentFiles", "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file option to docker run.

\n\t\t

You can specify up to ten environment files. The file must have a .env\n\t\t\tfile extension. Each line in an environment file contains an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n\t\t

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file option to docker run.

\n

You can specify up to ten environment files. The file must have a .env\n\t\t\tfile extension. Each line in an environment file contains an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.

" } }, "mountPoints": { "target": "com.amazonaws.ecs#MountPointList", "traits": { - "smithy.api#documentation": "

The mount points for data volumes in your container.

\n\t\t

This parameter maps to Volumes in the Create a container\n\t\t\tsection of the Docker Remote API and the --volume option to docker run.

\n\t\t

Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives.

" + "smithy.api#documentation": "

The mount points for data volumes in your container.

\n

This parameter maps to Volumes in the Create a container\n\t\t\tsection of the Docker Remote API and the --volume option to docker run.

\n

Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives.

" } }, "volumesFrom": { @@ -3426,7 +3417,7 @@ "linuxParameters": { "target": "com.amazonaws.ecs#LinuxParameters", "traits": { - "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as Linux kernel\n\t\t\tcapabilities. For more information see KernelCapabilities.

\n\t\t \n\t\t\t

This parameter is not supported for Windows containers.

\n\t\t " + "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as Linux kernel\n\t\t\tcapabilities. For more information see KernelCapabilities.

\n \n

This parameter is not supported for Windows containers.

\n " } }, "secrets": { @@ -3438,31 +3429,31 @@ "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 on other containers in a task definition. When a dependency is\n\t\t\tdefined for container startup, for container shutdown 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 an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin 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 " + "smithy.api#documentation": "

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies on other containers in a task definition. When a dependency is\n\t\t\tdefined for container startup, for container shutdown it is reversed.

\n

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 an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

\n

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\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\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 an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init\n\t\t\tpackage. If your container instances are launched from 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\tin 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 \n

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 \n

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n \n

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 an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init\n\t\t\tpackage. If your container instances are launched from 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\tin 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\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 timeout\n\t\t\tvalue. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container 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

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n \n

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

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 timeout\n\t\t\tvalue. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container 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": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The hostname to use for your container. This parameter maps to Hostname\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--hostname option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

The hostname parameter is not supported if you're using the\n\t\t\t\t\tawsvpc network mode.

\n\t\t " + "smithy.api#documentation": "

The hostname to use for your container. This parameter maps to Hostname\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--hostname option to docker\n\t\t\t\trun.

\n \n

The hostname parameter is not supported if you're using the\n\t\t\t\t\tawsvpc network mode.

\n " } }, "user": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The user to use inside the container. This parameter maps to User in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--user option to docker\n\t\t\trun.

\n\t\t \n\t\t\t

When running tasks using the host network mode, don't run containers\n\t\t\t\tusing the root user (UID 0). We recommend using a non-root user for better\n\t\t\t\tsecurity.

\n\t\t \n\t\t

You can specify the user using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.

\n\t\t \n\t\t \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

The user to use inside the container. This parameter maps to User in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--user option to docker\n\t\t\trun.

\n \n

When running tasks using the host network mode, don't run containers\n\t\t\t\tusing the root user (UID 0). We recommend using a non-root user for better\n\t\t\t\tsecurity.

\n \n

You can specify the user using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.

\n \n \n

This parameter is not supported for Windows containers.

\n " } }, "workingDirectory": { @@ -3474,43 +3465,43 @@ "disableNetworking": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, networking is disabled within the container. This\n\t\t\tparameter maps to NetworkDisabled in the Create a container\n\t\t\tsection of the Docker Remote API.

\n\t\t \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

When this parameter is true, networking is disabled within the container. This\n\t\t\tparameter maps to NetworkDisabled in the Create a container\n\t\t\tsection of the Docker Remote API.

\n \n

This parameter is not supported for Windows containers.

\n " } }, "privileged": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root user). This parameter maps to\n\t\t\t\tPrivileged in the Create a container section of the\n\t\t\tDocker Remote API and the --privileged option to docker run.

\n\t\t \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " + "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root user). This parameter maps to\n\t\t\t\tPrivileged in the Create a container section of the\n\t\t\tDocker Remote API and the --privileged option to docker run.

\n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " } }, "readonlyRootFilesystem": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--read-only option to docker\n\t\t\t\trun.

\n\t\t \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--read-only option to docker\n\t\t\t\trun.

\n \n

This parameter is not supported for Windows containers.

\n " } }, "dnsServers": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\tDns in the Create a container section of the\n\t\t\tDocker Remote API and the --dns option to docker run.

\n\t\t \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

A list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\tDns in the Create a container section of the\n\t\t\tDocker Remote API and the --dns option to docker run.

\n \n

This parameter is not supported for Windows containers.

\n " } }, "dnsSearchDomains": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch in the Create a container section of the\n\t\t\tDocker Remote API and the --dns-search option to docker run.

\n\t\t \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

A list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch in the Create a container section of the\n\t\t\tDocker Remote API and the --dns-search option to docker run.

\n \n

This parameter is not supported for Windows containers.

\n " } }, "extraHosts": { "target": "com.amazonaws.ecs#HostEntryList", "traits": { - "smithy.api#documentation": "

A list of hostnames and IP address mappings to append to the /etc/hosts\n\t\t\tfile on the container. This parameter maps to ExtraHosts in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--add-host option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

This parameter isn't supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc network mode.

\n\t\t " + "smithy.api#documentation": "

A list of hostnames and IP address mappings to append to the /etc/hosts\n\t\t\tfile on the container. This parameter maps to ExtraHosts in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--add-host option to docker\n\t\t\t\trun.

\n \n

This parameter isn't supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc network mode.

\n " } }, "dockerSecurityOptions": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level\n\t\t\tsecurity systems. This field isn't valid for containers in tasks using the\n\t\t\tFargate launch type.

\n\t\t

With Windows containers, this parameter can be used to reference a credential spec\n\t\t\tfile when configuring a container for Active Directory authentication. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.

\n\t\t

This parameter maps to SecurityOpt in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--security-opt option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t

For more information about valid values, see Docker\n\t\t\t\tRun Security Configuration.

\n\t\t

Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"

" + "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level\n\t\t\tsecurity systems. This field isn't valid for containers in tasks using the\n\t\t\tFargate launch type.

\n

With Windows containers, this parameter can be used to reference a credential spec\n\t\t\tfile when configuring a container for Active Directory authentication. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.

\n

This parameter maps to SecurityOpt in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--security-opt option to docker\n\t\t\t\trun.

\n \n

The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.

\n \n

For more information about valid values, see Docker\n\t\t\t\tRun Security Configuration.

\n

Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"

" } }, "interactive": { @@ -3528,19 +3519,19 @@ "dockerLabels": { "target": "com.amazonaws.ecs#DockerLabelsMap", "traits": { - "smithy.api#documentation": "

A key/value map of labels to add to the container. This parameter maps to\n\t\t\t\tLabels in the Create a container section of the\n\t\t\tDocker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

" + "smithy.api#documentation": "

A key/value map of labels to add to the container. This parameter maps to\n\t\t\t\tLabels in the Create a container section of the\n\t\t\tDocker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

" } }, "ulimits": { "target": "com.amazonaws.ecs#UlimitList", "traits": { - "smithy.api#documentation": "

A list of ulimits to set in the container. If a ulimit value\n\t\t\tis specified in a task definition, it overrides the default values set by Docker. This\n\t\t\tparameter maps to Ulimits in the Create a container section\n\t\t\tof the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed\n\t\t\tin the Ulimit data type.

\n\t\t

Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 1024 and hard limit\n\t\t\t\t\t\t\tis 4096.

\n\t\t

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

\n\t\t \n

This parameter is not supported for Windows containers.

\n " + "smithy.api#documentation": "

A list of ulimits to set in the container. If a ulimit value\n\t\t\tis specified in a task definition, it overrides the default values set by Docker. This\n\t\t\tparameter maps to Ulimits in the Create a container section\n\t\t\tof the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed\n\t\t\tin the Ulimit data type.

\n

Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 1024 and hard limit\n\t\t\t\t\t\t\tis 4096.

\n

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

\n \n

This parameter is not supported for Windows containers.

\n " } }, "logConfiguration": { "target": "com.amazonaws.ecs#LogConfiguration", "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

\n\t\t

This parameter maps to LogConfig in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to docker\n\t\t\t\trun. By default, containers use the same logging driver that the Docker\n\t\t\tdaemon uses. However the container can use a different logging driver than the Docker\n\t\t\tdaemon by specifying a log driver with this parameter in the container definition. To\n\t\t\tuse a different logging driver for a container, the log system must be configured\n\t\t\tproperly on the container instance (or on a different log server for remote logging\n\t\t\toptions). For more information about the options for different supported log drivers,\n\t\t\tsee Configure\n\t\t\t\tlogging drivers in the Docker documentation.

\n\t\t \n\t\t\t

Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log\n\t\t\t\tdrivers may be available in future releases of the Amazon ECS container agent.

\n\t\t \n\t\t

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

\n\t\t \n\t\t\t

The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.

\n\t\t " + "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to docker\n\t\t\t\trun. By default, containers use the same logging driver that the Docker\n\t\t\tdaemon uses. However the container can use a different logging driver than the Docker\n\t\t\tdaemon by specifying a log driver with this parameter in the container definition. To\n\t\t\tuse a different logging driver for a container, the log system must be configured\n\t\t\tproperly on the container instance (or on a different log server for remote logging\n\t\t\toptions). For more information about the options for different supported log drivers,\n\t\t\tsee Configure\n\t\t\t\tlogging drivers in the Docker documentation.

\n \n

Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log\n\t\t\t\tdrivers may be available in future releases of the Amazon ECS container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

\n \n

The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.

\n " } }, "healthCheck": { @@ -3552,7 +3543,7 @@ "systemControls": { "target": "com.amazonaws.ecs#SystemControls", "traits": { - "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n\t\t \n\t\t\t

We don't recommended that you specify network-related systemControls\n\t\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t\tawsvpc or host network modes. For tasks that use the\n\t\t\t\t\tawsvpc network mode, the container that's started last determines\n\t\t\t\twhich systemControls parameters take effect. For tasks that use the\n\t\t\t\t\thost network mode, it changes the container instance's namespaced\n\t\t\t\tkernel parameters as well as the containers.

\n\t\t " + "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n \n

We don't recommended that you specify network-related systemControls\n\t\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t\tawsvpc or host network modes. For tasks that use the\n\t\t\t\t\tawsvpc network mode, the container that's started last determines\n\t\t\t\twhich systemControls parameters take effect. For tasks that use the\n\t\t\t\t\thost network mode, it changes the container instance's namespaced\n\t\t\t\tkernel parameters as well as the containers.

\n " } }, "resourceRequirements": { @@ -3597,13 +3588,13 @@ "condition": { "target": "com.amazonaws.ecs#ContainerCondition", "traits": { - "smithy.api#documentation": "

The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:

\n\t\t ", + "smithy.api#documentation": "

The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:

\n ", "smithy.api#required": {} } } }, "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 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 an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin 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\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

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 an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

\n \n

For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:

\n \n " } }, "com.amazonaws.ecs#ContainerInstance": { @@ -3655,7 +3646,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.

\n\t\t

If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.

\n\t\t

The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks aren't placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container instance draining in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.

\n

If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.

\n

The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks aren't placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container instance draining in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "statusReason": { @@ -3712,7 +3703,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n " } }, "healthStatus": { @@ -3960,7 +3951,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.

\n\t\t

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tFargate use the FARGATE and FARGATE_SPOT capacity providers.\n\t\t\tThese providers are available to all accounts in the Amazon Web Services Regions that Fargate\n\t\t\tsupports.

" + "smithy.api#documentation": "

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.

\n

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tFargate use the FARGATE and FARGATE_SPOT capacity providers.\n\t\t\tThese providers are available to all accounts in the Amazon Web Services Regions that Fargate\n\t\t\tsupports.

" } }, "com.amazonaws.ecs#CreateCapacityProviderRequest": { @@ -3983,7 +3974,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the capacity provider to categorize and organize them\n\t\t\tmore conveniently. Each tag consists of a key and an optional value. You define both of\n\t\t\tthem.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the capacity provider to categorize and organize them\n\t\t\tmore conveniently. Each tag consists of a key and an optional value. You define both of\n\t\t\tthem.

\n

The following basic restrictions apply to tags:

\n " } } } @@ -4019,7 +4010,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.

\n\t\t \n\t\t\t

When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the IAM user\n\t\t\t\tthat makes the call doesn't have permissions to create the service-linked role, it\n\t\t\t\tisn't created. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

\n\t\t " + "smithy.api#documentation": "

Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.

\n \n

When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the IAM user\n\t\t\t\tthat makes the call doesn't have permissions to create the service-linked role, it\n\t\t\t\tisn't created. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

\n " } }, "com.amazonaws.ecs#CreateClusterRequest": { @@ -4034,7 +4025,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n " } }, "settings": { @@ -4052,19 +4043,19 @@ "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The short name of one or more capacity providers to associate with the cluster. A\n\t\t\tcapacity provider must be associated with a cluster before it can be included as part of\n\t\t\tthe default capacity provider strategy of the cluster or used in a capacity provider\n\t\t\tstrategy when calling the CreateService or RunTask\n\t\t\tactions.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must be created but not associated with another cluster. New Auto Scaling group\n\t\t\tcapacity providers can be created with the CreateCapacityProvider API\n\t\t\toperation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n\t\t

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

" + "smithy.api#documentation": "

The short name of one or more capacity providers to associate with the cluster. A\n\t\t\tcapacity provider must be associated with a cluster before it can be included as part of\n\t\t\tthe default capacity provider strategy of the cluster or used in a capacity provider\n\t\t\tstrategy when calling the CreateService or RunTask\n\t\t\tactions.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must be created but not associated with another cluster. New Auto Scaling group\n\t\t\tcapacity providers can be created with the CreateCapacityProvider API\n\t\t\toperation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

" } }, "defaultCapacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to set as the default for the cluster. After a default\n\t\t\tcapacity provider strategy is set for a cluster, when you call the RunTask or CreateService APIs with no capacity\n\t\t\tprovider strategy or launch type specified, the default capacity provider strategy for\n\t\t\tthe cluster is used.

\n\t\t

If a default capacity provider strategy isn't defined for a cluster when it was\n\t\t\tcreated, it can be defined later with the PutClusterCapacityProviders\n\t\t\tAPI operation.

" + "smithy.api#documentation": "

The capacity provider strategy to set as the default for the cluster. After a default\n\t\t\tcapacity provider strategy is set for a cluster, when you call the RunTask or CreateService APIs with no capacity\n\t\t\tprovider strategy or launch type specified, the default capacity provider strategy for\n\t\t\tthe cluster is used.

\n

If a default capacity provider strategy isn't defined for a cluster when it was\n\t\t\tcreated, it can be defined later with the PutClusterCapacityProviders\n\t\t\tAPI operation.

" } }, "serviceConnectDefaults": { "target": "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest", "traits": { - "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } } @@ -4118,7 +4109,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 Amazon 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\n\t\t\thealthy by the load balancer.

\n\t\t

There are two service scheduler strategies available:

\n\t\t \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. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide.

" + "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

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 Amazon Elastic Container Service Developer Guide.

\n

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\n\t\t\thealthy by the load balancer.

\n

There are two service scheduler strategies available:

\n \n

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

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

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

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

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

When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#CreateServiceRequest": { @@ -4140,25 +4131,25 @@ "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 in your service. If a revision\n\t\t\tisn't specified, the latest ACTIVE revision is used.

\n\t\t

A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.

" + "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision\n\t\t\tisn't specified, the latest ACTIVE revision is used.

\n

A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.

" } }, "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 Amazon 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\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\n\t\t\tchanged 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.\n\t\t\tWhen a task from this service is placed on a container instance, the container instance\n\t\t\tis registered 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 Amazon Elastic Container Service Developer Guide.

\n

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\tAmazon Elastic Container Service Developer Guide.

\n

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

If you use the CODE_DEPLOY deployment controller, these values can be\n\t\t\tchanged when updating the service.

\n

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

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.\n\t\t\tWhen a task from this service is placed on a container instance, the container instance\n\t\t\tis registered with the load balancer that's specified here.

\n

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": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "

The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.

\n\t\t \n\t\t\t

Each service may be associated with one service registry. Multiple service\n\t\t\t\tregistries for each service isn't supported.

\n\t\t " + "smithy.api#documentation": "

The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.

\n \n

Each service may be associated with one service registry. Multiple service\n\t\t\t\tregistries for each service isn't supported.

\n " } }, "desiredCount": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The number of instantiations of the specified task definition to place and keep\n\t\t\trunning on your cluster.

\n\t\t

This is required if schedulingStrategy is REPLICA or isn't\n\t\t\tspecified. If schedulingStrategy is DAEMON then this isn't\n\t\t\trequired.

" + "smithy.api#documentation": "

The number of instantiations of the specified task definition to place and keep\n\t\t\trunning on your cluster.

\n

This is required if schedulingStrategy is REPLICA or isn't\n\t\t\tspecified. If schedulingStrategy is DAEMON then this isn't\n\t\t\trequired.

" } }, "clientToken": { @@ -4170,13 +4161,13 @@ "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The infrastructure that you run your service on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n\t\t \n\t\t\t

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n\t\t \n\t\t

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n\t\t

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n\t\t

A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" + "smithy.api#documentation": "

The infrastructure that you run your service on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n \n

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n \n

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n

A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" } }, "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the service.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n\t\t

A capacity provider strategy may contain a maximum of 6 capacity providers.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the service.

\n

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "platformVersion": { @@ -4188,7 +4179,7 @@ "role": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition doesn't use the awsvpc\n\t\t\tnetwork mode. If you specify the role parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers parameter.

\n\t\t \n\t\t\t

If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused for your service unless you specify a role here. The service-linked role is\n\t\t\t\trequired if your task definition uses the awsvpc network mode or if the\n\t\t\t\tservice is configured to use service discovery, an external deployment controller,\n\t\t\t\tmultiple target groups, or Elastic Inference accelerators in which case you don't\n\t\t\t\tspecify a role here. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t

If your specified role has a path other than /, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar has a path of /foo/\n\t\t\tthen you would specify /foo/bar as the role name. For more information, see\n\t\t\t\tFriendly names and paths in the IAM User Guide.

" + "smithy.api#documentation": "

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition doesn't use the awsvpc\n\t\t\tnetwork mode. If you specify the role parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers parameter.

\n \n

If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused for your service unless you specify a role here. The service-linked role is\n\t\t\t\trequired if your task definition uses the awsvpc network mode or if the\n\t\t\t\tservice is configured to use service discovery, an external deployment controller,\n\t\t\t\tmultiple target groups, or Elastic Inference accelerators in which case you don't\n\t\t\t\tspecify a role here. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

\n \n

If your specified role has a path other than /, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar has a path of /foo/\n\t\t\tthen you would specify /foo/bar as the role name. For more information, see\n\t\t\t\tFriendly names and paths in the IAM User Guide.

" } }, "deploymentConfiguration": { @@ -4218,13 +4209,13 @@ "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 you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in\n\t\t\tthe task definition health check parameters. For more information, see Health\n\t\t\t\tcheck.

\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

If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in\n\t\t\tthe task definition health check parameters. For more information, see Health\n\t\t\t\tcheck.

\n

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": { "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 " + "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n

There are two service scheduler strategies available:

\n " } }, "deploymentController": { @@ -4236,7 +4227,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.

\n

The following basic restrictions apply to tags:

\n " } }, "enableECSManagedTags": { @@ -4262,7 +4253,7 @@ "serviceConnectConfiguration": { "target": "com.amazonaws.ecs#ServiceConnectConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } } @@ -4273,7 +4264,7 @@ "service": { "target": "com.amazonaws.ecs#Service", "traits": { - "smithy.api#documentation": "

The full description of your service following the create call.

\n\t\t

A service will return either a capacityProviderStrategy or\n\t\t\t\tlaunchType parameter, but not both, depending where one was specified\n\t\t\twhen it was created.

\n\t\t

If a service is using the ECS deployment controller, the\n\t\t\t\tdeploymentController and taskSets parameters will not be\n\t\t\treturned.

\n\t\t

if the service uses the CODE_DEPLOY deployment controller, the\n\t\t\t\tdeploymentController, taskSets and\n\t\t\t\tdeployments parameters will be returned, however the\n\t\t\t\tdeployments parameter will be an empty list.

" + "smithy.api#documentation": "

The full description of your service following the create call.

\n

A service will return either a capacityProviderStrategy or\n\t\t\t\tlaunchType parameter, but not both, depending where one was specified\n\t\t\twhen it was created.

\n

If a service is using the ECS deployment controller, the\n\t\t\t\tdeploymentController and taskSets parameters will not be\n\t\t\treturned.

\n

if the service uses the CODE_DEPLOY deployment controller, the\n\t\t\t\tdeploymentController, taskSets and\n\t\t\t\tdeployments parameters will be returned, however the\n\t\t\t\tdeployments parameter will be an empty list.

" } } } @@ -4376,13 +4367,13 @@ "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The launch type that new tasks in the task set uses. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" + "smithy.api#documentation": "

The launch type that new tasks in the task set uses. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n

If a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" } }, "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the task set.

\n\t\t

A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n\t\t

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the task set.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.

\n

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

" } }, "platformVersion": { @@ -4406,7 +4397,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both. When a service is\n\t\t\tdeleted, the tags are deleted.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both. When a service is\n\t\t\tdeleted, the tags are deleted.

\n

The following basic restrictions apply to tags:

\n " } } } @@ -4546,7 +4537,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified capacity provider.

\n\t\t \n\t\t\t

The FARGATE and FARGATE_SPOT capacity providers are\n\t\t\t\treserved and can't be deleted. You can disassociate them from a cluster using either\n\t\t\t\tthe PutClusterCapacityProviders API or by deleting the\n\t\t\t\tcluster.

\n\t\t \n\t\t

Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService\n\t\t\tAPI can be used to remove a capacity provider from a service's capacity provider\n\t\t\tstrategy. When updating a service, the forceNewDeployment option can be\n\t\t\tused to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that aren't associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

" + "smithy.api#documentation": "

Deletes the specified capacity provider.

\n \n

The FARGATE and FARGATE_SPOT capacity providers are\n\t\t\t\treserved and can't be deleted. You can disassociate them from a cluster using either\n\t\t\t\tthe PutClusterCapacityProviders API or by deleting the\n\t\t\t\tcluster.

\n \n

Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService\n\t\t\tAPI can be used to remove a capacity provider from a service's capacity provider\n\t\t\tstrategy. When updating a service, the forceNewDeployment option can be\n\t\t\tused to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that aren't associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

" } }, "com.amazonaws.ecs#DeleteCapacityProviderRequest": { @@ -4607,7 +4598,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.

\n\t\t

You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

" + "smithy.api#documentation": "

Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.

\n

You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

" } }, "com.amazonaws.ecs#DeleteClusterRequest": { @@ -4659,7 +4650,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.

\n\t\t \n\t\t\t

When you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.

\n\t\t \n\t\t \n\t\t\t

If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.

\n\t\t " + "smithy.api#documentation": "

Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.

\n \n

When you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.

\n \n \n

If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.

\n " } }, "com.amazonaws.ecs#DeleteServiceRequest": { @@ -4793,7 +4784,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the deployment. The following describes each state.

\n\t\t
\n
PRIMARY
\n
\n\t\t\t\t\t

The most recent deployment of a service.

\n\t\t\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

A service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY deployment.

\n\t\t\t\t
\n
INACTIVE
\n
\n\t\t\t\t\t

A deployment that has been completely replaced.

\n\t\t\t\t
\n
" + "smithy.api#documentation": "

The status of the deployment. The following describes each state.

\n
\n
PRIMARY
\n
\n

The most recent deployment of a service.

\n
\n
ACTIVE
\n
\n

A service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY deployment.

\n
\n
INACTIVE
\n
\n

A deployment that has been completely replaced.

\n
\n
" } }, "taskDefinition": { @@ -4827,7 +4818,7 @@ "target": "com.amazonaws.ecs#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of consecutively failed tasks in the deployment. A task is considered a\n\t\t\tfailure if the service scheduler can't launch the task, the task doesn't transition to a\n\t\t\t\tRUNNING state, or if it fails any of its defined health checks and is\n\t\t\tstopped.

\n\t\t \n\t\t\t

Once a service deployment has one or more successfully running tasks, the failed\n\t\t\t\ttask count resets to zero and stops being evaluated.

\n\t\t " + "smithy.api#documentation": "

The number of consecutively failed tasks in the deployment. A task is considered a\n\t\t\tfailure if the service scheduler can't launch the task, the task doesn't transition to a\n\t\t\t\tRUNNING state, or if it fails any of its defined health checks and is\n\t\t\tstopped.

\n \n

Once a service deployment has one or more successfully running tasks, the failed\n\t\t\t\ttask count resets to zero and stops being evaluated.

\n " } }, "createdAt": { @@ -4863,7 +4854,7 @@ "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The operating system that your tasks in the service, or tasks are running on. A\n\t\t\tplatform family is specified only for tasks using the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service, for example, \n\t\t\tLINUX..

" + "smithy.api#documentation": "

The operating system that your tasks in the service, or tasks are running on. A\n\t\t\tplatform family is specified only for tasks using the Fargate launch type.

\n

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service, for example, \n\t\t\tLINUX..

" } }, "networkConfiguration": { @@ -4875,7 +4866,7 @@ "rolloutState": { "target": "com.amazonaws.ecs#DeploymentRolloutState", "traits": { - "smithy.api#documentation": "\n\t\t\t

The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that aren't behind a\n\t\t\t\tClassic Load Balancer.

\n\t\t \n\t\t

The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment transitions to a COMPLETED state. If the service fails to reach\n\t\t\ta steady state and circuit breaker is enabled, the deployment transitions to a\n\t\t\t\tFAILED state. A deployment in FAILED state doesn't launch\n\t\t\tany new tasks. For more information, see DeploymentCircuitBreaker.

" + "smithy.api#documentation": "\n

The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that aren't behind a\n\t\t\t\tClassic Load Balancer.

\n \n

The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment transitions to a COMPLETED state. If the service fails to reach\n\t\t\ta steady state and circuit breaker is enabled, the deployment transitions to a\n\t\t\t\tFAILED state. A deployment in FAILED state doesn't launch\n\t\t\tany new tasks. For more information, see DeploymentCircuitBreaker.

" } }, "rolloutStateReason": { @@ -4887,7 +4878,7 @@ "serviceConnectConfiguration": { "target": "com.amazonaws.ecs#ServiceConnectConfiguration", "traits": { - "smithy.api#documentation": "

The details of the Service Connect configuration that's used by this deployment.\n\t\t\tCompare the configuration between multiple deployments when troubleshooting issues with\n\t\t\tnew deployments.

\n\t\t

The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The details of the Service Connect configuration that's used by this deployment.\n\t\t\tCompare the configuration between multiple deployments when troubleshooting issues with\n\t\t\tnew deployments.

\n

The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } }, "serviceConnectResources": { @@ -4901,6 +4892,37 @@ "smithy.api#documentation": "

The details of an Amazon ECS service deployment. This is used only when a service uses the\n\t\t\t\tECS deployment controller type.

" } }, + "com.amazonaws.ecs#DeploymentAlarms": { + "type": "structure", + "members": { + "alarmNames": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "

One or more CloudWatch alarm names. Use a \",\" to separate the alarms.

", + "smithy.api#required": {} + } + }, + "enable": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Determines whether to use the CloudWatch alarm option in the service deployment process.

", + "smithy.api#required": {} + } + }, + "rollback": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "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 used, when a service deployment fails, the service is rolled back\n\t\t\tto the last deployment that completed successfully.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

One of the methods which provide a way for you to quickly identify when a deployment\n\t\t\thas failed, and then to optionally roll back the failure to the last working\n\t\t\tdeployment.

\n

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback\n\t\t\tparameter to have Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure.

\n

You can only use the DeploymentAlarms method to detect failures when the\n\t\t\t\tDeploymentController is set to ECS (rolling\n\t\t\tupdate).

\n

For more information, see Rolling\n\t\t\t\tupdate in the \n Amazon Elastic Container Service Developer Guide\n .

" + } + }, "com.amazonaws.ecs#DeploymentCircuitBreaker": { "type": "structure", "members": { @@ -4916,13 +4938,13 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "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#documentation": "

Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is on, when a service deployment fails, the service is rolled back to\n\t\t\tthe 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 configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "\n

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 \n

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\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#DeploymentConfiguration": { @@ -4931,19 +4953,25 @@ "deploymentCircuitBreaker": { "target": "com.amazonaws.ecs#DeploymentCircuitBreaker", "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.

\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 deployment\n\t\t\tcircuit breaker is enabled, a service deployment will transition to a failed state and\n\t\t\tstop launching new tasks. If rollback is enabled, when a service deployment fails, the\n\t\t\tservice is rolled back to the last deployment that completed successfully.

" + "smithy.api#documentation": "\n

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.

\n \n

The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If deployment\n\t\t\tcircuit breaker is enabled, a service deployment will transition to a failed state and\n\t\t\tstop launching new tasks. If rollback is enabled, when a service deployment fails, the\n\t\t\tservice is rolled back to the last deployment that completed successfully.

" } }, "maximumPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of\n\t\t\tyour service's tasks that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using\n\t\t\tthe REPLICA service scheduler and has a desiredCount of four\n\t\t\ttasks and a maximumPercent value of 200%, the scheduler may start four new\n\t\t\ttasks before stopping the four older tasks (provided that the cluster resources required\n\t\t\tto do this are available). The default maximumPercent value for a service\n\t\t\tusing the REPLICA service scheduler is 200%.

\n\t\t

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and tasks that use the EC2\n\t\t\tlaunch type, the maximum percent value is set to the\n\t\t\tdefault value and is used to define the upper limit on the number of the tasks in the\n\t\t\tservice that remain in the RUNNING state while the container instances are\n\t\t\tin the DRAINING state. If the tasks in the service use the\n\t\t\tFargate launch type, the maximum percent value is not used, although it is\n\t\t\treturned when describing your service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of\n\t\t\tyour service's tasks that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using\n\t\t\tthe REPLICA service scheduler and has a desiredCount of four\n\t\t\ttasks and a maximumPercent value of 200%, the scheduler may start four new\n\t\t\ttasks before stopping the four older tasks (provided that the cluster resources required\n\t\t\tto do this are available). The default maximumPercent value for a service\n\t\t\tusing the REPLICA service scheduler is 200%.

\n

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and tasks that use the EC2\n\t\t\tlaunch type, the maximum percent value is set to the\n\t\t\tdefault value and is used to define the upper limit on the number of the tasks in the\n\t\t\tservice that remain in the RUNNING state while the container instances are\n\t\t\tin the DRAINING state. If the tasks in the service use the\n\t\t\tFargate launch type, the maximum percent value is not used, although it is\n\t\t\treturned when describing your service.

" } }, "minimumHealthyPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the RUNNING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a desiredCount of four tasks and a\n\t\t\t\tminimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.

\n\t\t

For services that do not use a load balancer, the following\n\t\t\tshould be noted:

\n\t\t \n\t\t

For services are that do use a load balancer, the following\n\t\t\tshould be noted:

\n\t\t \n\t\t

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the minimum healthy\n\t\t\t\tpercent value is set to the default value and is used to define the lower\n\t\t\tlimit on the number of the tasks in the service that remain in the RUNNING\n\t\t\tstate while the container instances are in the DRAINING state. If a service\n\t\t\tis using either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types and is running tasks that use the Fargate launch type,\n\t\t\tthe minimum healthy percent value is not used, although it is returned when describing\n\t\t\tyour service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the RUNNING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a desiredCount of four tasks and a\n\t\t\t\tminimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.

\n

For services that do not use a load balancer, the following\n\t\t\tshould be noted:

\n \n

For services are that do use a load balancer, the following\n\t\t\tshould be noted:

\n \n

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the minimum healthy\n\t\t\t\tpercent value is set to the default value and is used to define the lower\n\t\t\tlimit on the number of the tasks in the service that remain in the RUNNING\n\t\t\tstate while the container instances are in the DRAINING state. If a service\n\t\t\tis using either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types and is running tasks that use the Fargate launch type,\n\t\t\tthe minimum healthy percent value is not used, although it is returned when describing\n\t\t\tyour service.

" + } + }, + "alarms": { + "target": "com.amazonaws.ecs#DeploymentAlarms", + "traits": { + "smithy.api#documentation": "

Information about the CloudWatch alarms.

" } } }, @@ -4957,7 +4985,7 @@ "type": { "target": "com.amazonaws.ecs#DeploymentControllerType", "traits": { - "smithy.api#documentation": "

The deployment controller type to use.

\n\t\t

There are three deployment controller types available:

\n\t\t
\n
ECS
\n
\n\t\t\t\t\t

The rolling update (ECS) deployment type involves replacing\n\t\t\t\t\t\tthe current running version of the container with the latest version. The\n\t\t\t\t\t\tnumber of containers Amazon ECS adds or removes from the service during a rolling\n\t\t\t\t\t\tupdate is controlled by adjusting the minimum and maximum number of healthy\n\t\t\t\t\t\ttasks allowed during a service deployment, as specified in the DeploymentConfiguration.

\n\t\t\t\t
\n
CODE_DEPLOY
\n
\n\t\t\t\t\t

The blue/green (CODE_DEPLOY) deployment type uses the\n\t\t\t\t\t\tblue/green deployment model powered by CodeDeploy, which allows you to verify a\n\t\t\t\t\t\tnew deployment of a service before sending production traffic to it.

\n\t\t\t\t
\n
EXTERNAL
\n
\n\t\t\t\t\t

The external (EXTERNAL) deployment type enables you to use\n\t\t\t\t\t\tany third-party deployment controller for full control over the deployment\n\t\t\t\t\t\tprocess for an Amazon ECS service.

\n\t\t\t\t
\n
", + "smithy.api#documentation": "

The deployment controller type to use.

\n

There are three deployment controller types available:

\n
\n
ECS
\n
\n

The rolling update (ECS) deployment type involves replacing\n\t\t\t\t\t\tthe current running version of the container with the latest version. The\n\t\t\t\t\t\tnumber of containers Amazon ECS adds or removes from the service during a rolling\n\t\t\t\t\t\tupdate is controlled by adjusting the minimum and maximum number of healthy\n\t\t\t\t\t\ttasks allowed during a service deployment, as specified in the DeploymentConfiguration.

\n
\n
CODE_DEPLOY
\n
\n

The blue/green (CODE_DEPLOY) deployment type uses the\n\t\t\t\t\t\tblue/green deployment model powered by CodeDeploy, which allows you to verify a\n\t\t\t\t\t\tnew deployment of a service before sending production traffic to it.

\n
\n
EXTERNAL
\n
\n

The external (EXTERNAL) deployment type enables you to use\n\t\t\t\t\t\tany third-party deployment controller for full control over the deployment\n\t\t\t\t\t\tprocess for an Amazon ECS service.

\n
\n
", "smithy.api#required": {} } } @@ -5041,7 +5069,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.

\n\t\t

If you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.

\n\t\t

Deregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.

\n\t\t \n\t\t\t

If you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).

\n\t\t " + "smithy.api#documentation": "

Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.

\n

If you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.

\n

Deregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.

\n \n

If you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).

\n " } }, "com.amazonaws.ecs#DeregisterContainerInstanceRequest": { @@ -5063,7 +5091,7 @@ "force": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Forces the container instance to be deregistered. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an\n\t\t\torphaned task on your container instance is part of an Amazon ECS service, then the service\n\t\t\tscheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.

\n\t\t

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.

" + "smithy.api#documentation": "

Forces the container instance to be deregistered. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an\n\t\t\torphaned task on your container instance is part of an Amazon ECS service, then the service\n\t\t\tscheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.

\n

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.

" } } } @@ -5099,7 +5127,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE. Existing tasks and services that\n\t\t\treference an INACTIVE task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE task definition can still\n\t\t\tscale up or down by modifying the service's desired count.

\n\t\t

You can't use an INACTIVE task definition to run new tasks or create new\n\t\t\tservices, and you can't update an existing service to reference an INACTIVE\n\t\t\ttask definition. However, there may be up to a 10-minute window following deregistration\n\t\t\twhere these restrictions have not yet taken effect.

\n\t\t \n\t\t\t

At this time, INACTIVE task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future. We\n\t\t\t\tdon't recommend that you rely on INACTIVE task definitions persisting\n\t\t\t\tbeyond the lifecycle of any associated tasks and services.

\n\t\t " + "smithy.api#documentation": "

Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE. Existing tasks and services that\n\t\t\treference an INACTIVE task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE task definition can still\n\t\t\tscale up or down by modifying the service's desired count.

\n

You can't use an INACTIVE task definition to run new tasks or create new\n\t\t\tservices, and you can't update an existing service to reference an INACTIVE\n\t\t\ttask definition. However, there may be up to a 10-minute window following deregistration\n\t\t\twhere these restrictions have not yet taken effect.

\n \n

At this time, INACTIVE task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future. We\n\t\t\t\tdon't recommend that you rely on INACTIVE task definitions persisting\n\t\t\t\tbeyond the lifecycle of any associated tasks and services.

\n " } }, "com.amazonaws.ecs#DeregisterTaskDefinitionRequest": { @@ -5172,7 +5200,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n\t\t\t\tDescribeCapacityProviders request where maxResults was\n\t\t\tused and the results exceeded the value of that parameter. Pagination continues from the\n\t\t\tend of the previous results that returned the nextToken value.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n\t\t\t\tDescribeCapacityProviders request where maxResults was\n\t\t\tused and the results exceeded the value of that parameter. Pagination continues from the\n\t\t\tend of the previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } } } @@ -5235,7 +5263,7 @@ "include": { "target": "com.amazonaws.ecs#ClusterFieldList", "traits": { - "smithy.api#documentation": "

Determines whether to include additional information about the clusters in the\n\t\t\tresponse. If this field is omitted, this information isn't included.

\n\t\t

If ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included, for example the capacity providers.

\n\t\t

If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.

\n\t\t

If CONFIGURATIONS is specified, the configuration for the cluster is\n\t\t\tincluded.

\n\t\t

If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.

\n\t\t

If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.

" + "smithy.api#documentation": "

Determines whether to include additional information about the clusters in the\n\t\t\tresponse. If this field is omitted, this information isn't included.

\n

If ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included, for example the capacity providers.

\n

If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.

\n

If CONFIGURATIONS is specified, the configuration for the cluster is\n\t\t\tincluded.

\n

If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.

\n

If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.

" } } } @@ -5483,7 +5511,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a task definition. You can specify a family and\n\t\t\t\trevision to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE revision in that\n\t\t\tfamily.

\n\t\t \n\t\t\t

You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.

\n\t\t " + "smithy.api#documentation": "

Describes a task definition. You can specify a family and\n\t\t\t\trevision to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE revision in that\n\t\t\tfamily.

\n \n

You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.

\n " } }, "com.amazonaws.ecs#DescribeTaskDefinitionRequest": { @@ -5516,7 +5544,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that's applied to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that's applied to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n " } } } @@ -5630,7 +5658,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a specified task or tasks.

\n\t\t

Currently, stopped tasks appear in the returned results for at least one hour.

", + "smithy.api#documentation": "

Describes a specified task or tasks.

\n

Currently, stopped tasks appear in the returned results for at least one hour.

", "smithy.waiters#waitable": { "TasksRunning": { "acceptors": [ @@ -5828,7 +5856,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Returns an endpoint for the Amazon ECS agent to poll for updates.

" + "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Returns an endpoint for the Amazon ECS agent to poll for updates.

" } }, "com.amazonaws.ecs#DiscoverPollEndpointRequest": { @@ -5892,7 +5920,7 @@ "autoprovision": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If this value is true, the Docker volume is created if it doesn't already\n\t\t\texist.

\n\t\t \n\t\t\t

This field is only used if the scope is shared.

\n\t\t " + "smithy.api#documentation": "

If this value is true, the Docker volume is created if it doesn't already\n\t\t\texist.

\n \n

This field is only used if the scope is shared.

\n " } }, "driver": { @@ -5991,7 +6019,7 @@ "rootDirectory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The directory within the Amazon EFS file system to mount as the root directory inside the\n\t\t\thost. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n\t\t\tSpecifying / will have the same effect as omitting this parameter.

\n\t\t \n\t\t\t

If an EFS access point is specified in the authorizationConfig, the\n\t\t\t\troot directory parameter must either be omitted or set to / which will\n\t\t\t\tenforce the path set on the EFS access point.

\n\t\t " + "smithy.api#documentation": "

The directory within the Amazon EFS file system to mount as the root directory inside the\n\t\t\thost. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n\t\t\tSpecifying / will have the same effect as omitting this parameter.

\n \n

If an EFS access point is specified in the authorizationConfig, the\n\t\t\t\troot directory parameter must either be omitted or set to / which will\n\t\t\t\tenforce the path set on the EFS access point.

\n " } }, "transitEncryption": { @@ -6036,7 +6064,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n\t\t

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.

\n\t\t

This parameter is only supported for tasks hosted on Fargate using the\n\t\t\tfollowing platform versions:

\n\t\t " + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.

\n

This parameter is only supported for tasks hosted on Fargate using the\n\t\t\tfollowing platform versions:

\n " } }, "com.amazonaws.ecs#EnvironmentFileType": { @@ -6075,7 +6103,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\tLinux platform version 1.4.0 or later. This parameter is not supported\n\t\t\t\tfor Windows containers on Fargate.

\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 \n

This parameter is only supported for tasks hosted on Fargate using\n\t\t\t\tLinux platform version 1.4.0 or later. This parameter is not supported\n\t\t\t\tfor Windows containers on Fargate.

\n " } }, "com.amazonaws.ecs#ExecuteCommand": { @@ -6107,7 +6135,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs a command remotely on a container within a task.

\n\t\t

If you use a condition key in your IAM policy to refine the conditions for the policy\n\t\t\tstatement, for example limit the actions to a specific cluster, you receive an\n\t\t\t\tAccessDeniedException when there is a mismatch between the condition\n\t\t\tkey value and the corresponding parameter value.

" + "smithy.api#documentation": "

Runs a command remotely on a container within a task.

\n

If you use a condition key in your IAM policy to refine the conditions for the policy\n\t\t\tstatement, for example limit the actions to a specific cluster, you receive an\n\t\t\t\tAccessDeniedException when there is a mismatch between the condition\n\t\t\tkey value and the corresponding parameter value.

\n

For information about required permissions and considerations, see Using Amazon ECS Exec for\n\t\t\tdebugging in the Amazon ECS Developer Guide.

" } }, "com.amazonaws.ecs#ExecuteCommandConfiguration": { @@ -6122,7 +6150,7 @@ "logging": { "target": "com.amazonaws.ecs#ExecuteCommandLogging", "traits": { - "smithy.api#documentation": "

The log setting to use for redirecting logs for your execute command results. The\n\t\t\tfollowing log settings are available.

\n\t\t " + "smithy.api#documentation": "

The log setting to use for redirecting logs for your execute command results. The\n\t\t\tfollowing log settings are available.

\n " } }, "logConfiguration": { @@ -6142,7 +6170,7 @@ "cloudWatchLogGroupName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch log group to send logs to.

\n\t\t \n\t\t\t

The CloudWatch log group must already be created.

\n\t\t " + "smithy.api#documentation": "

The name of the CloudWatch log group to send logs to.

\n \n

The CloudWatch log group must already be created.

\n " } }, "cloudWatchEncryptionEnabled": { @@ -6155,7 +6183,7 @@ "s3BucketName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket to send logs to.

\n\t\t \n\t\t\t

The S3 bucket must already be created.

\n\t\t " + "smithy.api#documentation": "

The name of the S3 bucket to send logs to.

\n \n

The S3 bucket must already be created.

\n " } }, "s3EncryptionEnabled": { @@ -6299,7 +6327,7 @@ } }, "traits": { - "smithy.api#documentation": "

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API\n\t\t\t\tReference.

\n\t\t

For more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API\n\t\t\t\tReference.

\n

For more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration": { @@ -6328,7 +6356,7 @@ } }, "traits": { - "smithy.api#documentation": "

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.

\n\t\t

For more information and the input format, see Amazon FSx for Windows File Server volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.

\n

For more information and the input format, see Amazon FSx for Windows File Server volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#Failure": { @@ -6376,7 +6404,7 @@ "options": { "target": "com.amazonaws.ecs#FirelensConfigurationOptionsMap", "traits": { - "smithy.api#documentation": "

The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n\t\t\tFor more information, see Creating\n\t\t\t\ta task definition that uses a FireLens configuration in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

Tasks hosted on Fargate only support the file configuration file\n\t\t\t\ttype.

\n\t\t " + "smithy.api#documentation": "

The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n\t\t\tFor more information, see Creating\n\t\t\t\ta task definition that uses a FireLens configuration in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n \n

Tasks hosted on Fargate only support the file configuration file\n\t\t\t\ttype.

\n " } } }, @@ -6469,7 +6497,7 @@ "protectedTasks": { "target": "com.amazonaws.ecs#ProtectedTasks", "traits": { - "smithy.api#documentation": "

A list of tasks with the following information.

\n\t\t " + "smithy.api#documentation": "

A list of tasks with the following information.

\n " } }, "failures": { @@ -6492,7 +6520,7 @@ "command": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD to run the command arguments\n\t\t\tdirectly, or CMD-SHELL to run the command with the container's default\n\t\t\tshell.

\n\t\t

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list\n\t\t\tof commands in brackets.

\n\t\t

\n\t\t\t [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n\t\t

\n\t\t

You don't need to include the brackets when you use the Amazon Web Services Management Console.

\n\t\t

\n\t\t\t \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" \n\t\t

\n\t\t

An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the Create a container\n\t\t\tsection of the Docker Remote API.

", + "smithy.api#documentation": "

A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD to run the command arguments\n\t\t\tdirectly, or CMD-SHELL to run the command with the container's default\n\t\t\tshell.

\n

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list\n\t\t\tof commands in brackets.

\n

\n [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n

\n

You don't need to include the brackets when you use the Amazon Web Services Management Console.

\n

\n \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" \n

\n

An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the Create a container\n\t\t\tsection of the Docker Remote API.

", "smithy.api#required": {} } }, @@ -6517,12 +6545,12 @@ "startPeriod": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The optional grace period to provide containers time to bootstrap before failed health\n\t\t\tchecks count towards the maximum number of retries. You can specify between 0 and 300\n\t\t\tseconds. By default, the startPeriod is disabled.

\n\t\t \n\t\t\t

If a health check succeeds within the startPeriod, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.

\n\t\t " + "smithy.api#documentation": "

The optional grace period to provide containers time to bootstrap before failed health\n\t\t\tchecks count towards the maximum number of retries. You can specify between 0 and 300\n\t\t\tseconds. By default, the startPeriod is disabled.

\n \n

If a health check succeeds within the startPeriod, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.

\n " } } }, "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 \n\t\t\t

The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.

\n\t\t \n\t\t

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n\t\t

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n\t\t \n\t\t

The following describes the possible healthStatus values for a task. The\n\t\t\tcontainer health check status of nonessential containers only affects the health status\n\t\t\tof a task if no essential containers have health checks defined.

\n\t\t \n\t\t

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n\t\t \n\t\t\t

For tasks that are a part of a service and the service uses the ECS\n\t\t\t\trolling deployment type, the deployment is paused while the new tasks have the\n\t\t\t\t\tUNKNOWN task health check status. For example, tasks that define\n\t\t\t\thealth checks for nonessential containers when no essential containers have health\n\t\t\t\tchecks will have the UNKNOWN health check status indefinitely which\n\t\t\t\tprevents the deployment from completing.

\n\t\t \n\t\t

The following are notes about container health check support:

\n\t\t " + "smithy.api#documentation": "

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).

\n \n

The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.

\n \n

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

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n \n

The following describes the possible healthStatus values for a task. The\n\t\t\tcontainer health check status of nonessential containers only affects the health status\n\t\t\tof a task if no essential containers have health checks defined.

\n \n

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 \n

For tasks that are a part of a service and the service uses the ECS\n\t\t\t\trolling deployment type, the deployment is paused while the new tasks have the\n\t\t\t\t\tUNKNOWN task health check status. For example, tasks that define\n\t\t\t\thealth checks for nonessential containers when no essential containers have health\n\t\t\t\tchecks will have the UNKNOWN health check status indefinitely which\n\t\t\t\tprevents the deployment from completing.

\n \n

The following are notes about container health check support:

\n " } }, "com.amazonaws.ecs#HealthStatus": { @@ -6582,7 +6610,7 @@ "sourcePath": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

When the host parameter is used, specify a sourcePath to\n\t\t\tdeclare the path on the host container instance that's presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost parameter contains a sourcePath file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath value doesn't exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.

\n\t\t

If you're using the Fargate launch type, the sourcePath\n\t\t\tparameter is not supported.

" + "smithy.api#documentation": "

When the host parameter is used, specify a sourcePath to\n\t\t\tdeclare the path on the host container instance that's presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost parameter contains a sourcePath file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath value doesn't exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.

\n

If you're using the Fargate launch type, the sourcePath\n\t\t\tparameter is not supported.

" } } }, @@ -6769,13 +6797,13 @@ "add": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that have been added to the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapAdd in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--cap-add option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

Tasks launched on Fargate only support adding the SYS_PTRACE kernel\n\t\t\t\tcapability.

\n\t\t \n\t\t

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n

" + "smithy.api#documentation": "

The Linux capabilities for the container that have been added to the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapAdd in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--cap-add option to docker\n\t\t\t\trun.

\n \n

Tasks launched on Fargate only support adding the SYS_PTRACE kernel\n\t\t\t\tcapability.

\n \n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n

" } }, "drop": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that have been removed from the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapDrop in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--cap-drop option to docker\n\t\t\t\trun.

\n\t\t

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n

" + "smithy.api#documentation": "

The Linux capabilities for the container that have been removed from the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapDrop in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--cap-drop option to docker\n\t\t\t\trun.

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"\n

" } } }, @@ -6844,13 +6872,13 @@ "capabilities": { "target": "com.amazonaws.ecs#KernelCapabilities", "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker.

\n\t\t \n\t\t\t

For tasks that use the Fargate launch type,\n\t\t\t\t\tcapabilities is supported for all platform versions but the\n\t\t\t\t\tadd parameter is only supported if using platform version 1.4.0 or\n\t\t\t\tlater.

\n\t\t " + "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker.

\n \n

For tasks that use the Fargate launch type,\n\t\t\t\t\tcapabilities is supported for all platform versions but the\n\t\t\t\t\tadd parameter is only supported if using platform version 1.4.0 or\n\t\t\t\tlater.

\n " } }, "devices": { "target": "com.amazonaws.ecs#DevicesList", "traits": { - "smithy.api#documentation": "

Any host devices to expose to the container. This parameter maps to\n\t\t\t\tDevices in the Create a container section of the\n\t\t\tDocker Remote API and the --device option to docker run.

\n\t\t \n\t\t\t

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices parameter isn't supported.

\n\t\t " + "smithy.api#documentation": "

Any host devices to expose to the container. This parameter maps to\n\t\t\t\tDevices in the Create a container section of the\n\t\t\tDocker Remote API and the --device option to docker run.

\n \n

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices parameter isn't supported.

\n " } }, "initProcessEnabled": { @@ -6862,25 +6890,25 @@ "sharedMemorySize": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The value for the size (in MiB) of the /dev/shm volume. This parameter\n\t\t\tmaps to the --shm-size option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tsharedMemorySize parameter is not supported.

\n\t\t " + "smithy.api#documentation": "

The value for the size (in MiB) of the /dev/shm volume. This parameter\n\t\t\tmaps to the --shm-size option to docker\n\t\t\t\trun.

\n \n

If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tsharedMemorySize parameter is not supported.

\n " } }, "tmpfs": { "target": "com.amazonaws.ecs#TmpfsList", "traits": { - "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs option to docker run.

\n\t\t \n\t\t\t

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs parameter isn't supported.

\n\t\t " + "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs option to docker run.

\n \n

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs parameter isn't supported.

\n " } }, "maxSwap": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap option to docker run where the value would be the sum of\n\t\t\tthe container memory plus the maxSwap value.

\n\t\t

If a maxSwap value of 0 is specified, the container will not\n\t\t\tuse swap. Accepted values are 0 or any positive integer. If the\n\t\t\t\tmaxSwap parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap value\n\t\t\tmust be set for the swappiness parameter to be used.

\n\t\t \n\t\t\t

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap parameter isn't supported.

\n\t\t " + "smithy.api#documentation": "

The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap option to docker run where the value would be the sum of\n\t\t\tthe container memory plus the maxSwap value.

\n

If a maxSwap value of 0 is specified, the container will not\n\t\t\tuse swap. Accepted values are 0 or any positive integer. If the\n\t\t\t\tmaxSwap parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap value\n\t\t\tmust be set for the swappiness parameter to be used.

\n \n

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap parameter isn't supported.

\n " } }, "swappiness": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness value of 0 will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness value of 100 will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0 and 100. If the swappiness parameter is not\n\t\t\tspecified, a default value of 60 is used. If a value is not specified for\n\t\t\t\tmaxSwap then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness option to docker run.

\n\t\t \n\t\t\t

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness parameter isn't supported.

\n\t\t " + "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness value of 0 will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness value of 100 will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0 and 100. If the swappiness parameter is not\n\t\t\tspecified, a default value of 60 is used. If a value is not specified for\n\t\t\t\tmaxSwap then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness option to docker run.

\n \n

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness parameter isn't supported.

\n " } } }, @@ -6935,7 +6963,7 @@ "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tthis field is omitted, the account settings are listed only for the authenticated\n\t\t\tuser.

\n\t\t \n\t\t\t

Federated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.

\n\t\t " + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tthis field is omitted, the account settings are listed only for the authenticated\n\t\t\tuser.

\n \n

Federated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.

\n " } }, "effectiveSettings": { @@ -6948,7 +6976,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListAccountSettings\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it's possible the number\n\t\t\tof results to be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a ListAccountSettings\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it's possible the number\n\t\t\tof results to be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { @@ -7034,7 +7062,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListAttributes request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a ListAttributes request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { @@ -7097,7 +7125,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListClusters request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a ListClusters request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { @@ -7175,7 +7203,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListContainerInstances\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls are needed. If maxResults was provided, it's possible the number of\n\t\t\tresults to be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a ListContainerInstances\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls are needed. If maxResults was provided, it's possible the number of\n\t\t\tresults to be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { @@ -7279,7 +7307,7 @@ "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

\n\t\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

", + "smithy.api#documentation": "

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

", "smithy.api#required": {} } }, @@ -7326,7 +7354,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListServices request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a ListServices request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { @@ -7435,7 +7463,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of task definition families that are registered to your account. This\n\t\t\tlist includes task definition families that no longer have any ACTIVE task\n\t\t\tdefinition revisions.

\n\t\t

You can filter out task definition families that don't contain any ACTIVE\n\t\t\ttask definition revisions by setting the status parameter to\n\t\t\t\tACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.

", + "smithy.api#documentation": "

Returns a list of task definition families that are registered to your account. This\n\t\t\tlist includes task definition families that no longer have any ACTIVE task\n\t\t\tdefinition revisions.

\n

You can filter out task definition families that don't contain any ACTIVE\n\t\t\ttask definition revisions by setting the status parameter to\n\t\t\t\tACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -7462,7 +7490,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a\n\t\t\t\tListTaskDefinitionFamilies request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a\n\t\t\t\tListTaskDefinitionFamilies request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { @@ -7543,7 +7571,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListTaskDefinitions\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a ListTaskDefinitions\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { @@ -7597,7 +7625,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of tasks. You can filter the results by cluster, task definition\n\t\t\tfamily, container instance, launch type, what IAM principal started the task, or by the\n\t\t\tdesired status of the task.

\n\t\t

Recently stopped tasks might appear in the returned results. Currently, stopped tasks\n\t\t\tappear in the returned results for at least one hour.

", + "smithy.api#documentation": "

Returns a list of tasks. You can filter the results by cluster, task definition\n\t\t\tfamily, container instance, launch type, what IAM principal started the task, or by the\n\t\t\tdesired status of the task.

\n

Recently stopped tasks might appear in the returned results. Currently, stopped tasks\n\t\t\tappear in the returned results for at least one hour.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -7630,7 +7658,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListTasks request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it's possible the number of results\n\t\t\tto be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a ListTasks request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it's possible the number of results\n\t\t\tto be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { @@ -7642,7 +7670,7 @@ "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The startedBy value to filter the task results with. Specifying a\n\t\t\t\tstartedBy value limits the results to tasks that were started with that\n\t\t\tvalue.

\n\t\t

When you specify startedBy as the filter, it must be the only filter that\n\t\t\tyou use.

" + "smithy.api#documentation": "

The startedBy value to filter the task results with. Specifying a\n\t\t\t\tstartedBy value limits the results to tasks that were started with that\n\t\t\tvalue.

\n

When you specify startedBy as the filter, it must be the only filter that\n\t\t\tyou use.

" } }, "serviceName": { @@ -7654,7 +7682,7 @@ "desiredStatus": { "target": "com.amazonaws.ecs#DesiredStatus", "traits": { - "smithy.api#documentation": "

The task desired status to use when filtering the ListTasks results.\n\t\t\tSpecifying a desiredStatus of STOPPED limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n\t\t\tfor debugging tasks that aren't starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING.

\n\t\t \n\t\t\t

Although you can filter results based on a desired status of PENDING,\n\t\t\t\tthis doesn't return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus may have a value of\n\t\t\t\t\tPENDING).

\n\t\t " + "smithy.api#documentation": "

The task desired status to use when filtering the ListTasks results.\n\t\t\tSpecifying a desiredStatus of STOPPED limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n\t\t\tfor debugging tasks that aren't starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING.

\n \n

Although you can filter results based on a desired status of PENDING,\n\t\t\t\tthis doesn't return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus may have a value of\n\t\t\t\t\tPENDING).

\n " } }, "launchType": { @@ -7688,13 +7716,13 @@ "targetGroupArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.

\n\t\t

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a\n\t\t\tClassic Load Balancer, omit the target group ARN.

\n\t\t

For services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.

\n\t\t

For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.

\n\t\t " + "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.

\n

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a\n\t\t\tClassic Load Balancer, omit the target group ARN.

\n

For services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.

\n

For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n \n

If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.

\n " } }, "loadBalancerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the load balancer to associate with the Amazon ECS service or task set.

\n\t\t

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer\n\t\t\tor a Network Load Balancer the load balancer name parameter should be omitted.

" + "smithy.api#documentation": "

The name of the load balancer to associate with the Amazon ECS service or task set.

\n

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer\n\t\t\tor a Network Load Balancer the load balancer name parameter should be omitted.

" } }, "containerName": { @@ -7711,7 +7739,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.

\n\t\t

When you add, update, or remove a load balancer 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 Using\n\t\t\t\tservice-linked roles in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The load balancer configuration to use with a service or task set.

\n

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

When you add, update, or remove a load balancer 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

We recommend that you verify this on a test environment before you update the Elastic Load Balancing\n\t\t\tconfiguration.

\n

A service-linked role is required for services that use multiple target groups. For\n\t\t\tmore information, see Using\n\t\t\t\tservice-linked roles in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#LoadBalancers": { @@ -7726,14 +7754,14 @@ "logDriver": { "target": "com.amazonaws.ecs#LogDriver", "traits": { - "smithy.api#documentation": "

The log driver to use for the container.

\n\t\t

For tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\tsplunk, and awsfirelens.

\n\t\t

For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\tjson-file, journald,\n\t\t\t\tlogentries,syslog, splunk, and\n\t\t\t\tawsfirelens.

\n\t\t

For more information about using the awslogs log driver, see Using\n\t\t\t\tthe awslogs log driver in the Amazon Elastic Container Service Developer Guide.

\n\t\t

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If you have a custom driver that isn't listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that's available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdon't currently provide support for running modified copies of this software.

\n\t\t ", + "smithy.api#documentation": "

The log driver to use for the container.

\n

For tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\tsplunk, and awsfirelens.

\n

For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\tjson-file, journald,\n\t\t\t\tlogentries,syslog, splunk, and\n\t\t\t\tawsfirelens.

\n

For more information about using the awslogs log driver, see Using\n\t\t\t\tthe awslogs log driver in the Amazon Elastic Container Service Developer Guide.

\n

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

\n \n

If you have a custom driver that isn't listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that's available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdon't currently provide support for running modified copies of this software.

\n ", "smithy.api#required": {} } }, "options": { "target": "com.amazonaws.ecs#LogConfigurationOptionsMap", "traits": { - "smithy.api#documentation": "

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

" + "smithy.api#documentation": "

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

" } }, "secretOptions": { @@ -7744,7 +7772,7 @@ } }, "traits": { - "smithy.api#documentation": "

The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to \n docker\n\t\t\t\t\trun\n .

\n\t\t

By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\tabout the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.

\n\t\t

Understand the following when specifying a log configuration for your\n\t\t\tcontainers.

\n\t\t " + "smithy.api#documentation": "

The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to \n docker\n\t\t\t\t\trun\n .

\n

By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\tabout the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.

\n

Understand the following when specifying a log configuration for your\n\t\t\tcontainers.

\n " } }, "com.amazonaws.ecs#LogConfigurationOptionsMap": { @@ -7923,7 +7951,7 @@ "minimumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.

\n\t\t

When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.

\n\t\t

If you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.

" + "smithy.api#documentation": "

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.

\n

When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.

\n

If you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.

" } }, "maximumScalingStepSize": { @@ -7940,7 +7968,7 @@ } }, "traits": { - "smithy.api#documentation": "

The managed scaling settings for the Auto Scaling group capacity provider.

\n\t\t

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.

" + "smithy.api#documentation": "

The managed scaling settings for the Auto Scaling group capacity provider.

\n

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

\n

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.

" } }, "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod": { @@ -8086,6 +8114,18 @@ "traits": { "smithy.api#documentation": "

The protocol used for the network binding.

" } + }, + "containerPortRange": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The port number range on the container that's bound to the dynamically mapped host port range.

\n

The following rules apply when you specify a containerPortRange:

\n \n

You can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.

" + } + }, + "hostPortRange": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The port number range on the host that's used with the network binding. This is assigned is\n\t\t\tassigned by Docker and delivered by the Amazon ECS agent.

" + } } }, "traits": { @@ -8104,7 +8144,7 @@ "awsvpcConfiguration": { "target": "com.amazonaws.ecs#AwsVpcConfiguration", "traits": { - "smithy.api#documentation": "

The VPC subnets and security groups that are associated with a task.

\n\t\t \n\t\t\t

All specified subnets and security groups must be from the same VPC.

\n\t\t " + "smithy.api#documentation": "

The VPC subnets and security groups that are associated with a task.

\n \n

All specified subnets and security groups must be from the same VPC.

\n " } } }, @@ -8272,7 +8312,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If you're using the Fargate launch type, task placement constraints\n\t\t\t\taren't supported.

\n\t\t " + "smithy.api#documentation": "

An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n \n

If you're using the Fargate launch type, task placement constraints\n\t\t\t\taren't supported.

\n " } }, "com.amazonaws.ecs#PlacementConstraintType": { @@ -8416,13 +8456,13 @@ "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the container that's bound to the user-specified or automatically\n\t\t\tassigned host port.

\n\t\t

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort.

\n\t\t

If you use containers in a task with the bridge network mode and you\n\t\t\tspecify a container port and not a host port, your container automatically receives a\n\t\t\thost port in the ephemeral port range. For more information, see hostPort.\n\t\t\tPort mappings that are automatically assigned in this way do not count toward the 100\n\t\t\treserved ports limit of a container instance.

" + "smithy.api#documentation": "

The port number on the container that's bound to the user-specified or automatically\n\t\t\tassigned host port.

\n

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort.

\n

If you use containers in a task with the bridge network mode and you\n\t\t\tspecify a container port and not a host port, your container automatically receives a\n\t\t\thost port in the ephemeral port range. For more information, see hostPort.\n\t\t\tPort mappings that are automatically assigned in this way do not count toward the 100\n\t\t\treserved ports limit of a container instance.

" } }, "hostPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the container instance to reserve for your container.

\n\t\t

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.

\n\t\t

If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.

\n\t\t

The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.

\n\t\t

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\t\tremainingResources of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time. This number\n\t\t\tincludes the default reserved ports. Automatically assigned ports aren't included in the\n\t\t\t100 reserved ports quota.

" + "smithy.api#documentation": "

The port number on the container instance to reserve for your container.

\n

If you specify a containerPortRange, leave this field empty and the value of\n\t\t\tthe hostPort is set as follows:

\n \n

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.

\n

If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.

\n

The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.

\n

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\t\tremainingResources of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time. This number\n\t\t\tincludes the default reserved ports. Automatically assigned ports aren't included in the\n\t\t\t100 reserved ports quota.

" } }, "protocol": { @@ -8434,18 +8474,24 @@ "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name that's used for the port mapping. This parameter only applies to\n\t\t\tService Connect. This parameter is the name that you use in the\n\t\t\t\tserviceConnectConfiguration of a service. The name can include up to 64\n\t\t\tcharacters. The characters can include lowercase letters, numbers, underscores (_), and\n\t\t\thyphens (-). The name can't start with a hyphen.

\n\t\t

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The name that's used for the port mapping. This parameter only applies to\n\t\t\tService Connect. This parameter is the name that you use in the\n\t\t\t\tserviceConnectConfiguration of a service. The name can include up to 64\n\t\t\tcharacters. The characters can include lowercase letters, numbers, underscores (_), and\n\t\t\thyphens (-). The name can't start with a hyphen.

\n

For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } }, "appProtocol": { "target": "com.amazonaws.ecs#ApplicationProtocol", "traits": { - "smithy.api#documentation": "

The application protocol that's used for the port mapping. This parameter only applies\n\t\t\tto Service Connect. We recommend that you set this parameter to be consistent with the\n\t\t\tprotocol that your application uses. If you set this parameter, Amazon ECS adds\n\t\t\tprotocol-specific connection handling to the Service Connect proxy. If you set this\n\t\t\tparameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

\n\t\t

If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't\n\t\t\tadd protocol-specific telemetry for TCP.

\n\t\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The application protocol that's used for the port mapping. This parameter only applies\n\t\t\tto Service Connect. We recommend that you set this parameter to be consistent with the\n\t\t\tprotocol that your application uses. If you set this parameter, Amazon ECS adds\n\t\t\tprotocol-specific connection handling to the Service Connect proxy. If you set this\n\t\t\tparameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.

\n

If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't\n\t\t\tadd protocol-specific telemetry for TCP.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "containerPortRange": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

The port number range on the container that's bound to the dynamically mapped host port range.

\n

The following rules apply when you specify a containerPortRange:

\n \n

You can call \n DescribeTasks\n to view the hostPortRange which\n\t\t\tare the host ports that are bound to the container ports.

" } } }, "traits": { - "smithy.api#documentation": "

Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.

\n\t\t

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort. The\n\t\t\t\thostPort can be left blank or it must be the same value as the\n\t\t\t\tcontainerPort.

\n\t\t \n\t\t\t

You can't expose the same container port for multiple protocols. If you attempt\n\t\t\t\tthis, an error is returned.

\n\t\t \n\t\t

After a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\t\tDescribeTasks API responses.

" + "smithy.api#documentation": "

Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.

\n

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort. The\n\t\t\t\thostPort can be left blank or it must be the same value as the\n\t\t\t\tcontainerPort.

\n \n

You can't expose the same container port for multiple protocols. If you attempt\n\t\t\t\tthis, an error is returned.

\n \n

After a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\t\tDescribeTasks API responses.

" } }, "com.amazonaws.ecs#PortMappingList": { @@ -8538,12 +8584,12 @@ "properties": { "target": "com.amazonaws.ecs#ProxyConfigurationProperties", "traits": { - "smithy.api#documentation": "

The set of network configuration parameters to provide the Container Network Interface\n\t\t\t(CNI) plugin, specified as key-value pairs.

\n\t\t " + "smithy.api#documentation": "

The set of network configuration parameters to provide the Container Network Interface\n\t\t\t(CNI) plugin, specified as key-value pairs.

\n " } } }, "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 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

" + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n

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

" } }, "com.amazonaws.ecs#ProxyConfigurationProperties": { @@ -8583,7 +8629,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\n\t\t\tis defined by the opt-in status of the IAM user or role that created the resource. You\n\t\t\tmust turn 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.

" + "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n

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

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\n\t\t\tis defined by the opt-in status of the IAM user or role that created the resource. You\n\t\t\tmust turn on this setting to use Amazon ECS features such as resource tagging.

\n

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

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": { @@ -8615,7 +8661,7 @@ "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "

The resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If containerInsights is specified, the default\n\t\t\tsetting for CloudWatch Container Insights for your clusters is affected.

\n\t\t

Fargate is transitioning from task count-based quotas to vCPU-based quotas. You can\n\t\t\tset the name to fargateVCPULimit to opt in or opt out of the vCPU-based\n\t\t\tquotas. For information about the opt in timeline, see Fargate vCPU-based quotas timeline in the\n\t\t\t\tAmazon ECS Developer Guide.

", + "smithy.api#documentation": "

The resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If containerInsights is specified, the default\n\t\t\tsetting for CloudWatch Container Insights for your clusters is affected.

\n

Fargate is transitioning from task count-based quotas to vCPU-based quotas. You can\n\t\t\tset the name to fargateVCPULimit to opt in or opt out of the vCPU-based\n\t\t\tquotas. For information about the opt in timeline, see Fargate vCPU-based quotas timeline in the\n\t\t\t\tAmazon ECS Developer Guide.

", "smithy.api#required": {} } }, @@ -8659,7 +8705,7 @@ "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tyou specify the root user, it modifies the account setting for all IAM users, IAM roles,\n\t\t\tand the root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.

\n\t\t \n\t\t\t

Federated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.

\n\t\t " + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tyou specify the root user, it modifies the account setting for all IAM users, IAM roles,\n\t\t\tand the root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.

\n \n

Federated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.

\n " } } } @@ -8759,7 +8805,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.

\n\t\t

You must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers that are associated with a\n\t\t\tcluster that are omitted from a PutClusterCapacityProviders API call\n\t\t\twill be disassociated with the cluster. You can only disassociate an existing capacity\n\t\t\tprovider from a cluster if it's not being used by any existing tasks.

\n\t\t

When creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tWe recommend that you define a default capacity provider strategy for your cluster.\n\t\t\tHowever, you must specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.

" + "smithy.api#documentation": "

Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.

\n

You must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers that are associated with a\n\t\t\tcluster that are omitted from a PutClusterCapacityProviders API call\n\t\t\twill be disassociated with the cluster. You can only disassociate an existing capacity\n\t\t\tprovider from a cluster if it's not being used by any existing tasks.

\n

When creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tWe recommend that you define a default capacity provider strategy for your cluster.\n\t\t\tHowever, you must specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.

" } }, "com.amazonaws.ecs#PutClusterCapacityProvidersRequest": { @@ -8775,14 +8821,14 @@ "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The name of one or more capacity providers to associate with the cluster.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

", + "smithy.api#documentation": "

The name of one or more capacity providers to associate with the cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

", "smithy.api#required": {} } }, "defaultCapacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use by default for the cluster.

\n\t\t

When creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified then the default capacity provider strategy for the cluster is\n\t\t\tused.

\n\t\t

A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

", + "smithy.api#documentation": "

The capacity provider strategy to use by default for the cluster.

\n

When creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified then the default capacity provider strategy for the cluster is\n\t\t\tused.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

", "smithy.api#required": {} } } @@ -8819,7 +8865,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Registers an EC2 instance into the specified cluster. This instance becomes available\n\t\t\tto place containers on.

" + "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Registers an EC2 instance into the specified cluster. This instance becomes available\n\t\t\tto place containers on.

" } }, "com.amazonaws.ecs#RegisterContainerInstanceRequest": { @@ -8834,13 +8880,13 @@ "instanceIdentityDocument": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The instance identity document for the EC2 instance to register. This document can be\n\t\t\tfound by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/\n\t\t

" + "smithy.api#documentation": "

The instance identity document for the EC2 instance to register. This document can be\n\t\t\tfound by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/\n

" } }, "instanceIdentityDocumentSignature": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The instance identity document signature for the EC2 instance to register. This\n\t\t\tsignature can be found by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/\n\t\t

" + "smithy.api#documentation": "

The instance identity document signature for the EC2 instance to register. This\n\t\t\tsignature can be found by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/\n

" } }, "totalResources": { @@ -8876,7 +8922,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n " } } } @@ -8912,7 +8958,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.

\n\t\t

You can specify an IAM role for your task with the taskRoleArn parameter.\n\t\t\tWhen you specify an IAM role for a task, its containers can then use the latest versions\n\t\t\tof the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in\n\t\t\tthe IAM policy that's associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.

\n\t\t

You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.

\n

You can specify an IAM role for your task with the taskRoleArn parameter.\n\t\t\tWhen you specify an IAM role for a task, its containers can then use the latest versions\n\t\t\tof the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in\n\t\t\tthe IAM policy that's associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.

\n

You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#RegisterTaskDefinitionRequest": { @@ -8940,7 +8986,7 @@ "networkMode": { "target": "com.amazonaws.ecs#NetworkMode", "traits": { - "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.

\n

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, or awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.

\n

With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.

\n \n

When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.

\n \n

If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.

\n

If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.

\n

For more information, see Network\n settings in the Docker run reference.

" + "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.

\n

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, or awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.

\n

With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.

\n \n

When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.

\n \n

If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.

\n

If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.

\n

For more information, see Network\n settings in the Docker run reference.

" } }, "containerDefinitions": { @@ -8971,37 +9017,37 @@ "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, 1024) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU or 1 vcpu) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.

\n\t\t \n\t\t\t

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n\t\t \n\t\t

If you're using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128 CPU units (0.125 vCPUs) and\n\t\t\t\t10240 CPU units (10 vCPUs). If you do not specify a value,\n\t\t\tthe parameter is ignored.

\n\t\t

If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:

\n\t\t

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n\t\t " + "smithy.api#documentation": "

The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, 1024) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU or 1 vcpu) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.

\n \n

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n \n

If you're using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128 CPU units (0.125 vCPUs) and\n\t\t\t\t10240 CPU units (10 vCPUs). If you do not specify a value,\n\t\t\tthe parameter is ignored.

\n

If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:

\n

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n " } }, "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB (for example ,1024) or as a string using GB (for example,\n\t\t\t\t1GB or 1 GB) in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.

\n\t\t \n\t\t\t

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n\t\t \n\t\t

If using the EC2 launch type, this field is optional.

\n\t\t

If using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values. This determines your range of supported values for the\n\t\t\t\tcpu parameter.

\n\t\t

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n\t\t " + "smithy.api#documentation": "

The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB (for example ,1024) or as a string using GB (for example,\n\t\t\t\t1GB or 1 GB) in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.

\n \n

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n \n

If using the EC2 launch type, this field is optional.

\n

If using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values. This determines your range of supported values for the\n\t\t\t\tcpu parameter.

\n

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n " } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both of them.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both of them.

\n

The following basic restrictions apply to tags:

\n " } }, "pidMode": { "target": "com.amazonaws.ecs#PidMode", "traits": { - "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid\n values are host or task. If host\n is specified, then all containers within the tasks that specified the\n host PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.

\n

If the host PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.

\n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " + "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid\n values are host or task. If host\n is specified, then all containers within the tasks that specified the\n host PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.

\n

If the host PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.

\n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " } }, "ipcMode": { "target": "com.amazonaws.ecs#IpcMode", "traits": { - "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.

\n

If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.

\n

If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.

\n \n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " + "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.

\n

If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.

\n

If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.

\n \n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " } }, "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 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 Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n

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 Amazon Elastic Container Service Developer Guide.

" } }, "inferenceAccelerators": { @@ -9013,13 +9059,13 @@ "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "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\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 \n

This parameter is only supported for tasks hosted on Fargate using\n\t\t\t\tthe following platform versions:

\n \n " } }, "runtimePlatform": { "target": "com.amazonaws.ecs#RuntimePlatform", "traits": { - "smithy.api#documentation": "

The operating system that your tasks definitions run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n\t\t

When you specify a task definition in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.

" + "smithy.api#documentation": "

The operating system that your tasks definitions run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n

When you specify a task definition in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.

" } } } @@ -9047,7 +9093,7 @@ "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.

\n\t\t \n\t\t\t

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same\n\t\t\t\tRegion as the task that you're launching then you can use either the full ARN or\n\t\t\t\tthe name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN\n\t\t\t\tof the secret.

\n\t\t ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.

\n \n

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same\n\t\t\t\tRegion as the task that you're launching then you can use either the full ARN or\n\t\t\t\tthe name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN\n\t\t\t\tof the secret.

\n ", "smithy.api#required": {} } } @@ -9139,7 +9185,7 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value for the specified resource type.

\n\t\t

If the GPU type is used, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.

\n\t\t

If the InferenceAccelerator type is used, the value matches\n\t\t\tthe deviceName for an InferenceAccelerator specified in a\n\t\t\ttask definition.

", + "smithy.api#documentation": "

The value for the specified resource type.

\n

If the GPU type is used, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.

\n

If the InferenceAccelerator type is used, the value matches\n\t\t\tthe deviceName for an InferenceAccelerator specified in a\n\t\t\ttask definition.

", "smithy.api#required": {} } }, @@ -9222,7 +9268,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new task using the specified task definition.

\n\t\t

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n\t\t

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n\t\t

The Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.

\n\t\t

To manage eventual consistency, you can do the following:

\n\t\t " + "smithy.api#documentation": "

Starts a new task using the specified task definition.

\n

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n

The Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.

\n

To manage eventual consistency, you can do the following:

\n " } }, "com.amazonaws.ecs#RunTaskRequest": { @@ -9231,7 +9277,7 @@ "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n\t\t

When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.

\n\t\t

A capacity provider strategy may contain a maximum of 6 capacity providers.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n

When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "cluster": { @@ -9257,7 +9303,7 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Determines whether to use the execute command functionality for the containers in this\n\t\t\ttask. If true, this enables execute command functionality on all containers\n\t\t\tin 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.

" + "smithy.api#documentation": "

Determines whether to use the execute command functionality for the containers in this\n\t\t\ttask. If true, this enables execute command functionality on all containers\n\t\t\tin the task.

\n

If true, then the task definition must have a task role, or you must\n\t\t\tprovide one as an override.

" } }, "group": { @@ -9269,7 +9315,7 @@ "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The infrastructure to run your standalone task on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n\t\t \n\t\t\t

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n\t\t \n\t\t

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n\t\t

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n\t\t

A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

\n\t\t

When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.

" + "smithy.api#documentation": "

The infrastructure to run your standalone task on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n \n

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n \n

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n

A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

\n

When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.

" } }, "networkConfiguration": { @@ -9281,7 +9327,7 @@ "overrides": { "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.

\n\t\t

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.

" + "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.

\n

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.

" } }, "placementConstraints": { @@ -9305,7 +9351,7 @@ "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "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.

\n\t\t \n\t\t\t

An error will be received if you specify the SERVICE option when\n\t\t\t\trunning a task.

\n\t\t " + "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.

\n \n

An error will be received if you specify the SERVICE option when\n\t\t\t\trunning a task.

\n " } }, "referenceId": { @@ -9317,19 +9363,19 @@ "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens (-), and underscores (_) are allowed.

\n\t\t

If a task is started by an Amazon ECS service, then the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" + "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens (-), and underscores (_) are allowed.

\n

If a task is started by an Amazon ECS service, then the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } }, "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

When you create an IAM policy for run-task, you can set the resource to be the latest\n\t\t\ttask definition revision, or a specific revision.

\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.

\n\t\t

When you specify the policy resource as the latest task definition version (by setting\n\t\t\tthe Resource 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\n\t\t\tthe Resource 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 developer Guide.

", + "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

When you create an IAM policy for run-task, you can set the resource to be the latest\n\t\t\ttask definition revision, or a specific revision.

\n

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.

\n

When you specify the policy resource as the latest task definition version (by setting\n\t\t\tthe Resource 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

When you specify the policy resource as a specific task definition version (by setting\n\t\t\tthe Resource 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

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.

", "smithy.api#required": {} } } @@ -9358,7 +9404,7 @@ "cpuArchitecture": { "target": "com.amazonaws.ecs#CPUArchitecture", "traits": { - "smithy.api#documentation": "

The CPU architecture.

\n\t\t

You can run your Linux tasks on an ARM-based platform by setting the value to\n\t\t\t\tARM64. This option is available for tasks that run on Linux Amazon EC2\n\t\t\tinstance or Linux containers on Fargate.

" + "smithy.api#documentation": "

The CPU architecture.

\n

You can run your Linux tasks on an ARM-based platform by setting the value to\n\t\t\t\tARM64. This option is available for tasks that run on Linux Amazon EC2\n\t\t\tinstance or Linux containers on Fargate.

" } }, "operatingSystemFamily": { @@ -9369,7 +9415,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the platform for the Amazon ECS service or task.

\n\t\t

For more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Information about the platform for the Amazon ECS service or task.

\n

For more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#Scale": { @@ -9451,13 +9497,13 @@ "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\n\t\t\tof the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter\n\t\t\tStore.

\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\n\t\t\tstore) 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.\n\t\t\t\tIf the 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\n\t\t\tof the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter\n\t\t\tStore.

\n

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\n\t\t\tstore) in the Amazon Elastic Container Service Developer Guide.

\n \n

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.\n\t\t\t\tIf the parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

An object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:

\n\t\t \n\t\t

For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

An object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:

\n \n

For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#SecretList": { @@ -9565,7 +9611,7 @@ "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The operating system that your tasks in the service run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX).

" + "smithy.api#documentation": "

The operating system that your tasks in the service run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX).

" } }, "taskDefinition": { @@ -9637,7 +9683,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 " + "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n

There are two service scheduler strategies available.

\n " } }, "deploymentController": { @@ -9649,7 +9695,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define bot the key and\n\t\t\tvalue.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define bot the key and\n\t\t\tvalue.

\n

The following basic restrictions apply to tags:

\n " } }, "createdBy": { @@ -9689,19 +9735,19 @@ "port": { "target": "com.amazonaws.ecs#PortNumber", "traits": { - "smithy.api#documentation": "

The listening port number for the Service Connect proxy. This port is available\n\t\t\tinside of all of the tasks within the same namespace.

\n\t\t

To avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tport that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

", + "smithy.api#documentation": "

The listening port number for the Service Connect proxy. This port is available\n\t\t\tinside of all of the tasks within the same namespace.

\n

To avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tport that the client application uses by default. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

", "smithy.api#required": {} } }, "dnsName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The dnsName is the name that you use in the applications of client tasks\n\t\t\tto connect to this service. The name must be a valid DNS name but doesn't need to be\n\t\t\tfully-qualified. The name can include up to 127 characters. The name can include\n\t\t\tlowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name\n\t\t\tcan't start with a hyphen.

\n\t\t

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

\n\t\t

To avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tname that the client application uses by default. For example, a few common names are\n\t\t\t\tdatabase, db, or the lowercase name of a database, such as\n\t\t\t\tmysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The dnsName is the name that you use in the applications of client tasks\n\t\t\tto connect to this service. The name must be a valid DNS name but doesn't need to be\n\t\t\tfully-qualified. The name can include up to 127 characters. The name can include\n\t\t\tlowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name\n\t\t\tcan't start with a hyphen.

\n

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

\n

To avoid changing your applications in client Amazon ECS services, set this to the same\n\t\t\tname that the client application uses by default. For example, a few common names are\n\t\t\t\tdatabase, db, or the lowercase name of a database, such as\n\t\t\t\tmysql or redis. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } }, "traits": { - "smithy.api#documentation": "

Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks\n\t\t\t(\"clients\") can use to connect to this service.

\n\t\t

Each name and port mapping must be unique within the namespace.

\n\t\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks\n\t\t\t(\"clients\") can use to connect to this service.

\n

Each name and port mapping must be unique within the namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#ServiceConnectClientAliasList": { @@ -9730,7 +9776,7 @@ "services": { "target": "com.amazonaws.ecs#ServiceConnectServiceList", "traits": { - "smithy.api#documentation": "

The list of Service Connect service objects. These are names and aliases (also known\n\t\t\tas endpoints) that are used by other Amazon ECS services to connect to this service.\n\t\t\t

\n\t\t

This field is not required for a \"client\" Amazon ECS service that's a member of a namespace\n\t\t\tonly to connect to other services within the namespace. An example of this would be a\n\t\t\tfrontend application that accepts incoming requests from either a load balancer that's\n\t\t\tattached to the service or by other means.

\n\t\t

An object selects a port from the task definition, assigns a name for the Cloud Map\n\t\t\tservice, and a list of aliases (endpoints) and ports for client applications to refer to\n\t\t\tthis service.

" + "smithy.api#documentation": "

The list of Service Connect service objects. These are names and aliases (also known\n\t\t\tas endpoints) that are used by other Amazon ECS services to connect to this service.\n\t\t\t

\n

This field is not required for a \"client\" Amazon ECS service that's a member of a namespace\n\t\t\tonly to connect to other services within the namespace. An example of this would be a\n\t\t\tfrontend application that accepts incoming requests from either a load balancer that's\n\t\t\tattached to the service or by other means.

\n

An object selects a port from the task definition, assigns a name for the Cloud Map\n\t\t\tservice, and a list of aliases (endpoints) and ports for client applications to refer to\n\t\t\tthis service.

" } }, "logConfiguration": { @@ -9738,7 +9784,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Service Connect configuration of your Amazon ECS service. The configuration for this\n\t\t\tservice to discover and connect to services, and be discovered by, and connected from,\n\t\t\tother services within a namespace.

\n\t\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Service Connect configuration of your Amazon ECS service. The configuration for this\n\t\t\tservice to discover and connect to services, and be discovered by, and connected from,\n\t\t\tother services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#ServiceConnectService": { @@ -9754,19 +9800,19 @@ "discoveryName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates\n\t\t\tfor this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,\n\t\t\tnumbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

\n\t\t\t

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

" + "smithy.api#documentation": "

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates\n\t\t\tfor this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,\n\t\t\tnumbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

\n

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

" } }, "clientAliases": { "target": "com.amazonaws.ecs#ServiceConnectClientAliasList", "traits": { - "smithy.api#documentation": "

The list of client aliases for this Service Connect service. You use these to assign\n\t\t\tnames that can be used by client applications. The maximum number of client aliases that\n\t\t\tyou can have in this list is 1.

\n\t\t

Each alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS\n\t\t\ttasks (\"clients\") can use to connect to this service.

\n\t\t

Each name and port mapping must be unique within the namespace.

\n\t\t

For each ServiceConnectService, you must provide at least one\n\t\t\t\tclientAlias with one port.

" + "smithy.api#documentation": "

The list of client aliases for this Service Connect service. You use these to assign\n\t\t\tnames that can be used by client applications. The maximum number of client aliases that\n\t\t\tyou can have in this list is 1.

\n

Each alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS\n\t\t\ttasks (\"clients\") can use to connect to this service.

\n

Each name and port mapping must be unique within the namespace.

\n

For each ServiceConnectService, you must provide at least one\n\t\t\t\tclientAlias with one port.

" } }, "ingressPortOverride": { "target": "com.amazonaws.ecs#PortNumber", "traits": { - "smithy.api#documentation": "

The port number for the Service Connect proxy to listen on.

\n\t\t

Use the value of this field to bypass the proxy for traffic on the port number\n\t\t\tspecified in the named portMapping in the task definition of this\n\t\t\tapplication, and then use it in your VPC security groups to allow traffic into the proxy\n\t\t\tfor this Amazon ECS service.

\n\t\t

In awsvpc mode and Fargate, the default value is the container port\n\t\t\tnumber. The container port number is in the portMapping in the task\n\t\t\tdefinition. In bridge mode, the default value is the ephemeral port of the\n\t\t\tService Connect proxy.

" + "smithy.api#documentation": "

The port number for the Service Connect proxy to listen on.

\n

Use the value of this field to bypass the proxy for traffic on the port number\n\t\t\tspecified in the named portMapping in the task definition of this\n\t\t\tapplication, and then use it in your VPC security groups to allow traffic into the proxy\n\t\t\tfor this Amazon ECS service.

\n

In awsvpc mode and Fargate, the default value is the container port\n\t\t\tnumber. The container port number is in the portMapping in the task\n\t\t\tdefinition. In bridge mode, the default value is the ephemeral port of the\n\t\t\tService Connect proxy.

" } } }, @@ -9786,7 +9832,7 @@ "discoveryName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The discovery name of this Service Connect resource.

\n\t\t

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates\n\t\t\tfor this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,\n\t\t\tnumbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

\n\t\t\t

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

" + "smithy.api#documentation": "

The discovery name of this Service Connect resource.

\n

The discoveryName is the name of the new Cloud Map service that Amazon ECS creates\n\t\t\tfor this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,\n\t\t\tnumbers, underscores (_), and hyphens (-). The name can't start with a hyphen.

\n

If this parameter isn't specified, the default value of discoveryName.namespace is used. If the discoveryName isn't specified, the port mapping name from the task definition is used in portName.namespace.

" } }, "discoveryArn": { @@ -9797,7 +9843,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Service Connect resource. Each configuration maps a discovery name to a\n\t\t\tCloud Map service name. The data is stored in Cloud Map as part of the\n\t\t\tService Connect configuration for each discovery name of this Amazon ECS service.

\n\t\t

A task can resolve the dnsName for each of the clientAliases\n\t\t\tof a service. However a task can't resolve the discovery names. If you want to connect\n\t\t\tto a service, refer to the ServiceConnectConfiguration of that service for\n\t\t\tthe list of clientAliases that you can use.

" + "smithy.api#documentation": "

The Service Connect resource. Each configuration maps a discovery name to a\n\t\t\tCloud Map service name. The data is stored in Cloud Map as part of the\n\t\t\tService Connect configuration for each discovery name of this Amazon ECS service.

\n

A task can resolve the dnsName for each of the clientAliases\n\t\t\tof a service. However a task can't resolve the discovery names. If you want to connect\n\t\t\tto a service, refer to the ServiceConnectConfiguration of that service for\n\t\t\tthe list of clientAliases that you can use.

" } }, "com.amazonaws.ecs#ServiceConnectServiceResourceList": { @@ -9914,7 +9960,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details for the service registry.

\n\t\t

Each service may be associated with one service registry. Multiple service registries\n\t\t\tfor each 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.

" + "smithy.api#documentation": "

The details for the service registry.

\n

Each service may be associated with one service registry. Multiple service registries\n\t\t\tfor each service are not supported.

\n

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": { @@ -10073,7 +10119,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.

\n\t\t

Alternatively, you can use RunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.

\n

Alternatively, you can use RunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#StartTaskRequest": { @@ -10121,7 +10167,7 @@ "overrides": { "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it receives. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.

\n\t\t \n\t\t\t

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.

\n\t\t " + "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it receives. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.

\n \n

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.

\n " } }, "propagateTags": { @@ -10139,13 +10185,13 @@ "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens (-), and underscores (_) are allowed.

\n\t\t

If a task is started by an Amazon ECS service, the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" + "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens (-), and underscores (_) are allowed.

\n

If a task is started by an Amazon ECS service, the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " } }, "taskDefinition": { @@ -10203,7 +10249,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a running task. Any tags associated with the task will be deleted.

\n\t\t

When StopTask is called on a task, the equivalent of docker\n\t\t\t\tstop is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL value is sent.

\n\t\t \n\t\t\t

The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t " + "smithy.api#documentation": "

Stops a running task. Any tags associated with the task will be deleted.

\n

When StopTask is called on a task, the equivalent of docker\n\t\t\t\tstop is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL value is sent.

\n \n

The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n " } }, "com.amazonaws.ecs#StopTaskRequest": { @@ -10282,7 +10328,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Sent to acknowledge that an attachment changed states.

" + "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Sent to acknowledge that an attachment changed states.

" } }, "com.amazonaws.ecs#SubmitAttachmentStateChangesRequest": { @@ -10334,7 +10380,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Sent to acknowledge that a container changed states.

" + "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Sent to acknowledge that a container changed states.

" } }, "com.amazonaws.ecs#SubmitContainerStateChangeRequest": { @@ -10424,7 +10470,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Sent to acknowledge that a task changed states.

" + "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Sent to acknowledge that a task changed states.

" } }, "com.amazonaws.ecs#SubmitTaskStateChangeRequest": { @@ -10520,7 +10566,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n\t\t

We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task. This task also uses either the\n\t\t\t\tawsvpc or host network mode. It does it for the following\n\t\t\treasons.

\n\t\t " + "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n

We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task. This task also uses either the\n\t\t\t\tawsvpc or host network mode. It does it for the following\n\t\t\treasons.

\n " } }, "com.amazonaws.ecs#SystemControls": { @@ -10546,7 +10592,7 @@ } }, "traits": { - "smithy.api#documentation": "

The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define them.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define them.

\n

The following basic restrictions apply to tags:

\n " } }, "com.amazonaws.ecs#TagKey": { @@ -10607,7 +10653,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.

\n\t\t

The following basic restrictions apply to tags:

\n ", + "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.

\n

The following basic restrictions apply to tags:

\n ", "smithy.api#required": {} } } @@ -10647,7 +10693,7 @@ } }, "traits": { - "smithy.api#documentation": "

The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:

\n\t\t \n\t\t

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS\n\t\t\t\tExec in the Amazon Elastic Container Service Developer Guide.

", + "smithy.api#documentation": "

The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:

\n \n

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS\n\t\t\t\tExec in the Amazon Elastic Container Service Developer Guide.

", "smithy.api#error": "client" } }, @@ -10734,7 +10780,7 @@ "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, 1024). It can also be\n\t\t\texpressed as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.

\n\t\t

If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).

\n\t\t

If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. These values determine the range of supported values for\n\t\t\tthe memory parameter:

\n\t\t

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n\t\t " + "smithy.api#documentation": "

The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, 1024). It can also be\n\t\t\texpressed as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.

\n

If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).

\n

If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. These values determine the range of supported values for\n\t\t\tthe memory parameter:

\n

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n " } }, "createdAt": { @@ -10771,7 +10817,7 @@ "healthStatus": { "target": "com.amazonaws.ecs#HealthStatus", "traits": { - "smithy.api#documentation": "

The health status for the task. It's determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY, the task status also reports as HEALTHY. If any\n\t\t\tessential containers in the task are reporting as UNHEALTHY or\n\t\t\t\tUNKNOWN, the task status also reports as UNHEALTHY or\n\t\t\t\tUNKNOWN.

\n\t\t \n\t\t\t

The Amazon ECS container agent doesn't monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image and not specified in the container definition. For\n\t\t\t\texample, this includes those specified in a parent image or from the image's\n\t\t\t\tDockerfile. Health check parameters that are specified in a container definition\n\t\t\t\toverride any Docker health checks that are found in the container image.

\n\t\t " + "smithy.api#documentation": "

The health status for the task. It's determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY, the task status also reports as HEALTHY. If any\n\t\t\tessential containers in the task are reporting as UNHEALTHY or\n\t\t\t\tUNKNOWN, the task status also reports as UNHEALTHY or\n\t\t\t\tUNKNOWN.

\n \n

The Amazon ECS container agent doesn't monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image and not specified in the container definition. For\n\t\t\t\texample, this includes those specified in a parent image or from the image's\n\t\t\t\tDockerfile. Health check parameters that are specified in a container definition\n\t\t\t\toverride any Docker health checks that are found in the container image.

\n " } }, "inferenceAccelerators": { @@ -10795,7 +10841,7 @@ "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The amount of memory (in MiB) that the task uses as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB (for example, 1024). If it's\n\t\t\texpressed as a string using GB (for example, 1GB or 1 GB),\n\t\t\tit's converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.

\n\t\t

If you use the EC2 launch type, this field is optional.

\n\t\t

If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. The value that you choose determines the range of supported\n\t\t\tvalues for the cpu parameter.

\n\t\t " + "smithy.api#documentation": "

The amount of memory (in MiB) that the task uses as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB (for example, 1024). If it's\n\t\t\texpressed as a string using GB (for example, 1GB or 1 GB),\n\t\t\tit's converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.

\n

If you use the EC2 launch type, this field is optional.

\n

If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. The value that you choose determines the range of supported\n\t\t\tvalues for the cpu parameter.

\n " } }, "overrides": { @@ -10813,7 +10859,7 @@ "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The operating system that your tasks are running on. A platform family is specified\n\t\t\tonly for tasks that use the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX.).

" + "smithy.api#documentation": "

The operating system that your tasks are running on. A platform family is specified\n\t\t\tonly for tasks that use the Fargate launch type.

\n

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX.).

" } }, "pullStartedAt": { @@ -10843,7 +10889,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.

\n\t\t

The following are valid values:

\n\t\t " + "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

\n

The following are valid values:

\n " } }, "stoppedAt": { @@ -10867,7 +10913,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize the task.\n\t\t\tEach tag consists of a key and an optional value. You define both the key and\n\t\t\tvalue.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize the task.\n\t\t\tEach tag consists of a key and an optional value. You define both the key and\n\t\t\tvalue.

\n

The following basic restrictions apply to tags:

\n " } }, "taskArn": { @@ -10918,13 +10964,13 @@ "family": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of a family that this task definition is registered to. Up to 255 characters\n\t\t\tare allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and\n\t\t\tunderscores (_) are allowed.

\n\t\t

A family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.

" + "smithy.api#documentation": "

The name of a family that this task definition is registered to. Up to 255 characters\n\t\t\tare allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and\n\t\t\tunderscores (_) are allowed.

\n

A family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.

" } }, "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the\n\t\t\ttask permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS\n\t\t\t\tTask Role in the Amazon Elastic Container Service Developer Guide.

\n\t\t

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option\n\t\t\tis set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\n\t\t\tconfiguration code to use the feature. For more information, see Windows IAM roles\n\t\t\t\tfor tasks in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the\n\t\t\ttask permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS\n\t\t\t\tTask Role in the Amazon Elastic Container Service Developer Guide.

\n

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option\n\t\t\tis set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\n\t\t\tconfiguration code to use the feature. For more information, see Windows IAM roles\n\t\t\t\tfor tasks in the Amazon Elastic Container Service Developer Guide.

" } }, "executionRoleArn": { @@ -10936,7 +10982,7 @@ "networkMode": { "target": "com.amazonaws.ecs#NetworkMode", "traits": { - "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.

\n

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, or awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.

\n

With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.

\n \n

When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.

\n \n

If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.

\n

If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.

\n

For more information, see Network\n settings in the Docker run reference.

" + "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.

\n

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, or awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.

\n

With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.

\n \n

When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.

\n \n

If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.

\n

If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.

\n

For more information, see Network\n settings in the Docker run reference.

" } }, "revision": { @@ -10949,7 +10995,7 @@ "volumes": { "target": "com.amazonaws.ecs#VolumeList", "traits": { - "smithy.api#documentation": "

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

The host and sourcePath parameters aren't supported for\n\t\t\t\ttasks run on Fargate.

\n\t\t " + "smithy.api#documentation": "

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide.

\n \n

The host and sourcePath parameters aren't supported for\n\t\t\t\ttasks run on Fargate.

\n " } }, "status": { @@ -10961,13 +11007,13 @@ "requiresAttributes": { "target": "com.amazonaws.ecs#RequiresAttributes", "traits": { - "smithy.api#documentation": "

The container instance attributes required by your task. When an Amazon EC2 instance is\n\t\t\tregistered to your cluster, the Amazon ECS container agent assigns some standard attributes\n\t\t\tto the instance. You can apply custom attributes. These are specified as key-value pairs\n\t\t\tusing the Amazon ECS console or the PutAttributes API. These attributes are\n\t\t\tused when determining task placement for tasks hosted on Amazon EC2 instances. For more\n\t\t\tinformation, see Attributes in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

This parameter isn't supported for tasks run on Fargate.

\n\t\t " + "smithy.api#documentation": "

The container instance attributes required by your task. When an Amazon EC2 instance is\n\t\t\tregistered to your cluster, the Amazon ECS container agent assigns some standard attributes\n\t\t\tto the instance. You can apply custom attributes. These are specified as key-value pairs\n\t\t\tusing the Amazon ECS console or the PutAttributes API. These attributes are\n\t\t\tused when determining task placement for tasks hosted on Amazon EC2 instances. For more\n\t\t\tinformation, see Attributes in the Amazon Elastic Container Service Developer Guide.

\n \n

This parameter isn't supported for tasks run on Fargate.

\n " } }, "placementConstraints": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", "traits": { - "smithy.api#documentation": "

An array of placement constraint objects to use for tasks.

\n\t\t \n\t\t\t

This parameter isn't supported for tasks run on Fargate.

\n\t\t " + "smithy.api#documentation": "

An array of placement constraint objects to use for tasks.

\n \n

This parameter isn't supported for tasks run on Fargate.

\n " } }, "compatibilities": { @@ -10979,7 +11025,7 @@ "runtimePlatform": { "target": "com.amazonaws.ecs#RuntimePlatform", "traits": { - "smithy.api#documentation": "

The operating system that your task definitions are running on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n\t\t

When you specify a task in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.

" + "smithy.api#documentation": "

The operating system that your task definitions are running on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n

When you specify a task in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.

" } }, "requiresCompatibilities": { @@ -10991,13 +11037,13 @@ "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of cpu units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the memory parameter.

\n\t\t

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n\t\t " + "smithy.api#documentation": "

The number of cpu units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the memory parameter.

\n

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n " } }, "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The amount (in MiB) of memory used by the task.

\n\t\t

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory\n\t\t\tvalue or a container-level memory value. This field is optional and any value can be\n\t\t\tused. If a task-level memory value is specified, the container-level memory value is\n\t\t\toptional. For more information regarding container-level memory and memory reservation,\n\t\t\tsee ContainerDefinition.

\n\t\t

If your tasks runs on Fargate, this field is required. You must use one of the\n\t\t\tfollowing values. The value you choose determines your range of valid values for the\n\t\t\t\tcpu parameter.

\n\t\t " + "smithy.api#documentation": "

The amount (in MiB) of memory used by the task.

\n

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory\n\t\t\tvalue or a container-level memory value. This field is optional and any value can be\n\t\t\tused. If a task-level memory value is specified, the container-level memory value is\n\t\t\toptional. For more information regarding container-level memory and memory reservation,\n\t\t\tsee ContainerDefinition.

\n

If your tasks runs on Fargate, this field is required. You must use one of the\n\t\t\tfollowing values. The value you choose determines your range of valid values for the\n\t\t\t\tcpu parameter.

\n " } }, "inferenceAccelerators": { @@ -11009,19 +11055,19 @@ "pidMode": { "target": "com.amazonaws.ecs#PidMode", "traits": { - "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid\n values are host or task. If host\n is specified, then all containers within the tasks that specified the\n host PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.

\n

If the host PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.

\n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " + "smithy.api#documentation": "

The process namespace to use for the containers in the task. The valid\n values are host or task. If host\n is specified, then all containers within the tasks that specified the\n host PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.

\n

If the host PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.

\n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " } }, "ipcMode": { "target": "com.amazonaws.ecs#IpcMode", "traits": { - "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.

\n

If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.

\n

If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.

\n \n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " + "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.

\n

If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.

\n

If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.

\n \n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " } }, "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 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.

" + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n

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": { @@ -11110,7 +11156,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a constraint on task placement in the task definition. For more\n\t\t\tinformation, see Task placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

Task placement constraints aren't supported for tasks run on Fargate.

\n\t\t " + "smithy.api#documentation": "

An object representing a constraint on task placement in the task definition. For more\n\t\t\tinformation, see Task placement constraints in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n \n

Task placement constraints aren't supported for tasks run on Fargate.

\n " } }, "com.amazonaws.ecs#TaskDefinitionPlacementConstraintType": { @@ -11206,7 +11252,7 @@ "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { - "smithy.api#documentation": "

The ephemeral storage setting override for the task.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate that\n\t\t\t\tuse the following platform versions:

\n\t\t\t \n\t\t " + "smithy.api#documentation": "

The ephemeral storage setting override for the task.

\n \n

This parameter is only supported for tasks hosted on Fargate that\n\t\t\t\tuse the following platform versions:

\n \n " } } }, @@ -11250,13 +11296,13 @@ "externalId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The external ID associated with the task set.

\n\t\t

If an CodeDeploy deployment created a task set, the externalId parameter\n\t\t\tcontains the CodeDeploy deployment ID.

\n\t\t

If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

" + "smithy.api#documentation": "

The external ID associated with the task set.

\n

If an CodeDeploy deployment created a task set, the externalId parameter\n\t\t\tcontains the CodeDeploy deployment ID.

\n

If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the task set. The following describes each state.

\n\t\t
\n
PRIMARY
\n
\n\t\t\t\t\t

The task set is serving production traffic.

\n\t\t\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

The task set isn't serving production traffic.

\n\t\t\t\t
\n
DRAINING
\n
\n\t\t\t\t\t

The tasks in the task set are being stopped, and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.

\n\t\t\t\t
\n
" + "smithy.api#documentation": "

The status of the task set. The following describes each state.

\n
\n
PRIMARY
\n
\n

The task set is serving production traffic.

\n
\n
ACTIVE
\n
\n

The task set isn't serving production traffic.

\n
\n
DRAINING
\n
\n

The tasks in the task set are being stopped, and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.

\n
\n
" } }, "taskDefinition": { @@ -11319,7 +11365,7 @@ "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The operating system that your tasks in the set are running on. A platform family is\n\t\t\tspecified only for tasks that use the Fargate launch type.

\n\t\t

All tasks in the set must have the same value.

" + "smithy.api#documentation": "

The operating system that your tasks in the set are running on. A platform family is\n\t\t\tspecified only for tasks that use the Fargate launch type.

\n

All tasks in the set must have the same value.

" } }, "networkConfiguration": { @@ -11349,7 +11395,7 @@ "stabilityStatus": { "target": "com.amazonaws.ecs#StabilityStatus", "traits": { - "smithy.api#documentation": "

The stability status. This indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set are in\n\t\t\tSTEADY_STATE:

\n\t\t \n\t\t

If any of those conditions aren't met, the stability status returns\n\t\t\t\tSTABILIZING.

" + "smithy.api#documentation": "

The stability status. This indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set are in\n\t\t\tSTEADY_STATE:

\n \n

If any of those conditions aren't met, the stability status returns\n\t\t\t\tSTABILIZING.

" } }, "stabilityStatusAt": { @@ -11361,7 +11407,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " + "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n " } } }, @@ -11475,7 +11521,7 @@ "mountOptions": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The list of tmpfs volume mount options.

\n\t\t

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n\t\t\t\t\"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n\t\t\t\t\"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n\t\t\t\t\"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n\t\t\t\t\"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n\t\t\t\t| \"nr_inodes\" | \"nr_blocks\" | \"mpol\"\n

" + "smithy.api#documentation": "

The list of tmpfs volume mount options.

\n

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n\t\t\t\t\"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n\t\t\t\t\"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n\t\t\t\t\"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n\t\t\t\t\"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n\t\t\t\t| \"nr_inodes\" | \"nr_blocks\" | \"mpol\"\n

" } } }, @@ -11534,7 +11580,7 @@ } }, "traits": { - "smithy.api#documentation": "

The ulimit settings to pass to the container.

\n\t\t

Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 1024 and hard limit\n\t\t\t\t\t\t\tis 4096.

" + "smithy.api#documentation": "

The ulimit settings to pass to the container.

\n

Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 1024 and hard limit\n\t\t\t\t\t\t\tis 4096.

" } }, "com.amazonaws.ecs#UlimitList": { @@ -11806,7 +11852,7 @@ "serviceConnectDefaults": { "target": "com.amazonaws.ecs#ClusterServiceConnectDefaultsRequest", "traits": { - "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n\t

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Use this parameter to set a default Service Connect namespace. After you set a default \n\tService Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as\n\tclient services in the namespace. This setting only applies to new services that set the enabled parameter to\n\ttrue in the ServiceConnectConfiguration.\n\tYou can set the namespace of each service individually in the ServiceConnectConfiguration to override this default\n\tparameter.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } } @@ -11861,7 +11907,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 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.

\n\t\t \n\t\t\t

Currently, if you delete an existing cluster that does not have Container Insights\n\t\t\t\tturned on, and then create a new cluster with the same name with Container Insights\n\t\t\t\ttuned on, Container Insights will not actually be turned on. If you want to preserve\n\t\t\t\tthe same name for your existing cluster and turn on Container Insights, you must\n\t\t\t\twait 7 days before you can re-create it.

\n\t\t ", + "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.

\n \n

Currently, if you delete an existing cluster that does not have Container Insights\n\t\t\t\tturned on, and then create a new cluster with the same name with Container Insights\n\t\t\t\ttuned on, Container Insights will not actually be turned on. If you want to preserve\n\t\t\t\tthe same name for your existing cluster and turn on Container Insights, you must\n\t\t\t\twait 7 days before you can re-create it.

\n ", "smithy.api#required": {} } } @@ -11910,7 +11956,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent doesn't interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.

\n\t\t \n\t\t\t

The UpdateContainerAgent API isn't supported for container instances\n\t\t\t\tusing the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,\n\t\t\t\tyou can update the ecs-init package. This updates the agent. For more\n\t\t\t\tinformation, see Updating the\n\t\t\t\t\tAmazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t \n\t\t\t

Agent updates with the UpdateContainerAgent API operation do not\n\t\t\t\tapply to Windows container instances. We recommend that you launch new container\n\t\t\t\tinstances to update the agent version in your Windows clusters.

\n\t\t \n\t\t

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the ecs-init service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Updates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent doesn't interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.

\n \n

The UpdateContainerAgent API isn't supported for container instances\n\t\t\t\tusing the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,\n\t\t\t\tyou can update the ecs-init package. This updates the agent. For more\n\t\t\t\tinformation, see Updating the\n\t\t\t\t\tAmazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

\n \n \n

Agent updates with the UpdateContainerAgent API operation do not\n\t\t\t\tapply to Windows container instances. We recommend that you launch new container\n\t\t\t\tinstances to update the agent version in your Windows clusters.

\n \n

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the ecs-init service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#UpdateContainerAgentRequest": { @@ -11965,7 +12011,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the status of an Amazon ECS container instance.

\n\t\t

Once a container instance has reached an ACTIVE state, you can change the\n\t\t\tstatus of a container instance to DRAINING to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.

\n\t\t \n\t\t\t

A container instance can't be changed to DRAINING until it has\n\t\t\t\treached an ACTIVE status. If the instance is in any other status, an\n\t\t\t\terror will be received.

\n\t\t \n\t\t

When you set a container instance to DRAINING, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING\n\t\t\tstate are stopped immediately.

\n\t\t

Service tasks on the container instance that are in the RUNNING state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.

\n\t\t \n\t\t

Any PENDING or RUNNING tasks that do not belong to a service\n\t\t\taren't affected. You must wait for them to finish or stop them manually.

\n\t\t

A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.

\n\t\t

When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.

" + "smithy.api#documentation": "

Modifies the status of an Amazon ECS container instance.

\n

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 \n

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 \n

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

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 \n

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

A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.

\n

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": { @@ -12063,7 +12109,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the parameters of a service.

\n\t\t

For services using the rolling update (ECS) you can update the desired\n\t\t\tcount, deployment configuration, network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.

\n\t\t

For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, health check grace period, task\n\t\t\tplacement constraints and strategies, enable ECS managed tags option, and propagate tags\n\t\t\tcan be updated using this API. If the network configuration, platform version, task\n\t\t\tdefinition, or 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\n\t\t\tcount, task placement constraints and strategies, health check grace period, enable ECS\n\t\t\tmanaged tags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.

\n\t\t

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n\t\t

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n\t\t \n\t\t\t

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n\t\t \n\t\t

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n\t\t \n\t\t

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n\t\t \n\n\t\t

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

\n\t\t \n\t\t \n\t\t\t

You must have a service-linked role when you update any of the following service\n\t\t\t\tproperties. If you specified a custom IAM role when you created the service, Amazon ECS\n\t\t\t\tautomatically replaces the roleARN associated with the service with the ARN of your\n\t\t\t\tservice-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.

\n\t\t\t \n\t\t " + "smithy.api#documentation": "

Modifies the parameters of a service.

\n

For services using the rolling update (ECS) you can update the desired\n\t\t\tcount, deployment configuration, network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.

\n

For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, health check grace period, task\n\t\t\tplacement constraints and strategies, enable ECS managed tags option, and propagate tags\n\t\t\tcan be updated using this API. If the network configuration, platform version, task\n\t\t\tdefinition, or 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

For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, health check grace period, enable ECS\n\t\t\tmanaged tags 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

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

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 \n

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 \n

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 \n

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

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n \n

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 \n \n

You must have a service-linked role when you update any of the following service\n\t\t\t\tproperties. If you specified a custom IAM role when you created the service, Amazon ECS\n\t\t\t\tautomatically replaces the roleARN associated with the service with the ARN of your\n\t\t\t\tservice-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.

\n \n " } }, "com.amazonaws.ecs#UpdateServicePrimaryTaskSet": { @@ -12175,7 +12221,7 @@ "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to update the service to use.

\n\t\t

if the service uses the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that's not the default capacity provider strategy, the service can't be updated\n\t\t\tto use the cluster's default capacity provider strategy.

\n\t\t

A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n\t\t

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

\n\t\t

" + "smithy.api#documentation": "

The capacity provider strategy to update the service to use.

\n

if the service uses the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that's not the default capacity provider strategy, the service can't be updated\n\t\t\tto use the cluster's default capacity provider strategy.

\n

A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

\n

" } }, "deploymentConfiguration": { @@ -12193,13 +12239,13 @@ "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.

\n\t\t

You can specify a maximum of 10 constraints for each task. This limit includes\n\t\t\tconstraints in the task definition and those specified at runtime.

" + "smithy.api#documentation": "

An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.

\n

You can specify a maximum of 10 constraints for each task. This limit includes\n\t\t\tconstraints in the task definition and those specified at runtime.

" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.

\n\t\t

You can specify a maximum of five strategy rules for each service.

" + "smithy.api#documentation": "

The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.

\n

You can specify a maximum of five strategy rules for each service.

" } }, "platformVersion": { @@ -12224,37 +12270,37 @@ "enableExecuteCommand": { "target": "com.amazonaws.ecs#BoxedBoolean", "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.

" + "smithy.api#documentation": "

If true, this enables execute command functionality on all task\n\t\t\tcontainers.

\n

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\n\t\t\tmore information, 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.

" + "smithy.api#documentation": "

Determines whether to turn on Amazon ECS managed tags for the tasks in 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.

\n

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\n\t\t\twith the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks\n\t\t\tare running.

\n\t\t

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target\n\t\t\tgroups. You can update from a single target group to multiple target groups and from\n\t\t\tmultiple target groups to a single target group.

\n\t\t

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by\n\t\t\tusing \n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

\n\t\t

For services that use the external deployment controller, you can add, update, or\n\t\t\tremove load balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

\n\t\t

You can remove existing loadBalancers by passing an empty list.

" + "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

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks\n\t\t\twith the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks\n\t\t\tare running.

\n

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target\n\t\t\tgroups. You can update from a single target group to multiple target groups and from\n\t\t\tmultiple target groups to a single target group.

\n

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by\n\t\t\tusing \n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

\n

For services that use the external deployment controller, you can add, update, or\n\t\t\tremove load balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

\n

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.

" + "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

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\n\t\t\ttasks with the updated service registries configuration, and then stops the old tasks\n\t\t\twhen the new tasks are running.

\n\t\t

You can remove existing serviceRegistries by passing an empty\n\t\t\tlist.

" + "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

When you add, update, or remove the service registries configuration, Amazon ECS starts new\n\t\t\ttasks with the updated service registries configuration, and then stops the old tasks\n\t\t\twhen the new tasks are running.

\n

You can remove existing serviceRegistries by passing an empty\n\t\t\tlist.

" } }, "serviceConnectConfiguration": { "target": "com.amazonaws.ecs#ServiceConnectConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The configuration for this service to discover and connect to\n\tservices, and be discovered by, and connected from, other services within a namespace.

\n

Tasks that run in a namespace can use short names to connect\n\tto services in the namespace. Tasks can connect to services across all of the clusters in the namespace.\n\tTasks connect through a managed proxy container\n\tthat collects logs and metrics for increased visibility.\n\tOnly the tasks that Amazon ECS services create are supported with Service Connect.\n\tFor more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

" } } } @@ -12302,7 +12348,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.

\n\t\t

Task-protection, by default, expires after 2 hours at which point Amazon ECS unsets the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.

\n\t\t

You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.

\n\t\t

To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .

\n\t\t \n\t\t\t

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.

\n\t\t \n\t\t \n\t\t\t

If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.

\n\t\t " + "smithy.api#documentation": "

Updates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.

\n

Task-protection, by default, expires after 2 hours at which point Amazon ECS unsets the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.

\n

You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.

\n

To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .

\n \n

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.

\n \n \n

If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.

\n " } }, "com.amazonaws.ecs#UpdateTaskProtectionRequest": { @@ -12333,7 +12379,7 @@ "expiresInMinutes": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If you set protectionEnabled to true, you can specify the\n\t\t\tduration for task protection in minutes. You can specify a value from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in\n\t\t\tevents from Service Auto Scaling or deployments. After this time period lapses,\n\t\t\t\tprotectionEnabled will be reset to false.

\n\t\t

If you don’t specify the time, then the task is automatically protected for 120\n\t\t\tminutes (2 hours).

" + "smithy.api#documentation": "

If you set protectionEnabled to true, you can specify the\n\t\t\tduration for task protection in minutes. You can specify a value from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in\n\t\t\tevents from Service Auto Scaling or deployments. After this time period lapses,\n\t\t\t\tprotectionEnabled will be reset to false.

\n

If you don’t specify the time, then the task is automatically protected for 120\n\t\t\tminutes (2 hours).

" } } } @@ -12344,7 +12390,7 @@ "protectedTasks": { "target": "com.amazonaws.ecs#ProtectedTasks", "traits": { - "smithy.api#documentation": "

A list of tasks with the following information.

\n\t\t " + "smithy.api#documentation": "

A list of tasks with the following information.

\n " } }, "failures": { @@ -12478,13 +12524,13 @@ "host": { "target": "com.amazonaws.ecs#HostVolumeProperties", "traits": { - "smithy.api#documentation": "

This parameter is specified when you use bind mount host volumes. The contents of the\n\t\t\t\thost parameter determine whether your bind mount host volume persists\n\t\t\ton the host container instance and where it's stored. If the host parameter\n\t\t\tis empty, then the Docker daemon assigns a host path for your data volume. However, the\n\t\t\tdata isn't guaranteed to persist after the containers that are associated with it stop\n\t\t\trunning.

\n\t\t

Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

" + "smithy.api#documentation": "

This parameter is specified when you use bind mount host volumes. The contents of the\n\t\t\t\thost parameter determine whether your bind mount host volume persists\n\t\t\ton the host container instance and where it's stored. If the host parameter\n\t\t\tis empty, then the Docker daemon assigns a host path for your data volume. However, the\n\t\t\tdata isn't guaranteed to persist after the containers that are associated with it stop\n\t\t\trunning.

\n

Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

" } }, "dockerVolumeConfiguration": { "target": "com.amazonaws.ecs#DockerVolumeConfiguration", "traits": { - "smithy.api#documentation": "

This parameter is specified when you use Docker volumes.

\n\t\t

Windows containers only support the use of the local driver. To use bind\n\t\t\tmounts, specify the host parameter instead.

\n\t\t \n\t\t\t

Docker volumes aren't supported by tasks run on Fargate.

\n\t\t " + "smithy.api#documentation": "

This parameter is specified when you use Docker volumes.

\n

Windows containers only support the use of the local driver. To use bind\n\t\t\tmounts, specify the host parameter instead.

\n \n

Docker volumes aren't supported by tasks run on Fargate.

\n " } }, "efsVolumeConfiguration": { diff --git a/codegen/sdk-codegen/aws-models/efs.2015-02-01.json b/codegen/sdk-codegen/aws-models/efs.2015-02-01.json index d6334afb486..38651972851 100644 --- a/codegen/sdk-codegen/aws-models/efs.2015-02-01.json +++ b/codegen/sdk-codegen/aws-models/efs.2015-02-01.json @@ -445,7 +445,7 @@ "ProvisionedThroughputInMibps": { "target": "com.amazonaws.efs#ProvisionedThroughputInMibps", "traits": { - "smithy.api#documentation": "

The throughput, measured in MiB/s, that you want to provision for a file system that\n you're creating. Valid values are 1-1024. Required if ThroughputMode is set\n to provisioned. The upper limit for throughput is 1024 MiB/s. To increase this\n limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase\n in the Amazon EFS User Guide.

" + "smithy.api#documentation": "

The throughput, measured in\n MiB/s,\n that you want to provision for a file system that you're creating. Valid values are\n 1-1024. Required if ThroughputMode is set to provisioned. The upper\n limit for throughput is 1024 MiB/s. To increase this limit, contact Amazon Web Services Support. For\n more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

" } }, "AvailabilityZoneName": { @@ -2514,7 +2514,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -2563,15 +2563,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -2834,8 +2825,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -2847,8 +2838,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -2860,8 +2851,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -2873,8 +2864,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -2886,8 +2877,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-south-1" } }, @@ -2899,8 +2890,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-south-1" } }, @@ -2912,8 +2903,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-south-1" } }, @@ -2925,8 +2916,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-1" } }, @@ -2938,8 +2929,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-south-2" } }, @@ -2951,8 +2942,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-south-2" } }, @@ -2964,8 +2955,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-south-2" } }, @@ -2977,8 +2968,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-2" } }, @@ -2990,8 +2981,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-east-1" } }, @@ -3003,8 +2994,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-east-1" } }, @@ -3016,8 +3007,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-east-1" } }, @@ -3029,8 +3020,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-east-1" } }, @@ -3042,8 +3033,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "me-central-1" } }, @@ -3055,8 +3046,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "me-central-1" } }, @@ -3068,8 +3059,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "me-central-1" } }, @@ -3081,8 +3072,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "me-central-1" } }, @@ -3094,8 +3085,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -3107,8 +3098,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -3120,8 +3111,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -3133,8 +3124,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -3146,8 +3137,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -3159,8 +3150,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -3172,8 +3163,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -3185,8 +3176,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -3196,8 +3187,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-west-1" } }, @@ -3209,8 +3200,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-west-1" } }, @@ -3220,8 +3211,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-west-1" } }, @@ -3233,8 +3224,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-west-1" } }, @@ -3246,8 +3237,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-2" } }, @@ -3259,8 +3250,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-2" } }, @@ -3272,8 +3263,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-2" } }, @@ -3285,8 +3276,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-2" } }, @@ -3298,8 +3289,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-1" } }, @@ -3311,8 +3302,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -3324,8 +3315,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-1" } }, @@ -3337,8 +3328,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -3350,8 +3341,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -3363,8 +3354,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -3376,8 +3367,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -3389,8 +3380,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -3402,8 +3393,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "af-south-1" } }, @@ -3415,8 +3406,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -3428,8 +3419,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "af-south-1" } }, @@ -3441,8 +3432,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -3454,8 +3445,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-north-1" } }, @@ -3467,8 +3458,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-north-1" } }, @@ -3480,8 +3471,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-north-1" } }, @@ -3493,8 +3484,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-north-1" } }, @@ -3506,8 +3497,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-3" } }, @@ -3519,8 +3510,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-3" } }, @@ -3532,8 +3523,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-3" } }, @@ -3545,8 +3536,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-3" } }, @@ -3558,8 +3549,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -3571,8 +3562,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -3584,8 +3575,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -3597,8 +3588,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -3610,8 +3601,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-1" } }, @@ -3623,8 +3614,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -3636,8 +3627,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-1" } }, @@ -3649,8 +3640,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -3662,8 +3653,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-3" } }, @@ -3675,8 +3666,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-3" } }, @@ -3688,8 +3679,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-3" } }, @@ -3701,8 +3692,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-3" } }, @@ -3714,8 +3705,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -3727,8 +3718,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -3740,8 +3731,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -3753,8 +3744,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -3766,8 +3757,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -3779,8 +3770,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -3792,8 +3783,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -3805,8 +3796,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -3818,8 +3809,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "me-south-1" } }, @@ -3831,8 +3822,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "me-south-1" } }, @@ -3844,8 +3835,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "me-south-1" } }, @@ -3857,8 +3848,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "me-south-1" } }, @@ -3870,8 +3861,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "sa-east-1" } }, @@ -3883,8 +3874,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "sa-east-1" } }, @@ -3896,8 +3887,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "sa-east-1" } }, @@ -3909,8 +3900,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "sa-east-1" } }, @@ -3922,8 +3913,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-east-1" } }, @@ -3935,8 +3926,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-east-1" } }, @@ -3948,8 +3939,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-east-1" } }, @@ -3961,8 +3952,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-east-1" } }, @@ -3974,8 +3965,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "cn-north-1" } }, @@ -3987,8 +3978,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "cn-north-1" } }, @@ -4000,8 +3991,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "cn-north-1" } }, @@ -4013,8 +4004,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "cn-north-1" } }, @@ -4026,8 +4017,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -4039,8 +4030,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -4052,8 +4043,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -4065,8 +4056,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -4078,8 +4069,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -4091,8 +4082,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -4104,8 +4095,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -4117,8 +4108,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -4130,8 +4121,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -4143,8 +4134,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -4156,8 +4147,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -4169,8 +4160,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -4180,8 +4171,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-east-1" } }, @@ -4193,8 +4184,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-east-1" } }, @@ -4204,8 +4195,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-east-1" } }, @@ -4217,8 +4208,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-east-1" } }, @@ -4230,8 +4221,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-3" } }, @@ -4243,8 +4234,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-3" } }, @@ -4256,8 +4247,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-3" } }, @@ -4269,8 +4260,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-3" } }, @@ -4282,8 +4273,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -4295,8 +4286,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -4308,8 +4299,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -4321,8 +4312,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -4334,8 +4325,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-2" } }, @@ -4347,8 +4338,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -4360,8 +4351,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-2" } }, @@ -4373,8 +4364,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -4386,8 +4377,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "cn-northwest-1" } }, @@ -4399,8 +4390,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "cn-northwest-1" } }, @@ -4412,8 +4403,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "cn-northwest-1" } }, @@ -4425,8 +4416,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "cn-northwest-1" } }, @@ -4436,8 +4427,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-isob-east-1" } }, @@ -4449,8 +4440,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-isob-east-1" } }, @@ -4460,8 +4451,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-isob-east-1" } }, @@ -4473,8 +4464,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-isob-east-1" } }, @@ -4486,8 +4477,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -4498,8 +4489,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -4510,8 +4501,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -5086,7 +5077,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this action to manage EFS lifecycle management and intelligent tiering. A \n LifecycleConfiguration consists of one or more LifecyclePolicy objects that \n define the following:

\n \n \n

For more information, see EFS Lifecycle Management.

\n

Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a\n LifecycleConfiguration object already exists for the specified file system, a\n PutLifecycleConfiguration call modifies the existing configuration. A\n PutLifecycleConfiguration call with an empty LifecyclePolicies\n array in the request body deletes any existing LifecycleConfiguration and\n turns off lifecycle management and intelligent tiering for the file system.

\n

In the request, specify the following:

\n \n\n

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

\n

To apply a LifecycleConfiguration object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted file system.

", + "smithy.api#documentation": "

Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A\n LifecycleConfiguration consists of one or more LifecyclePolicy\n objects that define the following:

\n \n \n

For more information, see EFS Lifecycle Management.

\n

Each Amazon EFS file system supports one lifecycle configuration, which applies to\n all files in the file system. If a LifecycleConfiguration object already exists\n for the specified file system, a PutLifecycleConfiguration call modifies the\n existing configuration. A PutLifecycleConfiguration call with an empty\n LifecyclePolicies array in the request body deletes any existing\n LifecycleConfiguration and turns off lifecycle management and EFS\n Intelligent-Tiering for the file system.

\n

In the request, specify the following:

\n \n\n

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

\n

To apply a LifecycleConfiguration object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted file system.

", "smithy.api#http": { "method": "PUT", "uri": "/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration", diff --git a/codegen/sdk-codegen/aws-models/eks.2017-11-01.json b/codegen/sdk-codegen/aws-models/eks.2017-11-01.json index a249d6e8470..7828b3fcab2 100644 --- a/codegen/sdk-codegen/aws-models/eks.2017-11-01.json +++ b/codegen/sdk-codegen/aws-models/eks.2017-11-01.json @@ -79,6 +79,30 @@ "traits": { "smithy.api#enumValue": "BOTTLEROCKET_x86_64_NVIDIA" } + }, + "WINDOWS_CORE_2019_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_CORE_2019_x86_64" + } + }, + "WINDOWS_FULL_2019_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_FULL_2019_x86_64" + } + }, + "WINDOWS_CORE_2022_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_CORE_2022_x86_64" + } + }, + "WINDOWS_FULL_2022_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_FULL_2022_x86_64" + } } } }, @@ -122,6 +146,9 @@ { "target": "com.amazonaws.eks#DescribeAddon" }, + { + "target": "com.amazonaws.eks#DescribeAddonConfiguration" + }, { "target": "com.amazonaws.eks#DescribeAddonVersions" }, @@ -201,7 +228,7 @@ "name": "eks" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy\n for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain\n your own Kubernetes control plane. Kubernetes is an open-source system for automating\n the deployment, scaling, and management of containerized applications.

\n

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so\n you can use all the existing plugins and tooling from the Kubernetes community.\n Applications running on Amazon EKS are fully compatible with applications\n running on any standard Kubernetes environment, whether running in on-premises data\n centers or public clouds. This means that you can easily migrate any standard Kubernetes\n application to Amazon EKS without any code modification required.

", + "smithy.api#documentation": "

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy\n for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain\n your own Kubernetes control plane. Kubernetes is an open-source system for automating\n the deployment, scaling, and management of containerized applications.

\n

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so\n you can use all the existing plugins and tooling from the Kubernetes community.\n Applications running on Amazon EKS are fully compatible with applications\n running on any standard Kubernetes environment, whether running in on-premises data\n centers or public clouds. This means that you can easily migrate any standard Kubernetes\n application to Amazon EKS without any code modification required.

", "smithy.api#title": "Amazon Elastic Kubernetes Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -257,15 +284,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -578,9 +596,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": true } }, { @@ -591,9 +609,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": false } }, { @@ -604,9 +622,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": true } }, { @@ -617,9 +635,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": false } }, { @@ -630,9 +648,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -643,9 +661,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -656,9 +674,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -669,9 +687,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -682,9 +700,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -695,9 +713,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -708,9 +726,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -721,9 +739,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -734,9 +752,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": true } }, { @@ -747,9 +765,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": false } }, { @@ -760,9 +778,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": true } }, { @@ -773,9 +791,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": false } }, { @@ -786,9 +804,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -799,9 +817,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -812,9 +830,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -825,9 +843,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -838,9 +856,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -851,9 +869,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -864,9 +882,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -877,9 +895,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -890,9 +908,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -903,9 +921,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -916,9 +934,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -929,9 +947,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -942,9 +960,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -955,9 +973,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -968,9 +986,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -981,9 +999,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -994,9 +1012,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": true } }, { @@ -1007,9 +1025,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": false } }, { @@ -1020,9 +1038,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": true } }, { @@ -1033,9 +1051,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": false } }, { @@ -1046,9 +1064,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -1059,9 +1077,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -1072,9 +1090,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -1085,9 +1103,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -1098,9 +1116,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -1111,9 +1129,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -1124,9 +1142,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -1137,9 +1155,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -1150,9 +1168,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -1163,9 +1181,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -1176,9 +1194,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -1189,9 +1207,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -1202,9 +1220,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1215,9 +1233,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1228,9 +1246,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1241,9 +1259,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1254,9 +1272,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1267,9 +1285,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1280,9 +1298,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1293,9 +1311,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1306,9 +1324,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -1319,9 +1337,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -1332,9 +1350,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -1345,9 +1363,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -1358,9 +1376,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -1371,9 +1389,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -1384,9 +1402,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -1397,9 +1415,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -1410,9 +1428,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -1423,9 +1441,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -1436,9 +1454,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -1449,9 +1467,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -1462,9 +1480,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -1475,9 +1493,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -1488,9 +1506,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -1501,9 +1519,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -1514,9 +1532,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -1527,9 +1545,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -1540,9 +1558,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -1553,9 +1571,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -1566,9 +1584,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -1579,9 +1597,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -1592,9 +1610,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -1605,9 +1623,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -1618,9 +1636,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -1631,9 +1649,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -1644,9 +1662,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -1657,9 +1675,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -1670,9 +1688,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -1683,9 +1701,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -1696,9 +1714,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -1709,9 +1727,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -1722,9 +1740,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -1735,9 +1753,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -1748,9 +1766,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -1761,9 +1779,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -1774,9 +1792,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -1787,9 +1805,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -1800,9 +1818,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -1813,9 +1831,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -1826,9 +1844,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -1839,9 +1857,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -1852,9 +1870,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -1865,9 +1883,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -1878,9 +1896,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -1891,9 +1909,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -1904,9 +1922,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -1917,9 +1935,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -1928,9 +1946,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -1941,9 +1959,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -1952,9 +1970,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -1965,9 +1983,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -1978,9 +1996,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -1991,9 +2009,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -2004,9 +2022,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -2017,9 +2035,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -2030,9 +2048,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": true } }, { @@ -2043,9 +2061,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": false } }, { @@ -2056,9 +2074,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": true } }, { @@ -2069,9 +2087,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": false } }, { @@ -2082,9 +2100,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -2095,9 +2113,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -2108,9 +2126,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -2121,9 +2139,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -2134,9 +2152,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -2147,9 +2165,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -2160,9 +2178,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -2173,9 +2191,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -2186,9 +2204,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -2199,9 +2217,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -2212,9 +2230,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -2225,9 +2243,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -2236,9 +2254,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -2249,9 +2267,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -2260,9 +2278,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -2273,9 +2291,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -2286,9 +2304,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2298,9 +2316,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2310,9 +2328,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -2364,7 +2382,7 @@ "health": { "target": "com.amazonaws.eks#AddonHealth", "traits": { - "smithy.api#documentation": "

An object representing the health of the add-on.

" + "smithy.api#documentation": "

An object that represents the health of the add-on.

" } }, "addonArn": { @@ -2388,7 +2406,7 @@ "serviceAccountRoleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service\n account used by the add-on.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes service account\n that the add-on uses.

" } }, "tags": { @@ -2414,6 +2432,12 @@ "traits": { "smithy.api#documentation": "

Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.

" } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The configuration values that you provided.

" + } } }, "traits": { @@ -2690,7 +2714,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associate encryption configuration to an existing cluster.

\n

You can use this API to enable encryption on existing clusters which do not have\n encryption already enabled. This allows you to implement a defense-in-depth security\n strategy without migrating applications to new Amazon EKS clusters.

", + "smithy.api#documentation": "

Associate encryption configuration to an existing cluster.

\n

You can use this API to enable encryption on existing clusters which do not have\n encryption already enabled. This allows you to implement a defense-in-depth security\n strategy without migrating applications to new Amazon EKS clusters.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/encryption-config/associate", @@ -2762,7 +2786,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associate an identity provider configuration to a cluster.

\n

If you want to authenticate identities using an identity provider, you can create an\n identity provider configuration and associate it to your cluster. After configuring\n authentication to your cluster you can create Kubernetes roles and\n clusterroles to assign permissions to the roles, and then bind the\n roles to the identities using Kubernetes rolebindings and\n clusterrolebindings. For more information see Using RBAC\n Authorization in the Kubernetes documentation.

", + "smithy.api#documentation": "

Associate an identity provider configuration to a cluster.

\n

If you want to authenticate identities using an identity provider, you can create an\n identity provider configuration and associate it to your cluster. After configuring\n authentication to your cluster you can create Kubernetes roles and\n clusterroles to assign permissions to the roles, and then bind the\n roles to the identities using Kubernetes rolebindings and\n clusterrolebindings. For more information see Using RBAC\n Authorization in the Kubernetes documentation.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/identity-provider-configs/associate", @@ -3404,7 +3428,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon EKS add-on.

\n

Amazon EKS add-ons help to automate the provisioning and lifecycle management\n of common operational software for Amazon EKS clusters. For more information,\n see Amazon EKS add-ons in the Amazon EKS User Guide.

", + "smithy.api#documentation": "

Creates an Amazon EKS add-on.

\n

Amazon EKS add-ons help to automate the provisioning and lifecycle management\n of common operational software for Amazon EKS clusters. For more information,\n see Amazon EKS add-ons in the Amazon EKS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/addons", @@ -3426,7 +3450,7 @@ "addonName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by \n DescribeAddonVersions\n .

", + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names that \n DescribeAddonVersions\n returns.

", "smithy.api#required": {} } }, @@ -3439,13 +3463,13 @@ "serviceAccountRoleArn": { "target": "com.amazonaws.eks#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

\n \n

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

\n \n

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.

\n " } }, "resolveConflicts": { "target": "com.amazonaws.eks#ResolveConflicts", "traits": { - "smithy.api#documentation": "

How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are\n handled based on the value you choose:

\n \n

If you don't currently have the self-managed version of the add-on installed on your\n cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values\n to default values, regardless of the option that you specify.

" + "smithy.api#documentation": "

How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are\n handled based on the value you choose:

\n \n

If you don't currently have the self-managed version of the add-on installed on your\n cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values\n to default values, regardless of the option that you specify.

" } }, "clientRequestToken": { @@ -3460,6 +3484,12 @@ "traits": { "smithy.api#documentation": "

The metadata to apply to the cluster to assist with categorization and organization.\n Each tag consists of a key and an optional value. You define both.

" } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema in \n DescribeAddonConfiguration\n .

" + } } } }, @@ -3503,7 +3533,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon EKS control plane.

\n

The Amazon EKS control plane consists of control plane instances that run the\n Kubernetes software, such as etcd and the API server. The control plane\n runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by\n the Amazon EKS API server endpoint. Each Amazon EKS cluster control\n plane is single tenant and unique. It runs on its own set of Amazon EC2\n instances.

\n

The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in\n your VPC subnets to provide connectivity from the control plane instances to the nodes\n (for example, to support kubectl exec, logs, and\n proxy data flows).

\n

Amazon EKS nodes run in your Amazon Web Services account and connect to your\n cluster's control plane over the Kubernetes API server endpoint and a certificate file\n that is created for your cluster.

\n \n

In most cases, it takes several minutes to create a cluster. After you create an\n Amazon EKS cluster, you must configure your Kubernetes tooling to\n communicate with the API server and launch nodes into your cluster. For more\n information, see Managing Cluster Authentication and Launching\n Amazon EKS nodes in the Amazon EKS User Guide.

", + "smithy.api#documentation": "

Creates an Amazon EKS control plane.

\n

The Amazon EKS control plane consists of control plane instances that run the\n Kubernetes software, such as etcd and the API server. The control plane\n runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by\n the Amazon EKS API server endpoint. Each Amazon EKS cluster control\n plane is single tenant and unique. It runs on its own set of Amazon EC2\n instances.

\n

The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in\n your VPC subnets to provide connectivity from the control plane instances to the nodes\n (for example, to support kubectl exec, logs, and\n proxy data flows).

\n

Amazon EKS nodes run in your Amazon Web Services account and connect to your\n cluster's control plane over the Kubernetes API server endpoint and a certificate file\n that is created for your cluster.

\n

In most cases, it takes several minutes to create a cluster. After you create an\n Amazon EKS cluster, you must configure your Kubernetes tooling to\n communicate with the API server and launch nodes into your cluster. For more\n information, see Managing Cluster Authentication and Launching\n Amazon EKS nodes in the Amazon EKS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/clusters", @@ -3524,7 +3554,7 @@ "version": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The desired Kubernetes version for your cluster. If you don't specify a value here,\n the default version available in Amazon EKS is used.

\n \n

The default version might not be the latest version available.

\n " + "smithy.api#documentation": "

The desired Kubernetes version for your cluster. If you don't specify a value here,\n the default version available in Amazon EKS is used.

\n \n

The default version might not be the latest version available.

\n " } }, "roleArn": { @@ -3550,7 +3580,7 @@ "logging": { "target": "com.amazonaws.eks#Logging", "traits": { - "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to\n CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n " + "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to\n CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n " } }, "clientRequestToken": { @@ -3620,7 +3650,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Fargate profile for your Amazon EKS cluster. You\n must have at least one Fargate profile in a cluster to be able to run\n pods on Fargate.

\n

The Fargate profile allows an administrator to declare which pods run\n on Fargate and specify which pods run on which Fargate\n profile. This declaration is done through the profile’s selectors. Each profile can have\n up to five selectors that contain a namespace and labels. A namespace is required for\n every selector. The label field consists of multiple optional key-value pairs. Pods that\n match the selectors are scheduled on Fargate. If a to-be-scheduled pod\n matches any of the selectors in the Fargate profile, then that pod is run\n on Fargate.

\n

When you create a Fargate profile, you must specify a pod execution\n role to use with the pods that are scheduled with the profile. This role is added to the\n cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the\n kubelet that is running on the Fargate infrastructure\n can register with your Amazon EKS cluster so that it can appear in your cluster\n as a node. The pod execution role also provides IAM permissions to the\n Fargate infrastructure to allow read access to Amazon ECR\n image repositories. For more information, see Pod\n Execution Role in the Amazon EKS User Guide.

\n

Fargate profiles are immutable. However, you can create a new updated\n profile to replace an existing profile and then delete the original after the updated\n profile has finished creating.

\n

If any Fargate profiles in a cluster are in the DELETING\n status, you must wait for that Fargate profile to finish deleting before\n you can create any other profiles in that cluster.

\n

For more information, see Fargate Profile in the\n Amazon EKS User Guide.

", + "smithy.api#documentation": "

Creates an Fargate profile for your Amazon EKS cluster. You\n must have at least one Fargate profile in a cluster to be able to run\n pods on Fargate.

\n

The Fargate profile allows an administrator to declare which pods run\n on Fargate and specify which pods run on which Fargate\n profile. This declaration is done through the profile’s selectors. Each profile can have\n up to five selectors that contain a namespace and labels. A namespace is required for\n every selector. The label field consists of multiple optional key-value pairs. Pods that\n match the selectors are scheduled on Fargate. If a to-be-scheduled pod\n matches any of the selectors in the Fargate profile, then that pod is run\n on Fargate.

\n

When you create a Fargate profile, you must specify a pod execution\n role to use with the pods that are scheduled with the profile. This role is added to the\n cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the\n kubelet that is running on the Fargate infrastructure\n can register with your Amazon EKS cluster so that it can appear in your cluster\n as a node. The pod execution role also provides IAM permissions to the\n Fargate infrastructure to allow read access to Amazon ECR\n image repositories. For more information, see Pod\n Execution Role in the Amazon EKS User Guide.

\n

Fargate profiles are immutable. However, you can create a new updated\n profile to replace an existing profile and then delete the original after the updated\n profile has finished creating.

\n

If any Fargate profiles in a cluster are in the DELETING\n status, you must wait for that Fargate profile to finish deleting before\n you can create any other profiles in that cluster.

\n

For more information, see Fargate Profile in the\n Amazon EKS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/fargate-profiles", @@ -3723,7 +3753,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a managed node group for an Amazon EKS cluster. You can only create a\n node group for your cluster that is equal to the current Kubernetes version for the\n cluster. All node groups are created with the latest AMI release version for the\n respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using\n a launch template. For more information about using launch templates, see Launch\n template support.

\n

An Amazon EKS managed node group is an Amazon EC2\n Auto Scaling group and associated Amazon EC2 instances that are managed by\n Amazon Web Services for an Amazon EKS cluster. Each node group uses a version\n of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed\n Node Groups in the Amazon EKS User Guide.

", + "smithy.api#documentation": "

Creates a managed node group for an Amazon EKS cluster. You can only create a\n node group for your cluster that is equal to the current Kubernetes version for the\n cluster. All node groups are created with the latest AMI release version for the\n respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using\n a launch template. For more information about using launch templates, see Launch\n template support.

\n

An Amazon EKS managed node group is an Amazon EC2\n Auto Scaling group and associated Amazon EC2 instances that are managed by\n Amazon Web Services for an Amazon EKS cluster. For more information, see\n Managed node groups in the Amazon EKS User Guide.

\n \n

Windows AMI types are only supported for commercial Regions that support Windows\n Amazon EKS.

\n ", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups", @@ -3758,7 +3788,7 @@ "diskSize": { "target": "com.amazonaws.eks#BoxedInteger", "traits": { - "smithy.api#documentation": "

The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB. If you specify launchTemplate, then don't specify diskSize,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows.\n If you specify launchTemplate, then don't specify diskSize, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "subnets": { @@ -3771,19 +3801,19 @@ "instanceTypes": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

Specify the instance types for a node group. If you specify a GPU instance type, be\n sure to specify AL2_x86_64_GPU with the amiType parameter. If\n you specify launchTemplate, then you can specify zero or one instance type\n in your launch template or you can specify 0-20 instance types for\n instanceTypes. If however, you specify an instance type in your launch\n template and specify any instanceTypes, the node group\n deployment will fail. If you don't specify an instance type in a launch template or for\n instanceTypes, then t3.medium is used, by default. If you\n specify Spot for capacityType, then we recommend specifying\n multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in\n the Amazon EKS User Guide.

" + "smithy.api#documentation": "

Specify the instance types for a node group. If you specify a GPU instance type, make\n sure to also specify an applicable GPU AMI type with the amiType parameter.\n If you specify launchTemplate, then you can specify zero or one instance\n type in your launch template or you can specify 0-20 instance types\n for instanceTypes. If however, you specify an instance type in your launch\n template and specify any instanceTypes, the node group\n deployment will fail. If you don't specify an instance type in a launch template or for\n instanceTypes, then t3.medium is used, by default. If you\n specify Spot for capacityType, then we recommend specifying\n multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in\n the Amazon EKS User Guide.

" } }, "amiType": { "target": "com.amazonaws.eks#AMITypes", "traits": { - "smithy.api#documentation": "

The AMI type for your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type. Non-GPU instances should use the\n AL2_x86_64 AMI type. Arm instances should use the\n AL2_ARM_64 AMI type. All types use the Amazon EKS optimized\n Amazon Linux 2 AMI. If you specify launchTemplate, and your launch template uses a custom AMI,\n then don't specify amiType, or the node group deployment\n will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI,\n then don't specify amiType, or the node group deployment\n will fail. If your launch template uses a Windows custom AMI, then add\n eks:kube-proxy-windows to your Windows nodes rolearn in\n the aws-auth\n ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "remoteAccess": { "target": "com.amazonaws.eks#RemoteAccessConfig", "traits": { - "smithy.api#documentation": "

The remote access (SSH) configuration to use with your node group. If you specify launchTemplate,\n then don't specify remoteAccess, or the node group deployment\n will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The remote access configuration to use with your node group.\n For Linux, the protocol is SSH. For Windows, the protocol is RDP.\n If you specify launchTemplate, then don't specify \n remoteAccess, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "nodeRole": { @@ -3845,7 +3875,7 @@ "releaseVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use with your node group.\n By default, the latest available AMI version for the node group's current Kubernetes\n version is used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use with your node group.\n By default, the latest available AMI version for the node group's current Kubernetes version\n is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } } } @@ -3887,7 +3917,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete an Amazon EKS add-on.

\n

When you remove the add-on, it will also be deleted from the cluster. You can always\n manually start an add-on on the cluster using the Kubernetes API.

", + "smithy.api#documentation": "

Delete an Amazon EKS add-on.

\n

When you remove the add-on, it will also be deleted from the cluster. You can always\n manually start an add-on on the cluster using the Kubernetes API.

", "smithy.api#http": { "method": "DELETE", "uri": "/clusters/{clusterName}/addons/{addonName}", @@ -3958,7 +3988,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the Amazon EKS cluster control plane.

\n

If you have active services in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see Deleting a\n Cluster in the Amazon EKS User Guide.

\n

If you have managed node groups or Fargate profiles attached to the\n cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.

", + "smithy.api#documentation": "

Deletes the Amazon EKS cluster control plane.

\n

If you have active services in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see Deleting a\n Cluster in the Amazon EKS User Guide.

\n

If you have managed node groups or Fargate profiles attached to the\n cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.

", "smithy.api#http": { "method": "DELETE", "uri": "/clusters/{name}", @@ -4013,7 +4043,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Fargate profile.

\n

When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match\n another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then\n they are not scheduled on Fargate and they may remain in a pending\n state.

\n

Only one Fargate profile in a cluster can be in the\n DELETING status at a time. You must wait for a Fargate\n profile to finish deleting before you can delete any other profiles in that\n cluster.

", + "smithy.api#documentation": "

Deletes an Fargate profile.

\n

When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match\n another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then\n they are not scheduled on Fargate and they may remain in a pending\n state.

\n

Only one Fargate profile in a cluster can be in the\n DELETING status at a time. You must wait for a Fargate\n profile to finish deleting before you can delete any other profiles in that\n cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/clusters/{clusterName}/fargate-profiles/{fargateProfileName}", @@ -4272,6 +4302,78 @@ } } }, + "com.amazonaws.eks#DescribeAddonConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeAddonConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeAddonConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns configuration options.

", + "smithy.api#http": { + "method": "GET", + "uri": "/addons/configuration-schemas", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeAddonConfigurationRequest": { + "type": "structure", + "members": { + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on. The name must match one of the names that \n DescribeAddonVersions\n returns.

", + "smithy.api#httpQuery": "addonName", + "smithy.api#required": {} + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .

", + "smithy.api#httpQuery": "addonVersion", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.eks#DescribeAddonConfigurationResponse": { + "type": "structure", + "members": { + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of the add-on.

" + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .

" + } + }, + "configurationSchema": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

A JSON schema that's used to validate the configuration values that you provide when\n an addon is created or updated.

" + } + } + } + }, "com.amazonaws.eks#DescribeAddonRequest": { "type": "structure", "members": { @@ -4355,7 +4457,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeAddonVersionsRequest where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeAddonVersionsRequest where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", "smithy.api#httpQuery": "nextToken" } }, @@ -4410,7 +4512,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeAddonVersionsResponse where maxResults was used\n and the results exceeded the value of that parameter. Pagination continues from the end\n of the previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeAddonVersionsResponse where maxResults was used\n and the results exceeded the value of that parameter. Pagination continues from the end\n of the previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } } } @@ -4438,7 +4540,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns descriptive information about an Amazon EKS cluster.

\n

The API server endpoint and certificate authority data returned by this operation are\n required for kubelet and kubectl to communicate with your\n Kubernetes API server. For more information, see Create a\n kubeconfig for Amazon EKS.

\n \n

The API server endpoint and certificate authority data aren't available until the\n cluster reaches the ACTIVE state.

\n ", + "smithy.api#documentation": "

Returns descriptive information about an Amazon EKS cluster.

\n

The API server endpoint and certificate authority data returned by this operation are\n required for kubelet and kubectl to communicate with your\n Kubernetes API server. For more information, see Create a\n kubeconfig for Amazon EKS.

\n \n

The API server endpoint and certificate authority data aren't available until the\n cluster reaches the ACTIVE state.

\n ", "smithy.api#http": { "method": "GET", "uri": "/clusters/{name}", @@ -4861,7 +4963,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns descriptive information about an update against your Amazon EKS\n cluster or associated managed node group or Amazon EKS add-on.

\n

When the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.

", + "smithy.api#documentation": "

Returns descriptive information about an update against your Amazon EKS\n cluster or associated managed node group or Amazon EKS add-on.

\n

When the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.

", "smithy.api#http": { "method": "GET", "uri": "/clusters/{name}/updates/{updateId}", @@ -5132,7 +5234,7 @@ "errorCode": { "target": "com.amazonaws.eks#ErrorCode", "traits": { - "smithy.api#documentation": "

A brief description of the error.

\n " + "smithy.api#documentation": "

A brief description of the error.

\n " } }, "errorMessage": { @@ -5446,7 +5548,7 @@ "code": { "target": "com.amazonaws.eks#NodegroupIssueCode", "traits": { - "smithy.api#documentation": "

A brief description of the error.

\n " + "smithy.api#documentation": "

A brief description of the error.

\n " } }, "message": { @@ -5478,13 +5580,13 @@ "serviceIpv4Cidr": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Don't specify a value if you select ipv6 for ipFamily. The CIDR block to assign Kubernetes service IP addresses from.\n If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16\n or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not\n overlap with resources in other networks that are peered or connected to your VPC. The\n block must meet the following requirements:

\n \n \n

You can only specify a custom CIDR block when you create a cluster and can't\n change this value once the cluster is created.

\n " + "smithy.api#documentation": "

Don't specify a value if you select ipv6 for ipFamily. The CIDR block to assign Kubernetes service IP addresses from.\n If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16\n or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not\n overlap with resources in other networks that are peered or connected to your VPC. The\n block must meet the following requirements:

\n \n \n

You can only specify a custom CIDR block when you create a cluster and can't\n change this value once the cluster is created.

\n " } }, "ipFamily": { "target": "com.amazonaws.eks#IpFamily", "traits": { - "smithy.api#documentation": "

Specify which IP family is used to assign Kubernetes pod and service IP addresses. If\n you don't specify a value, ipv4 is used by default. You can only specify an\n IP family when you create a cluster and can't change this value once the cluster is\n created. If you specify ipv6, the VPC and subnets that you specify for\n cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them. You can't\n specify ipv6 for clusters in China Regions.

\n

You can only specify ipv6 for 1.21 and later clusters that use version\n 1.10.1 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure\n that your VPC meets the requirements listed in the considerations listed in Assigning IPv6\n addresses to pods and services in the Amazon EKS User Guide.\n Kubernetes assigns services IPv6 addresses from the unique local address range\n (fc00::/7). You can't specify a custom IPv6 CIDR block. Pod addresses are assigned from\n the subnet's IPv6 CIDR.

" + "smithy.api#documentation": "

Specify which IP family is used to assign Kubernetes pod and service IP addresses. If\n you don't specify a value, ipv4 is used by default. You can only specify an\n IP family when you create a cluster and can't change this value once the cluster is\n created. If you specify ipv6, the VPC and subnets that you specify for\n cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them. You can't\n specify ipv6 for clusters in China Regions.

\n

You can only specify ipv6 for 1.21 and later clusters that use version\n 1.10.1 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure\n that your VPC meets the requirements listed in the considerations listed in Assigning IPv6\n addresses to pods and services in the Amazon EKS User Guide.\n Kubernetes assigns services IPv6 addresses from the unique local address range\n (fc00::/7). You can't specify a custom IPv6 CIDR block. Pod addresses are assigned from\n the subnet's IPv6 CIDR.

" } } }, @@ -5498,7 +5600,7 @@ "serviceIpv4Cidr": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The CIDR block that Kubernetes pod and service IP addresses are assigned from.\n Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node\n is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes\n assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this\n was specified, then it was specified when the cluster was created and it can't be\n changed.

" + "smithy.api#documentation": "

The CIDR block that Kubernetes pod and service IP addresses are assigned from. Kubernetes\n assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. If\n you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns\n addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR\n blocks. If this was specified, then it was specified when the cluster was created and it\n can't be changed.

" } }, "serviceIpv6Cidr": { @@ -5524,7 +5626,7 @@ "name": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template name or the launch template ID in the\n request, but not both.

" + "smithy.api#documentation": "

The name of the launch template.

\n

You must specify either the launch template name or the launch template ID in the\n request, but not both.

" } }, "version": { @@ -5536,12 +5638,12 @@ "id": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the launch template name in the\n request, but not both.

" + "smithy.api#documentation": "

The ID of the launch template.

\n

You must specify either the launch template ID or the launch template name in the\n request, but not both.

" } } }, "traits": { - "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n can't include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API\n Reference. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

\n

You must specify either the launch template ID or the launch template name in the\n request, but not both.

" + "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n can't include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API\n Reference. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

\n

You must specify either the launch template ID or the launch template name in the\n request, but not both.

" } }, "com.amazonaws.eks#ListAddons": { @@ -5605,7 +5707,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListAddonsRequest where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListAddonsRequest where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", "smithy.api#httpQuery": "nextToken" } } @@ -5632,7 +5734,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListAddonsResponse where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListAddonsResponse where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } } } @@ -5687,7 +5789,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListClusters request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListClusters request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", "smithy.api#httpQuery": "nextToken" } }, @@ -6343,7 +6445,7 @@ "labels": { "target": "com.amazonaws.eks#labelsMap", "traits": { - "smithy.api#documentation": "

The Kubernetes labels applied to the nodes in the node group.

\n \n

Only labels that are applied with the Amazon EKS API are shown here. There\n may be other Kubernetes labels applied to the nodes in this group.

\n " + "smithy.api#documentation": "

The Kubernetes labels applied to the nodes in the node group.

\n \n

Only labels that are applied with the Amazon EKS API are shown here. There\n may be other Kubernetes labels applied to the nodes in this group.

\n " } }, "taints": { @@ -6564,7 +6666,7 @@ "desiredSize": { "target": "com.amazonaws.eks#ZeroCapacity", "traits": { - "smithy.api#documentation": "

The current number of nodes that the managed node group should maintain.

\n \n

If you use Cluster Autoscaler, you shouldn't change the desiredSize value\n directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\n down.

\n \n

Whenever this parameter changes, the number of worker nodes in the node group is\n updated to the specified size. If this parameter is given a value that is smaller than\n the current number of running worker nodes, the necessary number of worker nodes are\n terminated to match the given value.\n \n When using CloudFormation, no action occurs if you remove this parameter from your CFN\n template.

\n

This parameter can be different from minSize in some cases, such as when starting with\n extra hosts for testing. This parameter can also be different when you want to start\n with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number\n if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is\n altered by Cluster Autoscaler (but can be out-of-date for short periods of time).\n Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than\n maxSize.

" + "smithy.api#documentation": "

The current number of nodes that the managed node group should maintain.

\n \n

If you use Cluster Autoscaler, you shouldn't change the desiredSize value\n directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\n down.

\n \n

Whenever this parameter changes, the number of worker nodes in the node group is\n updated to the specified size. If this parameter is given a value that is smaller than\n the current number of running worker nodes, the necessary number of worker nodes are\n terminated to match the given value.\n \n When using CloudFormation, no action occurs if you remove this parameter from your CFN\n template.

\n

This parameter can be different from minSize in some cases, such as when starting with\n extra hosts for testing. This parameter can also be different when you want to start\n with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number\n if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is\n altered by Cluster Autoscaler (but can be out-of-date for short periods of time).\n Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than\n maxSize.

" } } }, @@ -6826,7 +6928,7 @@ "controlPlaneInstanceType": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes\n that your cluster will have. For more information, see Capacity\n considerations in the Amazon EKS User Guide.

\n

The instance type that you specify is used for all Kubernetes control plane instances. The\n instance type can't be changed after cluster creation. The control plane is not\n automatically scaled by Amazon EKS.

\n

", + "smithy.api#documentation": "

The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes\n that your cluster will have. For more information, see Capacity\n considerations in the Amazon EKS User Guide.

\n

The instance type that you specify is used for all Kubernetes control plane instances. The\n instance type can't be changed after cluster creation. The control plane is not\n automatically scaled by Amazon EKS.

\n

", "smithy.api#required": {} } }, @@ -6927,7 +7029,7 @@ } ], "traits": { - "smithy.api#documentation": "

Connects a Kubernetes cluster to the Amazon EKS control plane.

\n

Any Kubernetes cluster can be connected to the Amazon EKS control plane to\n view current information about the cluster and its nodes.

\n

Cluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS\n control plane.

\n

Second, a Manifest containing the activationID and\n activationCode must be applied to the Kubernetes cluster through it's\n native provider to provide visibility.

\n \n

After the Manifest is updated and applied, then the connected cluster is visible to\n the Amazon EKS control plane. If the Manifest is not applied within three days,\n then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

", + "smithy.api#documentation": "

Connects a Kubernetes cluster to the Amazon EKS control plane.

\n

Any Kubernetes cluster can be connected to the Amazon EKS control plane to\n view current information about the cluster and its nodes.

\n

Cluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS\n control plane.

\n

Second, a Manifest containing the activationID and\n activationCode must be applied to the Kubernetes cluster through it's\n native provider to provide visibility.

\n

After the Manifest is updated and applied, then the connected cluster is visible to\n the Amazon EKS control plane. If the Manifest is not applied within three days,\n then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

", "smithy.api#http": { "method": "POST", "uri": "/cluster-registrations", @@ -6981,13 +7083,13 @@ "ec2SshKey": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 SSH key that provides access for SSH communication with the\n nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

" + "smithy.api#documentation": "

The Amazon EC2 SSH key name that provides access for SSH communication with\n the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For\n Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more\n information, see Amazon EC2 key pairs and Windows instances in\n the Amazon Elastic Compute Cloud User Guide for Windows Instances.

" } }, "sourceSecurityGroups": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The security groups that are allowed SSH access (port 22) to the nodes. If you specify\n an Amazon EC2 SSH key but do not specify a source security group when you create\n a managed node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0).\n For more information, see Security Groups for Your VPC in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

The security group IDs that are allowed SSH access (port 22) to the nodes. For\n Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't\n specify a source security group when you create a managed node group, then the port on\n the nodes is opened to the internet (0.0.0.0/0). For more information, see\n Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" } } }, @@ -7513,13 +7615,13 @@ "serviceAccountRoleArn": { "target": "com.amazonaws.eks#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

\n \n

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

\n \n

To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.

\n " } }, "resolveConflicts": { "target": "com.amazonaws.eks#ResolveConflicts", "traits": { - "smithy.api#documentation": "

How to resolve field value conflicts for an Amazon EKS add-on if you've\n changed a value from the Amazon EKS default value. Conflicts are handled based\n on the option you choose:

\n " + "smithy.api#documentation": "

How to resolve field value conflicts for an Amazon EKS add-on if you've\n changed a value from the Amazon EKS default value. Conflicts are handled based\n on the option you choose:

\n " } }, "clientRequestToken": { @@ -7528,6 +7630,12 @@ "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", "smithy.api#idempotencyToken": {} } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema in DescribeAddonConfiguration.

" + } } } }, @@ -7568,7 +7676,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an Amazon EKS cluster configuration. Your cluster continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your cluster update with the DescribeUpdate API\n operation.

\n

You can use this API operation to enable or disable exporting the Kubernetes control\n plane logs for your cluster to CloudWatch Logs. By default, cluster control plane\n logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n \n

You can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

\n \n

You can't update the subnets or security group IDs for an existing cluster.

\n \n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

", + "smithy.api#documentation": "

Updates an Amazon EKS cluster configuration. Your cluster continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your cluster update with the DescribeUpdate API\n operation.

\n

You can use this API operation to enable or disable exporting the Kubernetes control\n plane logs for your cluster to CloudWatch Logs. By default, cluster control plane\n logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n \n

You can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

\n \n

You can't update the subnets or security group IDs for an existing cluster.

\n \n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{name}/update-config", @@ -7593,7 +7701,7 @@ "logging": { "target": "com.amazonaws.eks#Logging", "traits": { - "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to\n CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n " + "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to\n CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n " } }, "clientRequestToken": { @@ -7642,7 +7750,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an Amazon EKS cluster to the specified Kubernetes version. Your\n cluster continues to function during the update. The response output includes an update\n ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

\n

If your cluster has managed node groups attached to it, all of your node groups’\n Kubernetes versions must match the cluster’s Kubernetes version in order to update the\n cluster to a new Kubernetes version.

", + "smithy.api#documentation": "

Updates an Amazon EKS cluster to the specified Kubernetes version. Your\n cluster continues to function during the update. The response output includes an update\n ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

\n

If your cluster has managed node groups attached to it, all of your node groups’\n Kubernetes versions must match the cluster’s Kubernetes version in order to update the\n cluster to a new Kubernetes version.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{name}/updates", @@ -7834,7 +7942,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the Kubernetes version or AMI version of an Amazon EKS managed node\n group.

\n

You can update a node group using a launch template only if the node group was\n originally deployed with a launch template. If you need to update a custom AMI in a node\n group that was deployed with a launch template, then update your custom AMI, specify the\n new ID in a new version of the launch template, and then update the node group to the\n new version of the launch template.

\n

If you update without a launch template, then you can update to the latest available\n AMI version of a node group's current Kubernetes version by not specifying a Kubernetes\n version in the request. You can update to the latest AMI version of your cluster's\n current Kubernetes version by specifying your cluster's Kubernetes version in the\n request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.

\n

You cannot roll back a node group to an earlier Kubernetes version or AMI\n version.

\n

When a node in a managed node group is terminated due to a scaling action or update,\n the pods in that node are drained first. Amazon EKS attempts to drain the nodes\n gracefully and will fail if it is unable to do so. You can force the update\n if Amazon EKS is unable to drain the nodes as a result of a pod disruption\n budget issue.

", + "smithy.api#documentation": "

Updates the Kubernetes version or AMI version of an Amazon EKS managed node\n group.

\n

You can update a node group using a launch template only if the node group was\n originally deployed with a launch template. If you need to update a custom AMI in a node\n group that was deployed with a launch template, then update your custom AMI, specify the\n new ID in a new version of the launch template, and then update the node group to the\n new version of the launch template.

\n

If you update without a launch template, then you can update to the latest available\n AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in\n the request. You can update to the latest AMI version of your cluster's current Kubernetes\n version by specifying your cluster's Kubernetes version in the request. For information about\n Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the\n Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

You cannot roll back a node group to an earlier Kubernetes version or AMI\n version.

\n

When a node in a managed node group is terminated due to a scaling action or update,\n the pods in that node are drained first. Amazon EKS attempts to drain the nodes\n gracefully and will fail if it is unable to do so. You can force the update\n if Amazon EKS is unable to drain the nodes as a result of a pod disruption\n budget issue.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-version", @@ -7870,7 +7978,7 @@ "releaseVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use for the update. By\n default, the latest available AMI version for the node group's Kubernetes version is\n used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use for the update. By\n default, the latest available AMI version for the node group's Kubernetes version is used.\n For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group update will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "launchTemplate": { diff --git a/codegen/sdk-codegen/aws-models/emr-serverless.2021-07-13.json b/codegen/sdk-codegen/aws-models/emr-serverless.2021-07-13.json index d14a7ee528d..9bc08fb2cdc 100644 --- a/codegen/sdk-codegen/aws-models/emr-serverless.2021-07-13.json +++ b/codegen/sdk-codegen/aws-models/emr-serverless.2021-07-13.json @@ -3826,4 +3826,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/gamesparks.2021-08-17.json b/codegen/sdk-codegen/aws-models/gamesparks.2021-08-17.json index 9d2aaae12e8..6b165c92d8e 100644 --- a/codegen/sdk-codegen/aws-models/gamesparks.2021-08-17.json +++ b/codegen/sdk-codegen/aws-models/gamesparks.2021-08-17.json @@ -4291,4 +4291,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json index 2851bec5df1..8b9661122b5 100644 --- a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json +++ b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json @@ -708,15 +708,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -979,9 +970,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -992,9 +983,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -1005,9 +996,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -1018,9 +1009,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -1031,9 +1022,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -1044,9 +1035,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -1057,9 +1048,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -1070,9 +1061,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -1083,9 +1074,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": true } }, { @@ -1096,9 +1087,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": false } }, { @@ -1109,9 +1100,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": true } }, { @@ -1122,9 +1113,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": false } }, { @@ -1135,9 +1126,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -1148,9 +1139,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -1161,9 +1152,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -1174,9 +1165,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -1187,9 +1178,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -1200,9 +1191,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -1213,9 +1204,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -1226,9 +1217,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -1239,9 +1230,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -1252,9 +1243,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -1265,9 +1256,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -1278,9 +1269,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -1291,9 +1282,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -1304,9 +1295,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -1317,9 +1308,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -1330,9 +1321,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -1343,9 +1334,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -1356,9 +1347,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -1369,9 +1360,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -1382,9 +1373,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -1395,9 +1386,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -1408,9 +1399,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -1421,9 +1412,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -1434,9 +1425,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -1447,9 +1438,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -1460,9 +1451,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -1473,9 +1464,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -1486,9 +1477,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -1499,9 +1490,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1512,9 +1503,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1525,9 +1516,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1538,9 +1529,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1551,9 +1542,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1564,9 +1555,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1577,9 +1568,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1590,9 +1581,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1603,9 +1594,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -1616,9 +1607,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -1629,9 +1620,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -1642,9 +1633,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -1655,9 +1646,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -1668,9 +1659,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -1681,9 +1672,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -1694,9 +1685,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -1707,9 +1698,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -1720,9 +1711,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -1733,9 +1724,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -1746,9 +1737,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -1759,9 +1750,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -1772,9 +1763,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -1785,9 +1776,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -1798,9 +1789,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -1811,9 +1802,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -1824,9 +1815,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -1837,9 +1828,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -1850,9 +1841,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -1863,9 +1854,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -1876,9 +1867,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -1889,9 +1880,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -1902,9 +1893,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -1915,9 +1906,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -1928,9 +1919,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -1941,9 +1932,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -1954,9 +1945,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -1967,9 +1958,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -1980,9 +1971,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -1993,9 +1984,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -2006,9 +1997,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -2019,9 +2010,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -2032,9 +2023,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -2045,9 +2036,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -2058,9 +2049,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -2071,9 +2062,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -2084,9 +2075,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -2097,9 +2088,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -2110,9 +2101,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -2123,9 +2114,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -2136,9 +2127,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -2149,9 +2140,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -2162,9 +2153,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -2175,9 +2166,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -2188,9 +2179,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -2201,9 +2192,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -2214,9 +2205,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -2225,9 +2216,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -2238,9 +2229,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -2249,9 +2240,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -2262,9 +2253,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -2275,9 +2266,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -2288,9 +2279,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -2301,9 +2292,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -2314,9 +2305,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -2327,9 +2318,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -2340,9 +2331,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -2353,9 +2344,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -2366,9 +2357,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -2379,9 +2370,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -2392,9 +2383,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -2405,9 +2396,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -2418,9 +2409,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -2431,9 +2422,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -2444,9 +2435,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -2457,9 +2448,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -2470,9 +2461,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -2481,9 +2472,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -2494,9 +2485,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -2505,9 +2496,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -2518,9 +2509,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -2531,9 +2522,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2543,9 +2534,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2555,9 +2546,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -2996,7 +2987,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of errors that can occur when registering partition indexes for an existing table.

\n\t\n\t

These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:

\n\t \n\t " + "smithy.api#documentation": "

A list of errors that can occur when registering partition indexes for an existing table.

\n

These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:

\n " } }, "com.amazonaws.glue#BackfillErrorCode": { @@ -4366,7 +4357,7 @@ "Status": { "target": "com.amazonaws.glue#BlueprintStatus", "traits": { - "smithy.api#documentation": "

The status of the blueprint registration.

\n\t\n\t " + "smithy.api#documentation": "

The status of the blueprint registration.

\n " } }, "ErrorMessage": { @@ -4454,7 +4445,7 @@ "State": { "target": "com.amazonaws.glue#BlueprintRunState", "traits": { - "smithy.api#documentation": "

The state of the blueprint run. Possible values are:

\n\t\n\t " + "smithy.api#documentation": "

The state of the blueprint run. Possible values are:

\n " } }, "StartedOn": { @@ -5853,7 +5844,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure containing the column name and column importance score for a column.

\n\t\n\t

Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.

" + "smithy.api#documentation": "

A structure containing the column name and column importance score for a column.

\n

Column importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.

" } }, "com.amazonaws.glue#ColumnImportanceList": { @@ -6350,7 +6341,7 @@ } }, "traits": { - "smithy.api#documentation": "

The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

\n\t\n\t

For more information, see Confusion matrix in Wikipedia.

" + "smithy.api#documentation": "

The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

\n

For more information, see Confusion matrix in Wikipedia.

" } }, "com.amazonaws.glue#Connection": { @@ -6434,7 +6425,7 @@ "ConnectionType": { "target": "com.amazonaws.glue#ConnectionType", "traits": { - "smithy.api#documentation": "

The type of the connection. Currently, these types are supported:

\n\t \n

SFTP is not supported.

", + "smithy.api#documentation": "

The type of the connection. Currently, these types are supported:

\n \n

SFTP is not supported.

", "smithy.api#required": {} } }, @@ -6485,12 +6476,12 @@ "AwsKmsKeyId": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

An KMS key that is used to encrypt the connection password.

\n\t\n

If connection password protection is enabled, the caller of CreateConnection\n and UpdateConnection needs at least kms:Encrypt permission on the\n specified KMS key, to encrypt passwords before storing them in the Data Catalog.

\n \n\t

You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

" + "smithy.api#documentation": "

An KMS key that is used to encrypt the connection password.

\n

If connection password protection is enabled, the caller of CreateConnection\n and UpdateConnection needs at least kms:Encrypt permission on the\n specified KMS key, to encrypt passwords before storing them in the Data Catalog.

\n

You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

" } } }, "traits": { - "smithy.api#documentation": "

The data structure used by the Data Catalog to encrypt the password as part of\n CreateConnection or UpdateConnection and store it in the\n ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog\n encryption or only password encryption.

\n\t\n\t

When a CreationConnection request arrives containing a password, the Data\n Catalog first encrypts the password using your KMS key. It then encrypts the whole\n connection object again if catalog encryption is also enabled.

\n \n

This encryption requires that you set KMS key permissions to enable or restrict access\n on the password key according to your security requirements. For example, you might want only\n administrators to have decrypt permission on the password key.

" + "smithy.api#documentation": "

The data structure used by the Data Catalog to encrypt the password as part of\n CreateConnection or UpdateConnection and store it in the\n ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog\n encryption or only password encryption.

\n

When a CreationConnection request arrives containing a password, the Data\n Catalog first encrypts the password using your KMS key. It then encrypts the whole\n connection object again if catalog encryption is also enabled.

\n

This encryption requires that you set KMS key permissions to enable or restrict access\n on the password key according to your security requirements. For example, you might want only\n administrators to have decrypt permission on the password key.

" } }, "com.amazonaws.glue#ConnectionProperties": { @@ -7342,13 +7333,13 @@ "FieldName": { "target": "com.amazonaws.glue#FieldName", "traits": { - "smithy.api#documentation": "

A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:

\n\t " + "smithy.api#documentation": "

A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:

\n " } }, "FilterOperator": { "target": "com.amazonaws.glue#FilterOperator", "traits": { - "smithy.api#documentation": "

A defined comparator that operates on the value. The available operators are:

\n\t " + "smithy.api#documentation": "

A defined comparator that operates on the value. The available operators are:

\n " } }, "FieldValue": { @@ -7775,7 +7766,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.

\n\t\n\t

Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.

" + "smithy.api#documentation": "

Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.

\n

Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.

" } }, "com.amazonaws.glue#CreateCustomEntityTypeRequest": { @@ -7798,7 +7789,7 @@ "ContextWords": { "target": "com.amazonaws.glue#ContextWords", "traits": { - "smithy.api#documentation": "

A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

\n\t\n\t

If no context words are passed only a regular expression is checked.

" + "smithy.api#documentation": "

A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

\n

If no context words are passed only a regular expression is checked.

" } } } @@ -7840,7 +7831,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data quality ruleset with DQDL rules applied to a specified Glue table.

\n\t\n\t

You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.

", + "smithy.api#documentation": "

Creates a data quality ruleset with DQDL rules applied to a specified Glue table.

\n

You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.

", "smithy.api#idempotent": {} } }, @@ -8037,7 +8028,7 @@ "PublicKeys": { "target": "com.amazonaws.glue#PublicKeysList", "traits": { - "smithy.api#documentation": "

A list of public keys to be used by the development endpoints for authentication. The use\n of this attribute is preferred over a single public key because the public keys allow you to\n have a different private key per client.

\n \n \n

If you previously created an endpoint with a public key, you must remove that key to be able\n to set a list of public keys. Call the UpdateDevEndpoint API with the public\n key content in the deletePublicKeys attribute, and the list of new keys in the\n addPublicKeys attribute.

\n " + "smithy.api#documentation": "

A list of public keys to be used by the development endpoints for authentication. The use\n of this attribute is preferred over a single public key because the public keys allow you to\n have a different private key per client.

\n \n

If you previously created an endpoint with a public key, you must remove that key to be able\n to set a list of public keys. Call the UpdateDevEndpoint API with the public\n key content in the deletePublicKeys attribute, and the list of new keys in the\n addPublicKeys attribute.

\n " } }, "NumberOfNodes": { @@ -8050,19 +8041,19 @@ "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t

Known issue: when a development endpoint is created with the G.2X \n WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

\n \n

Known issue: when a development endpoint is created with the G.2X\n WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" } }, "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } }, "NumberOfWorkers": { "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

\n\t\n\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

\n

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" } }, "ExtraPythonLibsS3Path": { @@ -8159,7 +8150,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" } }, "NumberOfWorkers": { @@ -8213,7 +8204,7 @@ "Arguments": { "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

The map of arguments used to configure this DevEndpoint.

\n\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The map of arguments used to configure this DevEndpoint.

\n

Valid arguments are:

\n \n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } } } @@ -8333,7 +8324,7 @@ "DefaultArguments": { "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.

\n

Job arguments may be logged. Do not pass plaintext secrets as arguments.\n Retrieve secrets from a Glue Connection, Secrets Manager or\n other secret management mechanism if you intend to keep them within the Job.\n

\n

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

\n\t \n

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

" + "smithy.api#documentation": "

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.

\n

Job arguments may be logged. Do not pass plaintext secrets as arguments.\n Retrieve secrets from a Glue Connection, Secrets Manager or\n other secret management mechanism if you intend to keep them within the Job.\n

\n

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

" } }, "NonOverridableArguments": { @@ -8362,7 +8353,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This parameter is deprecated. Use MaxCapacity instead.

\n\t\n

The number of Glue data processing units (DPUs) to allocate to this Job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

" + "smithy.api#documentation": "

This parameter is deprecated. Use MaxCapacity instead.

\n

The number of Glue data processing units (DPUs) to allocate to this Job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

" } }, "Timeout": { @@ -8374,7 +8365,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n\t\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n \n

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" + "smithy.api#documentation": "

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n \n

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" } }, "SecurityConfiguration": { @@ -8398,7 +8389,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } }, "NumberOfWorkers": { @@ -8410,7 +8401,7 @@ "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.

\n\t " + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.

\n " } }, "CodeGenConfigurationNodes": { @@ -8422,7 +8413,7 @@ "ExecutionClass": { "target": "com.amazonaws.glue#ExecutionClass", "traits": { - "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" } }, "SourceControlDetails": { @@ -8498,7 +8489,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Glue machine learning transform. This operation creates the transform and\n all the necessary parameters to train it.

\n\t\n\t

Call this operation as the first step in the process of using a machine learning transform\n (such as the FindMatches transform) for deduplicating data. You can provide an\n optional Description, in addition to the parameters that you want to use for your\n algorithm.

\n\n

You must also specify certain parameters for the tasks that Glue runs on your\n behalf as part of learning from your data and creating a high-quality machine learning\n transform. These parameters include Role, and optionally,\n AllocatedCapacity, Timeout, and MaxRetries. For more\n information, see Jobs.

" + "smithy.api#documentation": "

Creates an Glue machine learning transform. This operation creates the transform and\n all the necessary parameters to train it.

\n

Call this operation as the first step in the process of using a machine learning transform\n (such as the FindMatches transform) for deduplicating data. You can provide an\n optional Description, in addition to the parameters that you want to use for your\n algorithm.

\n

You must also specify certain parameters for the tasks that Glue runs on your\n behalf as part of learning from your data and creating a high-quality machine learning\n transform. These parameters include Role, and optionally,\n AllocatedCapacity, Timeout, and MaxRetries. For more\n information, see Jobs.

" } }, "com.amazonaws.glue#CreateMLTransformRequest": { @@ -8534,7 +8525,7 @@ "Role": { "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

\n\n\t\t ", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

\n ", "smithy.api#required": {} } }, @@ -8547,19 +8538,19 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n\t\t\n\t\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

\t \n \n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n " + "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n \n

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n " } }, "NumberOfWorkers": { "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when this task runs.

\n\t\n\t\t

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

" + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when this task runs.

\n

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

" } }, "Timeout": { @@ -8887,7 +8878,7 @@ "Compatibility": { "target": "com.amazonaws.glue#Compatibility", "traits": { - "smithy.api#documentation": "

The compatibility mode of the schema. The possible values are:

\n\t\n " + "smithy.api#documentation": "

The compatibility mode of the schema. The possible values are:

\n " } }, "Description": { @@ -9237,7 +9228,7 @@ "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.

\n\t " + "smithy.api#documentation": "

The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.

\n " } }, "SecurityConfiguration": { @@ -9856,7 +9847,7 @@ "ContextWords": { "target": "com.amazonaws.glue#ContextWords", "traits": { - "smithy.api#documentation": "

A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

\n\t\n\t

If no context words are passed only a regular expression is checked.

" + "smithy.api#documentation": "

A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

\n

If no context words are passed only a regular expression is checked.

" } } }, @@ -10994,7 +10985,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete the partition column statistics of a column.

\n\t\n\t

The Identity and Access Management (IAM) permission required for this operation is DeletePartition.

" + "smithy.api#documentation": "

Delete the partition column statistics of a column.

\n

The Identity and Access Management (IAM) permission required for this operation is DeletePartition.

" } }, "com.amazonaws.glue#DeleteColumnStatisticsForPartitionRequest": { @@ -11066,7 +11057,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves table statistics of columns.

\n\t\n\t

The Identity and Access Management (IAM) permission required for this operation is DeleteTable.

" + "smithy.api#documentation": "

Retrieves table statistics of columns.

\n

The Identity and Access Management (IAM) permission required for this operation is DeleteTable.

" } }, "com.amazonaws.glue#DeleteColumnStatisticsForTableRequest": { @@ -11824,7 +11815,7 @@ "Versions": { "target": "com.amazonaws.glue#VersionsString", "traits": { - "smithy.api#documentation": "

A version range may be supplied which may be of the format:

\n\t ", + "smithy.api#documentation": "

A version range may be supplied which may be of the format:

\n ", "smithy.api#required": {} } } @@ -12246,6 +12237,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether to write the manifest files to the Delta table path.

" } + }, + "CreateNativeDeltaTable": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.

" + } } }, "traits": { @@ -12339,19 +12336,19 @@ "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

Known issue: when a development endpoint is created with the G.2X \n WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" + "smithy.api#documentation": "

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

\n \n

Known issue: when a development endpoint is created with the G.2X\n WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" } }, "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } }, "NumberOfWorkers": { "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

\n\t\n\t\t

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated to the development endpoint.

\n

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" } }, "NumberOfNodes": { @@ -12376,7 +12373,7 @@ "ExtraPythonLibsS3Path": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in\n your DevEndpoint. Multiple values must be complete paths separated by a\n comma.

\n \n \n

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on\n C extensions, such as the pandas Python data\n analysis library, are not currently supported.

\n " + "smithy.api#documentation": "

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in\n your DevEndpoint. Multiple values must be complete paths separated by a\n comma.

\n \n

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on\n C extensions, such as the pandas Python data\n analysis library, are not currently supported.

\n " } }, "ExtraJarsS3Path": { @@ -12430,7 +12427,7 @@ "Arguments": { "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

A map of arguments used to configure the DevEndpoint.

\n

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

A map of arguments used to configure the DevEndpoint.

\n

Valid arguments are:

\n \n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } } }, @@ -12725,7 +12722,7 @@ "NullTextList": { "target": "com.amazonaws.glue#NullValueFields", "traits": { - "smithy.api#documentation": "

A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.

\n\n

The DropNullFields transform removes custom null values only if both the value of the null placeholder and the datatype match the data.

" + "smithy.api#documentation": "

A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.

\n

The DropNullFields transform removes custom null values only if both the value of the null placeholder and the datatype match the data.

" } } }, @@ -12829,13 +12826,13 @@ "scanAll": { "target": "com.amazonaws.glue#NullableBoolean", "traits": { - "smithy.api#documentation": "

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

\n\t\n\t

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

" + "smithy.api#documentation": "

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

\n

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

" } }, "scanRate": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

\n\t\n\t

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

" + "smithy.api#documentation": "

The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

\n

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

" } } }, @@ -13531,7 +13528,7 @@ "AreaUnderPRCurve": { "target": "com.amazonaws.glue#GenericBoundedDouble", "traits": { - "smithy.api#documentation": "

The area under the precision/recall curve (AUPRC) is a single number measuring the overall\n quality of the transform, that is independent of the choice made for precision vs. recall.\n Higher values indicate that you have a more attractive precision vs. recall tradeoff.

\n\t

For more information, see Precision and recall in Wikipedia.

" + "smithy.api#documentation": "

The area under the precision/recall curve (AUPRC) is a single number measuring the overall\n quality of the transform, that is independent of the choice made for precision vs. recall.\n Higher values indicate that you have a more attractive precision vs. recall tradeoff.

\n

For more information, see Precision and recall in Wikipedia.

" } }, "Precision": { @@ -13555,7 +13552,7 @@ "ConfusionMatrix": { "target": "com.amazonaws.glue#ConfusionMatrix", "traits": { - "smithy.api#documentation": "

The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

\n\t

For more information, see Confusion matrix in Wikipedia.

" + "smithy.api#documentation": "

The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

\n

For more information, see Confusion matrix in Wikipedia.

" } }, "ColumnImportances": { @@ -13581,13 +13578,13 @@ "PrecisionRecallTradeoff": { "target": "com.amazonaws.glue#GenericBoundedDouble", "traits": { - "smithy.api#documentation": "

The value selected when tuning your transform for a balance between precision and recall.\n A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a\n value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0\n means very low recall, and choosing values close to 0.0 results in very low precision.

\n\t\n\t

The precision metric indicates how often your model is correct when it predicts a match.

\n\t\n\t

The recall metric indicates that for an actual match, how often your model predicts the\n match.

" + "smithy.api#documentation": "

The value selected when tuning your transform for a balance between precision and recall.\n A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a\n value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0\n means very low recall, and choosing values close to 0.0 results in very low precision.

\n

The precision metric indicates how often your model is correct when it predicts a match.

\n

The recall metric indicates that for an actual match, how often your model predicts the\n match.

" } }, "AccuracyCostTradeoff": { "target": "com.amazonaws.glue#GenericBoundedDouble", "traits": { - "smithy.api#documentation": "

The value that is selected when tuning your transform for a balance between accuracy and\n cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0\n means a bias purely for accuracy, which typically results in a higher cost, sometimes\n substantially higher. A value of 0.0 means a bias purely for cost, which results in a less\n accurate FindMatches transform, sometimes with unacceptable accuracy.

\n\t\n\t

Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.

\n\t\n\t

Cost measures how many compute resources, and thus money, are consumed to run the\n transform.

" + "smithy.api#documentation": "

The value that is selected when tuning your transform for a balance between accuracy and\n cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0\n means a bias purely for accuracy, which typically results in a higher cost, sometimes\n substantially higher. A value of 0.0 means a bias purely for cost, which results in a less\n accurate FindMatches transform, sometimes with unacceptable accuracy.

\n

Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.

\n

Cost measures how many compute resources, and thus money, are consumed to run the\n transform.

" } }, "EnforceProvidedLabels": { @@ -14038,7 +14035,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves partition statistics of columns.

\n\t\n\t

The Identity and Access Management (IAM) permission required for this operation is GetPartition.

" + "smithy.api#documentation": "

Retrieves partition statistics of columns.

\n

The Identity and Access Management (IAM) permission required for this operation is GetPartition.

" } }, "com.amazonaws.glue#GetColumnStatisticsForPartitionRequest": { @@ -14123,7 +14120,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves table statistics of columns.

\n\t\n

The Identity and Access Management (IAM) permission required for this operation is GetTable.

" + "smithy.api#documentation": "

Retrieves table statistics of columns.

\n

The Identity and Access Management (IAM) permission required for this operation is GetTable.

" } }, "com.amazonaws.glue#GetColumnStatisticsForTableRequest": { @@ -15168,7 +15165,7 @@ "ResourceShareType": { "target": "com.amazonaws.glue#ResourceShareType", "traits": { - "smithy.api#documentation": "

Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.

\n\t\n\t " + "smithy.api#documentation": "

Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.

\n " } } } @@ -15408,7 +15405,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information on a job bookmark entry.

\n\t\n\t

For more information about enabling and using job bookmarks, see:

\n\t\n\t " + "smithy.api#documentation": "

Returns information on a job bookmark entry.

\n

For more information about enabling and using job bookmarks, see:

\n " } }, "com.amazonaws.glue#GetJobBookmarkRequest": { @@ -15797,7 +15794,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of runs for a machine learning transform. Machine learning task runs are\n asynchronous tasks that Glue runs on your behalf as part of various machine learning\n workflows. You can get a sortable, filterable list of machine learning task runs by calling\n GetMLTaskRuns with their parent transform's TransformID and other\n optional parameters as documented in this section.

\n\t\n\t

This operation returns a list of historic runs and must be paginated.

", + "smithy.api#documentation": "

Gets a list of runs for a machine learning transform. Machine learning task runs are\n asynchronous tasks that Glue runs on your behalf as part of various machine learning\n workflows. You can get a sortable, filterable list of machine learning task runs by calling\n GetMLTaskRuns with their parent transform's TransformID and other\n optional parameters as documented in this section.

\n

This operation returns a list of historic runs and must be paginated.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -15981,13 +15978,13 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " + "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n " } }, "NumberOfWorkers": { @@ -16376,7 +16373,7 @@ "Expression": { "target": "com.amazonaws.glue#PredicateString", "traits": { - "smithy.api#documentation": "

An expression that filters the partitions to be returned.

\n

The expression uses SQL syntax similar to the SQL WHERE filter clause. The\n SQL statement parser JSQLParser parses the expression.

\n

\n Operators: The following are the operators that you can use in the\n Expression API call:

\n
\n
=
\n
\n

Checks whether the values of the two operands are equal; if yes, then the condition becomes\n true.

\n

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

\n

(a = b) is not true.

\n
\n
< >
\n
\n

Checks whether the values of two operands are equal; if the values are not equal,\n then the condition becomes true.

\n

Example: (a < > b) is true.

\n
\n
>
\n
\n

Checks whether the value of the left operand is greater than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a > b) is not true.

\n
\n
<
\n
\n

Checks whether the value of the left operand is less than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a < b) is true.

\n
\n
>=
\n
\n

Checks whether the value of the left operand is greater than or equal to the value\n of the right operand; if yes, then the condition becomes true.

\n

Example: (a >= b) is not true.

\n
\n
<=
\n
\n

Checks whether the value of the left operand is less than or equal to the value of\n the right operand; if yes, then the condition becomes true.

\n

Example: (a <= b) is true.

\n
\n
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
\n
\n

Logical operators.

\n
\n
\n

\n Supported Partition Key Types: The following are the supported\n partition keys.

\n \n

If an type is encountered that is not valid, an exception is thrown.

\n

The following list shows the valid operators on each type. When you define a crawler, the\n partitionKey type is created as a STRING, to be compatible with the catalog\n partitions.

\n \n

\n Sample API Call:

" + "smithy.api#documentation": "

An expression that filters the partitions to be returned.

\n

The expression uses SQL syntax similar to the SQL WHERE filter clause. The\n SQL statement parser JSQLParser parses the expression.

\n

\n Operators: The following are the operators that you can use in the\n Expression API call:

\n
\n
=
\n
\n

Checks whether the values of the two operands are equal; if yes, then the condition becomes\n true.

\n

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

\n

(a = b) is not true.

\n
\n
< >
\n
\n

Checks whether the values of two operands are equal; if the values are not equal,\n then the condition becomes true.

\n

Example: (a < > b) is true.

\n
\n
>
\n
\n

Checks whether the value of the left operand is greater than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a > b) is not true.

\n
\n
<
\n
\n

Checks whether the value of the left operand is less than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a < b) is true.

\n
\n
>=
\n
\n

Checks whether the value of the left operand is greater than or equal to the value\n of the right operand; if yes, then the condition becomes true.

\n

Example: (a >= b) is not true.

\n
\n
<=
\n
\n

Checks whether the value of the left operand is less than or equal to the value of\n the right operand; if yes, then the condition becomes true.

\n

Example: (a <= b) is true.

\n
\n
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
\n
\n

Logical operators.

\n
\n
\n

\n Supported Partition Key Types: The following are the supported\n partition keys.

\n \n

If an type is encountered that is not valid, an exception is thrown.

\n

The following list shows the valid operators on each type. When you define a crawler, the\n partitionKey type is created as a STRING, to be compatible with the catalog\n partitions.

\n

\n Sample API Call:

" } }, "NextToken": { @@ -16495,7 +16492,7 @@ "AdditionalPlanOptionsMap": { "target": "com.amazonaws.glue#AdditionalPlanOptionsMap", "traits": { - "smithy.api#documentation": "

A map to hold additional optional key-value parameters.

\n\t\n\t

Currently, these key-value pairs are supported:

\n\t\n\t " + "smithy.api#documentation": "

A map to hold additional optional key-value parameters.

\n

Currently, these key-value pairs are supported:

\n " } } } @@ -16792,7 +16789,7 @@ "SchemaId": { "target": "com.amazonaws.glue#SchemaId", "traits": { - "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n\t ", + "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n ", "smithy.api#required": {} } }, @@ -16846,7 +16843,7 @@ "SchemaId": { "target": "com.amazonaws.glue#SchemaId", "traits": { - "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n\t ", + "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n ", "smithy.api#required": {} } } @@ -16970,7 +16967,7 @@ "SchemaId": { "target": "com.amazonaws.glue#SchemaId", "traits": { - "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n\t " + "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n " } }, "SchemaVersionId": { @@ -17067,7 +17064,7 @@ "SchemaId": { "target": "com.amazonaws.glue#SchemaId", "traits": { - "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n\t ", + "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n ", "smithy.api#required": {} } }, @@ -18736,7 +18733,7 @@ "AdditionalOptions": { "target": "com.amazonaws.glue#GlueTableAdditionalOptions", "traits": { - "smithy.api#documentation": "

Additional options for the table. Currently there are two keys supported:

\n\t\n\t " + "smithy.api#documentation": "

Additional options for the table. Currently there are two keys supported:

\n " } } }, @@ -19149,7 +19146,7 @@ "FilterPredicate": { "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "

Extra condition clause to filter data from source. For example:

\n\t\n\t

\n BillingCity='Mountain View'\n

\n\t\n\t

When using a query instead of a table name, you should validate that the query works with the specified filterPredicate.

" + "smithy.api#documentation": "

Extra condition clause to filter data from source. For example:

\n

\n BillingCity='Mountain View'\n

\n

When using a query instead of a table name, you should validate that the query works with the specified filterPredicate.

" } }, "PartitionColumn": { @@ -19610,7 +19607,7 @@ "EnableAdditionalMetadata": { "target": "com.amazonaws.glue#EnableAdditionalMetadata", "traits": { - "smithy.api#documentation": "

Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.

\n\t\n\t

If you do not need additional metadata, keep the field empty.

" + "smithy.api#documentation": "

Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.

\n

If you do not need additional metadata, keep the field empty.

" } } }, @@ -19707,7 +19704,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\t \n

The number of Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

\n\t

" + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n

The number of Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

\n

" } }, "Timeout": { @@ -19719,13 +19716,13 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\t\n\t

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:

\n \n

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" + "smithy.api#documentation": "

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:

\n \n

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" } }, "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.

\n\t " + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.

\n " } }, "NumberOfWorkers": { @@ -19749,7 +19746,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } }, "CodeGenConfigurationNodes": { @@ -19761,7 +19758,7 @@ "ExecutionClass": { "target": "com.amazonaws.glue#ExecutionClass", "traits": { - "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" } }, "SourceControlDetails": { @@ -20003,7 +20000,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of Glue data processing units (DPUs) allocated to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

" + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n

The number of Glue data processing units (DPUs) allocated to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

" } }, "ExecutionTime": { @@ -20016,13 +20013,13 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

\n \n

Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

\n

Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).

" } }, "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n " + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n " } }, "WorkerType": { @@ -20058,7 +20055,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } }, "DPUSeconds": { @@ -20070,7 +20067,7 @@ "ExecutionClass": { "target": "com.amazonaws.glue#ExecutionClass", "traits": { - "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" } } }, @@ -20208,7 +20205,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n \n

The number of Glue data processing units (DPUs) to allocate to this job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

" + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n

The number of Glue data processing units (DPUs) to allocate to this job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

" } }, "Timeout": { @@ -20220,13 +20217,13 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.

\n \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\t \n\t \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n\n \t\t\n\t

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" + "smithy.api#documentation": "

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.

\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n \n

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" } }, "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.

\n\t " + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.

\n " } }, "NumberOfWorkers": { @@ -20250,7 +20247,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" } }, "CodeGenConfigurationNodes": { @@ -20262,7 +20259,7 @@ "ExecutionClass": { "target": "com.amazonaws.glue#ExecutionClass", "traits": { - "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" } }, "SourceControlDetails": { @@ -20894,7 +20891,7 @@ "CrawlerLineageSettings": { "target": "com.amazonaws.glue#CrawlerLineageSettings", "traits": { - "smithy.api#documentation": "

Specifies whether data lineage is enabled for the crawler. Valid values are:

\n\t\n\t " + "smithy.api#documentation": "

Specifies whether data lineage is enabled for the crawler. Valid values are:

\n " } } }, @@ -20984,7 +20981,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the names of all crawler resources in this Amazon Web Services account, or the\n resources with the specified tag. This operation allows you to see which\n resources are available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", + "smithy.api#documentation": "

Retrieves the names of all crawler resources in this Amazon Web Services account, or the\n resources with the specified tag. This operation allows you to see which\n resources are available in your account, and their names.

\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -21052,7 +21049,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.

\n\t\n\t

You may use this API to:

\n\t " + "smithy.api#documentation": "

Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.

\n

You may use this API to:

\n " } }, "com.amazonaws.glue#ListCrawlsRequest": { @@ -21469,7 +21466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the\n resources with the specified tag. This operation allows you to see which resources are\n available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", + "smithy.api#documentation": "

Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the\n resources with the specified tag. This operation allows you to see which resources are\n available in your account, and their names.

\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -21540,7 +21537,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

\n\t\n\t

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", + "smithy.api#documentation": "

Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -21773,7 +21770,7 @@ "SchemaId": { "target": "com.amazonaws.glue#SchemaId", "traits": { - "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n\t ", + "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n ", "smithy.api#required": {} } }, @@ -22059,7 +22056,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", + "smithy.api#documentation": "

Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -22397,7 +22394,7 @@ "Role": { "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

\n\n\t\t " + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

\n " } }, "GlueVersion": { @@ -22409,19 +22406,19 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n\t\t\n\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t \n\t\n\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n " + "smithy.api#documentation": "

The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.

\n \n

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n " } }, "NumberOfWorkers": { "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a task of the transform runs.

\n\t\n\t

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

" + "smithy.api#documentation": "

The number of workers of a defined workerType that are allocated when a task of the transform runs.

\n

If WorkerType is set, then NumberOfWorkers is required (and vice versa).

" } }, "Timeout": { @@ -22468,7 +22465,7 @@ "MlUserDataEncryptionMode": { "target": "com.amazonaws.glue#MLUserDataEncryptionModeString", "traits": { - "smithy.api#documentation": "

The encryption mode applied to user data. Valid values are:

\n\t\n\t ", + "smithy.api#documentation": "

The encryption mode applied to user data. Valid values are:

\n ", "smithy.api#required": {} } }, @@ -22562,7 +22559,7 @@ "Children": { "target": "com.amazonaws.glue#Mappings", "traits": { - "smithy.api#documentation": "

Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping, but its FromPath will be the parent's FromPath plus the FromPath from this structure.

\n \n

For the children part, suppose you have the structure:

\n\t\n\t

\n {\n \"FromPath\": \"OuterStructure\",\n \"ToKey\": \"OuterStructure\",\n \"ToType\": \"Struct\",\n \"Dropped\": false,\n \"Chidlren\": [{\n \"FromPath\": \"inner\",\n \"ToKey\": \"inner\",\n \"ToType\": \"Double\",\n \"Dropped\": false,\n }]\n}\n

\n\n

You can specify a Mapping that looks like:

\n\t\n\t

\n {\n \"FromPath\": \"OuterStructure\",\n \"ToKey\": \"OuterStructure\",\n \"ToType\": \"Struct\",\n \"Dropped\": false,\n \"Chidlren\": [{\n \"FromPath\": \"inner\",\n \"ToKey\": \"inner\",\n \"ToType\": \"Double\",\n \"Dropped\": false,\n }]\n}\n

" + "smithy.api#documentation": "

Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping, but its FromPath will be the parent's FromPath plus the FromPath from this structure.

\n

For the children part, suppose you have the structure:

\n

\n {\n \"FromPath\": \"OuterStructure\",\n \"ToKey\": \"OuterStructure\",\n \"ToType\": \"Struct\",\n \"Dropped\": false,\n \"Chidlren\": [{\n \"FromPath\": \"inner\",\n \"ToKey\": \"inner\",\n \"ToType\": \"Double\",\n \"Dropped\": false,\n }]\n}\n

\n

You can specify a Mapping that looks like:

\n

\n {\n \"FromPath\": \"OuterStructure\",\n \"ToKey\": \"OuterStructure\",\n \"ToType\": \"Struct\",\n \"Dropped\": false,\n \"Chidlren\": [{\n \"FromPath\": \"inner\",\n \"ToKey\": \"inner\",\n \"ToType\": \"Double\",\n \"Dropped\": false,\n }]\n}\n

" } } }, @@ -22888,7 +22885,7 @@ "ScanAll": { "target": "com.amazonaws.glue#NullableBoolean", "traits": { - "smithy.api#documentation": "

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

\n\t\n\t

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

" + "smithy.api#documentation": "

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

\n

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.

" } } }, @@ -23754,7 +23751,7 @@ "IndexStatus": { "target": "com.amazonaws.glue#PartitionIndexStatus", "traits": { - "smithy.api#documentation": "

The status of the partition index.

\n\t\n\t

The possible statuses are:

\n\t ", + "smithy.api#documentation": "

The status of the partition index.

\n

The possible statuses are:

\n ", "smithy.api#required": {} } }, @@ -23822,7 +23819,7 @@ "Values": { "target": "com.amazonaws.glue#ValueStringList", "traits": { - "smithy.api#documentation": "

The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

\n\t\n\t

The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.

" + "smithy.api#documentation": "

The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

\n

The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.

" } }, "LastAccessTime": { @@ -24765,7 +24762,7 @@ "RecrawlBehavior": { "target": "com.amazonaws.glue#RecrawlBehavior", "traits": { - "smithy.api#documentation": "

Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.

\n\t\n\t

A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.

\n \n

A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.

\n\t\n\t

A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.

" + "smithy.api#documentation": "

Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.

\n

A value of CRAWL_EVERYTHING specifies crawling the entire dataset again.

\n

A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.

\n

A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.

" } } }, @@ -24897,7 +24894,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.

\n

If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.

\n\t

If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.

" + "smithy.api#documentation": "

Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.

\n

If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.

\n

If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.

" } }, "com.amazonaws.glue#RegisterSchemaVersionInput": { @@ -24906,7 +24903,7 @@ "SchemaId": { "target": "com.amazonaws.glue#SchemaId", "traits": { - "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n\t ", + "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n ", "smithy.api#required": {} } }, @@ -25232,7 +25229,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resets a bookmark entry.

\n\t\n\t

For more information about enabling and using job bookmarks, see:

\n\t\n\t " + "smithy.api#documentation": "

Resets a bookmark entry.

\n

For more information about enabling and using job bookmarks, see:

\n " } }, "com.amazonaws.glue#ResetJobBookmarkRequest": { @@ -26701,13 +26698,13 @@ "Filters": { "target": "com.amazonaws.glue#SearchPropertyPredicates", "traits": { - "smithy.api#documentation": "

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

\n\t\n\t

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

" + "smithy.api#documentation": "

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

\n

The Comparator member of the PropertyPredicate struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name, a fuzzy match algorithm is used. The Key field (for example, the value of the Name field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value member of PropertyPredicate. For example, if Key=Name and Value=link, tables named customer-link and xx-link-yy are returned, but xxlinkyy is not returned.

" } }, "SearchText": { "target": "com.amazonaws.glue#ValueString", "traits": { - "smithy.api#documentation": "

A string used for a text search.

\n\t

Specifying a value in quotes filters based on an exact match to the value.

" + "smithy.api#documentation": "

A string used for a text search.

\n

Specifying a value in quotes filters based on an exact match to the value.

" } }, "SortCriteria": { @@ -26725,7 +26722,7 @@ "ResourceShareType": { "target": "com.amazonaws.glue#ResourceShareType", "traits": { - "smithy.api#documentation": "

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

\n\t\n\t " + "smithy.api#documentation": "

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

\n " } } } @@ -27407,7 +27404,7 @@ "SqlAliases": { "target": "com.amazonaws.glue#SqlAliases", "traits": { - "smithy.api#documentation": "

A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named \"MyDataSource\". If you specify From as MyDataSource, and Alias as SqlName, then in your SQL you can do:

\n\n

\n select *\nfrom SqlName\n

\n\n

and that gets data from MyDataSource.

", + "smithy.api#documentation": "

A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named \"MyDataSource\". If you specify From as MyDataSource, and Alias as SqlName, then in your SQL you can do:

\n

\n select *\nfrom SqlName\n

\n

and that gets data from MyDataSource.

", "smithy.api#required": {} } }, @@ -27932,7 +27929,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables you to provide additional labels (examples of truth) to be used to teach the\n machine learning transform and improve its quality. This API operation is generally used as\n part of the active learning workflow that starts with the\n StartMLLabelingSetGenerationTaskRun call and that ultimately results in\n improving the quality of your machine learning transform.

\n\n

After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning\n will have generated a series of questions for humans to answer. (Answering these questions is\n often called 'labeling' in the machine learning workflows). In the case of the\n FindMatches transform, these questions are of the form, “What is the correct\n way to group these rows together into groups composed entirely of matching records?” After the\n labeling process is finished, users upload their answers/labels with a call to\n StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes,\n all future runs of the machine learning transform use the new and improved labels and perform\n a higher-quality transformation.

\n\n

By default, StartMLLabelingSetGenerationTaskRun continually learns from and\n combines all labels that you upload unless you set Replace to true. If you set\n Replace to true, StartImportLabelsTaskRun deletes and forgets all\n previously uploaded labels and learns only from the exact set that you upload. Replacing\n labels can be helpful if you realize that you previously uploaded incorrect labels, and you\n believe that they are having a negative effect on your transform quality.

\n\n

You can check on the status of your task run by calling the GetMLTaskRun\n operation.

" + "smithy.api#documentation": "

Enables you to provide additional labels (examples of truth) to be used to teach the\n machine learning transform and improve its quality. This API operation is generally used as\n part of the active learning workflow that starts with the\n StartMLLabelingSetGenerationTaskRun call and that ultimately results in\n improving the quality of your machine learning transform.

\n

After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning\n will have generated a series of questions for humans to answer. (Answering these questions is\n often called 'labeling' in the machine learning workflows). In the case of the\n FindMatches transform, these questions are of the form, “What is the correct\n way to group these rows together into groups composed entirely of matching records?” After the\n labeling process is finished, users upload their answers/labels with a call to\n StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes,\n all future runs of the machine learning transform use the new and improved labels and perform\n a higher-quality transformation.

\n

By default, StartMLLabelingSetGenerationTaskRun continually learns from and\n combines all labels that you upload unless you set Replace to true. If you set\n Replace to true, StartImportLabelsTaskRun deletes and forgets all\n previously uploaded labels and learns only from the exact set that you upload. Replacing\n labels can be helpful if you realize that you previously uploaded incorrect labels, and you\n believe that they are having a negative effect on your transform quality.

\n

You can check on the status of your task run by calling the GetMLTaskRun\n operation.

" } }, "com.amazonaws.glue#StartImportLabelsTaskRunRequest": { @@ -28033,19 +28030,19 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of Glue data processing units (DPUs) to allocate to this JobRun.\n You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

" + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n

The number of Glue data processing units (DPUs) to allocate to this JobRun.\n You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

" } }, "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

\n \n

Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

\n

Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).

" } }, "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, or an Apache Spark ETL job:

\n " + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, or an Apache Spark ETL job:

\n " } }, "SecurityConfiguration": { @@ -28075,7 +28072,7 @@ "ExecutionClass": { "target": "com.amazonaws.glue#ExecutionClass", "traits": { - "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n\t\n\t

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" + "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" } } } @@ -28120,7 +28117,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a task to estimate the quality of the transform.

\n\t\n\t

When you provide label sets as examples of truth, Glue machine learning uses some of\n those examples to learn from them. The rest of the labels are used as a test to estimate\n quality.

\n\t\n\t

Returns a unique identifier for the run. You can call GetMLTaskRun to get more\n information about the stats of the EvaluationTaskRun.

" + "smithy.api#documentation": "

Starts a task to estimate the quality of the transform.

\n

When you provide label sets as examples of truth, Glue machine learning uses some of\n those examples to learn from them. The rest of the labels are used as a test to estimate\n quality.

\n

Returns a unique identifier for the run. You can call GetMLTaskRun to get more\n information about the stats of the EvaluationTaskRun.

" } }, "com.amazonaws.glue#StartMLEvaluationTaskRunRequest": { @@ -28172,7 +28169,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the active learning workflow for your machine learning transform to improve the\n transform's quality by generating label sets and adding labels.

\n\t\n\t

When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have\n generated a \"labeling set\" or a set of questions for humans to answer.

\n \n

In the case of the FindMatches transform, these questions are of the form,\n “What is the correct way to group these rows together into groups composed entirely of\n matching records?”

\n \n

After the labeling process is finished, you can upload your labels with a call to\n StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes,\n all future runs of the machine learning transform will use the new and improved labels and\n perform a higher-quality transformation.

" + "smithy.api#documentation": "

Starts the active learning workflow for your machine learning transform to improve the\n transform's quality by generating label sets and adding labels.

\n

When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have\n generated a \"labeling set\" or a set of questions for humans to answer.

\n

In the case of the FindMatches transform, these questions are of the form,\n “What is the correct way to group these rows together into groups composed entirely of\n matching records?”

\n

After the labeling process is finished, you can upload your labels with a call to\n StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes,\n all future runs of the machine learning transform will use the new and improved labels and\n perform a higher-quality transformation.

" } }, "com.amazonaws.glue#StartMLLabelingSetGenerationTaskRunRequest": { @@ -28860,7 +28857,7 @@ "SchemaReference": { "target": "com.amazonaws.glue#SchemaReference", "traits": { - "smithy.api#documentation": "

An object that references a schema stored in the Glue Schema Registry.

\n\t\n\t

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

" + "smithy.api#documentation": "

An object that references a schema stored in the Glue Schema Registry.

\n

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

" } } }, @@ -29002,7 +28999,7 @@ "PartitionKeys": { "target": "com.amazonaws.glue#ColumnList", "traits": { - "smithy.api#documentation": "

A list of columns by which the table is partitioned. Only primitive\n types are supported as partition keys.

\n\t

When you create a table used by Amazon Athena, and you do not specify any\n partitionKeys, you must at least set the value of partitionKeys to\n an empty list. For example:

\n

\n \"PartitionKeys\": []\n

" + "smithy.api#documentation": "

A list of columns by which the table is partitioned. Only primitive\n types are supported as partition keys.

\n

When you create a table used by Amazon Athena, and you do not specify any\n partitionKeys, you must at least set the value of partitionKeys to\n an empty list. For example:

\n

\n \"PartitionKeys\": []\n

" } }, "ViewOriginalText": { @@ -29167,7 +29164,7 @@ "PartitionKeys": { "target": "com.amazonaws.glue#ColumnList", "traits": { - "smithy.api#documentation": "

A list of columns by which the table is partitioned. Only primitive\n types are supported as partition keys.

\n\t

When you create a table used by Amazon Athena, and you do not specify any\n partitionKeys, you must at least set the value of partitionKeys to\n an empty list. For example:

\n

\n \"PartitionKeys\": []\n

" + "smithy.api#documentation": "

A list of columns by which the table is partitioned. Only primitive\n types are supported as partition keys.

\n

When you create a table used by Amazon Athena, and you do not specify any\n partitionKeys, you must at least set the value of partitionKeys to\n an empty list. For example:

\n

\n \"PartitionKeys\": []\n

" } }, "ViewOriginalText": { @@ -29806,7 +29803,7 @@ } }, "traits": { - "smithy.api#documentation": "

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

\n \n\t

Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.

" + "smithy.api#documentation": "

The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

\n

Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.

" } }, "com.amazonaws.glue#TransformFilterCriteria": { @@ -29889,7 +29886,7 @@ "TransformType": { "target": "com.amazonaws.glue#TransformType", "traits": { - "smithy.api#documentation": "

The type of machine learning transform.

\n\t

For information about the types of machine learning transforms, see Creating Machine Learning Transforms.

", + "smithy.api#documentation": "

The type of machine learning transform.

\n

For information about the types of machine learning transforms, see Creating Machine Learning Transforms.

", "smithy.api#required": {} } }, @@ -30302,7 +30299,7 @@ "UnionType": { "target": "com.amazonaws.glue#UnionType", "traits": { - "smithy.api#documentation": "

Indicates the type of Union transform.

\n\t\n\t

Specify ALL to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.

\n\n

Specify DISTINCT to remove duplicate rows in the resulting DynamicFrame.

", + "smithy.api#documentation": "

Indicates the type of Union transform.

\n

Specify ALL to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.

\n

Specify DISTINCT to remove duplicate rows in the resulting DynamicFrame.

", "smithy.api#required": {} } } @@ -30564,7 +30561,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates partition statistics of columns.

\n\t\n

The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.

" + "smithy.api#documentation": "

Creates or updates partition statistics of columns.

\n

The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.

" } }, "com.amazonaws.glue#UpdateColumnStatisticsForPartitionRequest": { @@ -30643,7 +30640,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates table statistics of columns.

\n\t\n\t

The Identity and Access Management (IAM) permission required for this operation is UpdateTable.

" + "smithy.api#documentation": "

Creates or updates table statistics of columns.

\n

The Identity and Access Management (IAM) permission required for this operation is UpdateTable.

" } }, "com.amazonaws.glue#UpdateColumnStatisticsForTableRequest": { @@ -31221,7 +31218,7 @@ "AddArguments": { "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

The map of arguments to add the map of arguments used to configure the\n DevEndpoint.

\n\t\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The map of arguments to add the map of arguments used to configure the\n DevEndpoint.

\n

Valid arguments are:

\n \n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } } } @@ -31324,7 +31321,7 @@ } ], "traits": { - "smithy.api#documentation": "

Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.

\n\t\n\t

This API supports optional parameters which take in the repository information.

" + "smithy.api#documentation": "

Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.

\n

This API supports optional parameters which take in the repository information.

" } }, "com.amazonaws.glue#UpdateJobFromSourceControlRequest": { @@ -31474,7 +31471,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.

\n\t\n

After calling this operation, you can call the StartMLEvaluationTaskRun\n operation to assess how well your new parameters achieved your goals (such as improving the\n quality of your machine learning transform, or making it more cost-effective).

" + "smithy.api#documentation": "

Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.

\n

After calling this operation, you can call the StartMLEvaluationTaskRun\n operation to assess how well your new parameters achieved your goals (such as improving the\n quality of your machine learning transform, or making it more cost-effective).

" } }, "com.amazonaws.glue#UpdateMLTransformRequest": { @@ -31520,13 +31517,13 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n\t " + "smithy.api#documentation": "

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

\n " } }, "NumberOfWorkers": { @@ -31622,7 +31619,7 @@ "PartitionInput": { "target": "com.amazonaws.glue#PartitionInput", "traits": { - "smithy.api#documentation": "

The new partition object to update the partition to.

\n\t\n\t

The Values property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.

", + "smithy.api#documentation": "

The new partition object to update the partition to.

\n

The Values property can't be changed. If you want to change the partition key values for a partition, delete and recreate the partition.

", "smithy.api#required": {} } } @@ -31723,7 +31720,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the description, compatibility setting, or version checkpoint for a schema set.

\n\t

For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.

\n

If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.

\n\t

This update will happen only if the schema is in the AVAILABLE state.

" + "smithy.api#documentation": "

Updates the description, compatibility setting, or version checkpoint for a schema set.

\n

For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.

\n

If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.

\n

This update will happen only if the schema is in the AVAILABLE state.

" } }, "com.amazonaws.glue#UpdateSchemaInput": { @@ -31732,7 +31729,7 @@ "SchemaId": { "target": "com.amazonaws.glue#SchemaId", "traits": { - "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n\t ", + "smithy.api#documentation": "

This is a wrapper structure to contain schema identity fields. The structure contains:

\n ", "smithy.api#required": {} } }, @@ -31811,7 +31808,7 @@ } ], "traits": { - "smithy.api#documentation": "

Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.

\n\n\t

This API supports optional parameters which take in the repository information.

" + "smithy.api#documentation": "

Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.

\n

This API supports optional parameters which take in the repository information.

" } }, "com.amazonaws.glue#UpdateSourceControlFromJobRequest": { diff --git a/codegen/sdk-codegen/aws-models/grafana.2020-08-18.json b/codegen/sdk-codegen/aws-models/grafana.2020-08-18.json index 7b127840365..e5c7b4f5a79 100644 --- a/codegen/sdk-codegen/aws-models/grafana.2020-08-18.json +++ b/codegen/sdk-codegen/aws-models/grafana.2020-08-18.json @@ -3908,4 +3908,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/groundstation.2019-05-23.json b/codegen/sdk-codegen/aws-models/groundstation.2019-05-23.json index 615d64cd552..0c3c487a010 100644 --- a/codegen/sdk-codegen/aws-models/groundstation.2019-05-23.json +++ b/codegen/sdk-codegen/aws-models/groundstation.2019-05-23.json @@ -5539,4 +5539,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json b/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json index 4aea93404c2..c3e1591561c 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json +++ b/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json @@ -1084,7 +1084,7 @@ "Name": { "target": "com.amazonaws.guardduty#FilterName", "traits": { - "smithy.api#documentation": "

The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

", + "smithy.api#documentation": "

The name of the filter. Valid characters include period (.), underscore (_), \n dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.

", "smithy.api#jsonName": "name", "smithy.api#required": {} } @@ -1092,7 +1092,7 @@ "Description": { "target": "com.amazonaws.guardduty#FilterDescription", "traits": { - "smithy.api#documentation": "

The description of the filter.

", + "smithy.api#documentation": "

The description of the filter. Valid special characters include period (.), underscore (_), dash (-), \n and whitespace. The new line character is considered to be an invalid input for description.

", "smithy.api#jsonName": "description" } }, @@ -4977,14 +4977,14 @@ "name": "guardduty" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, and DNS logs.\n It uses threat intelligence\n feeds (such as lists of malicious IPs and domains) and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect\n compromised EC2 instances that serve malware or mine bitcoin.

\n

GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise. Some examples\n of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region\n that has never been used, or unusual API calls like a password policy change to reduce\n password strength.

\n

GuardDuty informs you of the status of your Amazon Web Services environment by producing security findings\n that you can view in the GuardDuty console or through Amazon CloudWatch events. For more\n information, see the \n Amazon\n GuardDuty User Guide\n .

", + "smithy.api#documentation": "

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, DNS logs, and Amazon EBS volume data.\n It uses threat intelligence\n feeds, such as lists of malicious IPs and domains, and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, domains, or presence of malware on your \n Amazon EC2 instances and container workloads. For example, GuardDuty can detect\n compromised EC2 instances and container workloads serving malware, or mining bitcoin.

\n

GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such \n as unauthorized infrastructure deployments like EC2 instances deployed in a Region\n that has never been used, or unusual API calls like a password policy change to reduce\n password strength.

\n

GuardDuty informs you about the status of your Amazon Web Services environment by producing \n security findings that you can view in the GuardDuty console or through Amazon EventBridge. \n For more information, see the \n Amazon\n GuardDuty User Guide\n .

", "smithy.api#title": "Amazon GuardDuty", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -5033,15 +5033,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -5329,9 +5320,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-south-1" } }, { @@ -5342,9 +5333,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-south-1" } }, { @@ -5355,9 +5346,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-south-1" } }, { @@ -5368,9 +5359,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-south-1" } }, { @@ -5381,9 +5372,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-south-1" } }, { @@ -5394,9 +5385,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-south-1" } }, { @@ -5407,9 +5398,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-south-1" } }, { @@ -5420,9 +5411,9 @@ } }, "params": { - "Region": "eu-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-south-1" } }, { @@ -5433,9 +5424,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-gov-east-1" } }, { @@ -5446,9 +5437,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-gov-east-1" } }, { @@ -5459,9 +5450,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-gov-east-1" } }, { @@ -5472,9 +5463,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-gov-east-1" } }, { @@ -5485,9 +5476,9 @@ } }, "params": { - "Region": "me-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "me-central-1" } }, { @@ -5498,9 +5489,9 @@ } }, "params": { - "Region": "me-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "me-central-1" } }, { @@ -5511,9 +5502,9 @@ } }, "params": { - "Region": "me-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "me-central-1" } }, { @@ -5524,9 +5515,9 @@ } }, "params": { - "Region": "me-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "me-central-1" } }, { @@ -5537,9 +5528,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -5550,9 +5541,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -5563,9 +5554,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -5576,9 +5567,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -5589,9 +5580,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -5602,9 +5593,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -5615,9 +5606,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -5628,9 +5619,61 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.eu-central-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-central-2" + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.eu-central-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-central-2" + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty.eu-central-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-central-2" + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.eu-central-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-central-2" } }, { @@ -5641,9 +5684,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-1" } }, { @@ -5654,9 +5697,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-1" } }, { @@ -5667,9 +5710,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-1" } }, { @@ -5680,9 +5723,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-1" } }, { @@ -5693,9 +5736,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -5706,9 +5749,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -5719,9 +5762,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -5732,9 +5775,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -5745,9 +5788,9 @@ } }, "params": { - "Region": "af-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "af-south-1" } }, { @@ -5758,9 +5801,9 @@ } }, "params": { - "Region": "af-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "af-south-1" } }, { @@ -5771,9 +5814,9 @@ } }, "params": { - "Region": "af-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "af-south-1" } }, { @@ -5784,9 +5827,9 @@ } }, "params": { - "Region": "af-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "af-south-1" } }, { @@ -5797,9 +5840,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-north-1" } }, { @@ -5810,9 +5853,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-north-1" } }, { @@ -5823,9 +5866,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-north-1" } }, { @@ -5836,9 +5879,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-north-1" } }, { @@ -5849,9 +5892,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-3" } }, { @@ -5862,9 +5905,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-3" } }, { @@ -5875,9 +5918,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-3" } }, { @@ -5888,9 +5931,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-3" } }, { @@ -5901,9 +5944,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -5914,9 +5957,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -5927,9 +5970,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -5940,9 +5983,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -5953,9 +5996,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -5966,9 +6009,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -5979,9 +6022,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -5992,9 +6035,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -6005,9 +6048,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-3" } }, { @@ -6018,9 +6061,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-3" } }, { @@ -6031,9 +6074,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-3" } }, { @@ -6044,9 +6087,9 @@ } }, "params": { - "Region": "ap-northeast-3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-3" } }, { @@ -6057,9 +6100,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -6070,9 +6113,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -6083,9 +6126,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -6096,9 +6139,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -6109,9 +6152,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -6122,9 +6165,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -6135,9 +6178,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -6148,9 +6191,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -6161,9 +6204,9 @@ } }, "params": { - "Region": "me-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "me-south-1" } }, { @@ -6174,9 +6217,9 @@ } }, "params": { - "Region": "me-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "me-south-1" } }, { @@ -6187,9 +6230,9 @@ } }, "params": { - "Region": "me-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "me-south-1" } }, { @@ -6200,9 +6243,9 @@ } }, "params": { - "Region": "me-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "me-south-1" } }, { @@ -6213,9 +6256,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "sa-east-1" } }, { @@ -6226,9 +6269,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "sa-east-1" } }, { @@ -6239,9 +6282,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "sa-east-1" } }, { @@ -6252,9 +6295,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "sa-east-1" } }, { @@ -6265,9 +6308,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-east-1" } }, { @@ -6278,9 +6321,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-east-1" } }, { @@ -6291,9 +6334,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-east-1" } }, { @@ -6304,9 +6347,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-east-1" } }, { @@ -6317,9 +6360,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "cn-north-1" } }, { @@ -6330,9 +6373,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "cn-north-1" } }, { @@ -6343,9 +6386,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "cn-north-1" } }, { @@ -6356,9 +6399,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "cn-north-1" } }, { @@ -6369,9 +6412,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-gov-west-1" } }, { @@ -6382,9 +6425,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-gov-west-1" } }, { @@ -6395,9 +6438,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-gov-west-1" } }, { @@ -6408,9 +6451,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-gov-west-1" } }, { @@ -6421,9 +6464,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-1" } }, { @@ -6434,9 +6477,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-1" } }, { @@ -6447,9 +6490,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-1" } }, { @@ -6460,9 +6503,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-1" } }, { @@ -6473,9 +6516,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -6486,9 +6529,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -6499,9 +6542,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -6512,9 +6555,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -6523,9 +6566,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-iso-east-1" } }, { @@ -6536,9 +6579,9 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-iso-east-1" } }, { @@ -6547,9 +6590,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-iso-east-1" } }, { @@ -6560,9 +6603,9 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-iso-east-1" } }, { @@ -6573,9 +6616,9 @@ } }, "params": { - "Region": "ap-southeast-3", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-3" } }, { @@ -6586,9 +6629,9 @@ } }, "params": { - "Region": "ap-southeast-3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-3" } }, { @@ -6599,9 +6642,9 @@ } }, "params": { - "Region": "ap-southeast-3", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-3" } }, { @@ -6612,9 +6655,9 @@ } }, "params": { - "Region": "ap-southeast-3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-3" } }, { @@ -6625,9 +6668,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -6638,9 +6681,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -6651,9 +6694,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -6664,9 +6707,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -6677,9 +6720,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -6690,9 +6733,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -6703,9 +6746,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -6716,9 +6759,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -6729,9 +6772,9 @@ } }, "params": { - "Region": "cn-northwest-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "cn-northwest-1" } }, { @@ -6742,9 +6785,9 @@ } }, "params": { - "Region": "cn-northwest-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "cn-northwest-1" } }, { @@ -6755,9 +6798,9 @@ } }, "params": { - "Region": "cn-northwest-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "cn-northwest-1" } }, { @@ -6768,9 +6811,9 @@ } }, "params": { - "Region": "cn-northwest-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "cn-northwest-1" } }, { @@ -6779,9 +6822,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-isob-east-1" } }, { @@ -6792,9 +6835,9 @@ } }, "params": { - "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-isob-east-1" } }, { @@ -6803,9 +6846,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-isob-east-1" } }, { @@ -6816,9 +6859,9 @@ } }, "params": { - "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-isob-east-1" } }, { @@ -6829,9 +6872,9 @@ } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -6841,9 +6884,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -6853,9 +6896,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -9658,7 +9701,7 @@ "TriggerDetails": { "target": "com.amazonaws.guardduty#TriggerDetails", "traits": { - "smithy.api#documentation": "

Represents the reason the scan was triggered.

", + "smithy.api#documentation": "

Specifies the reason why the scan was initiated.

", "smithy.api#jsonName": "triggerDetails" } }, @@ -11001,7 +11044,7 @@ "Description": { "target": "com.amazonaws.guardduty#FilterDescription", "traits": { - "smithy.api#documentation": "

The description of the filter.

", + "smithy.api#documentation": "

The description of the filter. Valid special characters include period (.), underscore (_), dash (-), \n and whitespace. The new line character is considered to be an invalid input for description.

", "smithy.api#jsonName": "description" } }, diff --git a/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json b/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json index e9d4ccb039f..7bc89e257f3 100644 --- a/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json +++ b/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json @@ -9523,4 +9523,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/iot-roborunner.2018-05-10.json b/codegen/sdk-codegen/aws-models/iot-roborunner.2018-05-10.json index 0ea847d9c80..d0bb8dcaa73 100644 --- a/codegen/sdk-codegen/aws-models/iot-roborunner.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/iot-roborunner.2018-05-10.json @@ -3263,4 +3263,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/iotfleetwise.2021-06-17.json b/codegen/sdk-codegen/aws-models/iotfleetwise.2021-06-17.json index 5197829912c..e309cefb94c 100644 --- a/codegen/sdk-codegen/aws-models/iotfleetwise.2021-06-17.json +++ b/codegen/sdk-codegen/aws-models/iotfleetwise.2021-06-17.json @@ -67,6 +67,9 @@ "assignedValue": { "target": "com.amazonaws.iotfleetwise#string", "traits": { + "smithy.api#deprecated": { + "message": "assignedValue is no longer in use" + }, "smithy.api#documentation": "

A specified value for the actuator.

" } } @@ -192,6 +195,9 @@ "assignedValue": { "target": "com.amazonaws.iotfleetwise#string", "traits": { + "smithy.api#deprecated": { + "message": "assignedValue is no longer in use" + }, "smithy.api#documentation": "

A specified value for the attribute.

" } }, @@ -1597,6 +1603,9 @@ "traits": { "smithy.api#documentation": "

The request couldn't be completed because of invalid network interfaces in the request.

" } + }, + "message": { + "target": "com.amazonaws.iotfleetwise#string" } }, "traits": { @@ -2605,6 +2614,9 @@ }, { "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" } ], "traits": { @@ -3348,6 +3360,9 @@ "traits": { "smithy.api#documentation": "

The reason the node validation failed.

" } + }, + "message": { + "target": "com.amazonaws.iotfleetwise#string" } }, "traits": { @@ -3504,7 +3519,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -3553,15 +3568,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -6974,6 +6980,9 @@ }, { "target": "com.amazonaws.iotfleetwise#ThrottlingException" + }, + { + "target": "com.amazonaws.iotfleetwise#ValidationException" } ], "traits": { diff --git a/codegen/sdk-codegen/aws-models/iottwinmaker.2021-11-29.json b/codegen/sdk-codegen/aws-models/iottwinmaker.2021-11-29.json index ef334cb251c..9f7c3ac10d9 100644 --- a/codegen/sdk-codegen/aws-models/iottwinmaker.2021-11-29.json +++ b/codegen/sdk-codegen/aws-models/iottwinmaker.2021-11-29.json @@ -17,6 +17,9 @@ { "target": "com.amazonaws.iottwinmaker#CreateScene" }, + { + "target": "com.amazonaws.iottwinmaker#CreateSyncJob" + }, { "target": "com.amazonaws.iottwinmaker#CreateWorkspace" }, @@ -29,6 +32,9 @@ { "target": "com.amazonaws.iottwinmaker#DeleteScene" }, + { + "target": "com.amazonaws.iottwinmaker#DeleteSyncJob" + }, { "target": "com.amazonaws.iottwinmaker#DeleteWorkspace" }, @@ -53,6 +59,9 @@ { "target": "com.amazonaws.iottwinmaker#GetScene" }, + { + "target": "com.amazonaws.iottwinmaker#GetSyncJob" + }, { "target": "com.amazonaws.iottwinmaker#GetWorkspace" }, @@ -65,6 +74,12 @@ { "target": "com.amazonaws.iottwinmaker#ListScenes" }, + { + "target": "com.amazonaws.iottwinmaker#ListSyncJobs" + }, + { + "target": "com.amazonaws.iottwinmaker#ListSyncResources" + }, { "target": "com.amazonaws.iottwinmaker#ListTagsForResource" }, @@ -109,7 +124,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -158,15 +173,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -430,8 +436,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -443,8 +449,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -456,8 +462,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -469,8 +475,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -482,8 +488,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -495,8 +501,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -508,8 +514,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -521,8 +527,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -534,8 +540,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-1" } }, { @@ -547,8 +553,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-1" } }, { @@ -560,8 +566,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-1" } }, { @@ -573,8 +579,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-1" } }, { @@ -586,8 +592,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -599,8 +605,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -612,8 +618,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -625,8 +631,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -638,8 +644,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -651,8 +657,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -664,8 +670,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -677,8 +683,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -690,8 +696,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -703,8 +709,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -716,8 +722,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -729,8 +735,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -742,8 +748,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -754,8 +760,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -766,8 +772,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -1133,6 +1139,12 @@ "traits": { "smithy.api#documentation": "

The property groups.

" } + }, + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", + "traits": { + "smithy.api#documentation": "

The syncSource of the sync job, if this entity was created by a sync job.

" + } } }, "traits": { @@ -1149,6 +1161,16 @@ "smithy.api#pattern": "^[a-zA-Z_\\.\\-0-9:]+$" } }, + "com.amazonaws.iottwinmaker#ComponentTypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "[^\\u0000-\\u001F\\u007F]*" + } + }, "com.amazonaws.iottwinmaker#ComponentTypeSummaries": { "type": "list", "member": { @@ -1197,6 +1219,12 @@ "traits": { "smithy.api#documentation": "

The current status of the component type.

" } + }, + "componentTypeName": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeName", + "traits": { + "smithy.api#documentation": "

The component type name.

" + } } }, "traits": { @@ -1435,6 +1463,12 @@ "traits": { "smithy.api#documentation": "

" } + }, + "componentTypeName": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeName", + "traits": { + "smithy.api#documentation": "

A friendly name for the component type.

" + } } } }, @@ -1691,6 +1725,106 @@ } } }, + "com.amazonaws.iottwinmaker#CreateSyncJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#CreateSyncJobRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#CreateSyncJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#ConflictException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This action creates a SyncJob.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/sync-jobs/{syncSource}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#CreateSyncJobRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The workspace Id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", + "traits": { + "smithy.api#documentation": "

The sync source.

\n \n

Currently the only supported syncSoucre is SITEWISE .

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "syncRole": { + "target": "com.amazonaws.iottwinmaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The SyncJob IAM role. This IAM role is used by the sync job to read from the syncSource, and create, \n update or delete the corresponding resources.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.iottwinmaker#TagMap", + "traits": { + "smithy.api#documentation": "

The SyncJob tags.

" + } + } + } + }, + "com.amazonaws.iottwinmaker#CreateSyncJobResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "

The SyncJob ARN.

", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time for the SyncJob creation.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.iottwinmaker#SyncJobState", + "traits": { + "smithy.api#documentation": "

The SyncJob response state.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.iottwinmaker#CreateWorkspace": { "type": "operation", "input": { @@ -2146,6 +2280,79 @@ "type": "structure", "members": {} }, + "com.amazonaws.iottwinmaker#DeleteSyncJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#DeleteSyncJobRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#DeleteSyncJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete the SyncJob.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/workspaces/{workspaceId}/sync-jobs/{syncSource}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#DeleteSyncJobRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The workspace Id.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", + "traits": { + "smithy.api#documentation": "

The sync source.

\n \n

Currently the only supported syncSoucre is SITEWISE .

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#DeleteSyncJobResponse": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.iottwinmaker#SyncJobState", + "traits": { + "smithy.api#documentation": "

The SyncJob response state.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.iottwinmaker#DeleteWorkspace": { "type": "operation", "input": { @@ -2205,7 +2412,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 512 + "max": 2048 }, "smithy.api#pattern": ".*" } @@ -2230,7 +2437,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z_0-9-.][a-zA-Z_0-9-. ]*[a-zA-Z0-9]+$" + "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" } }, "com.amazonaws.iottwinmaker#EntityPropertyReference": { @@ -2363,6 +2570,18 @@ { "name": "INTERNAL_FAILURE", "value": "INTERNAL_FAILURE" + }, + { + "name": "SYNC_INITIALIZING_ERROR", + "value": "SYNC_INITIALIZING_ERROR" + }, + { + "name": "SYNC_CREATING_ERROR", + "value": "SYNC_CREATING_ERROR" + }, + { + "name": "SYNC_PROCESSING_ERROR", + "value": "SYNC_PROCESSING_ERROR" } ] } @@ -2772,6 +2991,18 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

\n

Valid Range: Minimum value of 1. Maximum value of 250.

" } + }, + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", + "traits": { + "smithy.api#documentation": "

The syncSource of the sync job, if this entity was created by a sync job.

" + } + }, + "componentTypeName": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeName", + "traits": { + "smithy.api#documentation": "

The component type name.

" + } } } }, @@ -2910,6 +3141,12 @@ "smithy.api#documentation": "

The date and time when the entity was last updated.

", "smithy.api#required": {} } + }, + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", + "traits": { + "smithy.api#documentation": "

The syncSource of the sync job, if this entity was created by a sync job.

" + } } } }, @@ -3384,15 +3621,18 @@ } } }, - "com.amazonaws.iottwinmaker#GetWorkspace": { + "com.amazonaws.iottwinmaker#GetSyncJob": { "type": "operation", "input": { - "target": "com.amazonaws.iottwinmaker#GetWorkspaceRequest" + "target": "com.amazonaws.iottwinmaker#GetSyncJobRequest" }, "output": { - "target": "com.amazonaws.iottwinmaker#GetWorkspaceResponse" + "target": "com.amazonaws.iottwinmaker#GetSyncJobResponse" }, "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, { "target": "com.amazonaws.iottwinmaker#InternalServerException" }, @@ -3410,37 +3650,149 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a workspace.

", + "smithy.api#documentation": "

Gets the SyncJob.

", "smithy.api#endpoint": { "hostPrefix": "api." }, "smithy.api#http": { "method": "GET", - "uri": "/workspaces/{workspaceId}", + "uri": "/sync-jobs/{syncSource}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.iottwinmaker#GetWorkspaceRequest": { + "com.amazonaws.iottwinmaker#GetSyncJobRequest": { "type": "structure", "members": { - "workspaceId": { - "target": "com.amazonaws.iottwinmaker#IdOrArn", + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", "traits": { - "smithy.api#documentation": "

The ID of the workspace.

", + "smithy.api#documentation": "

The sync soucre.

\n \n

Currently the only supported syncSoucre is SITEWISE .

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The workspace Id.

", + "smithy.api#httpQuery": "workspace" + } } } }, - "com.amazonaws.iottwinmaker#GetWorkspaceResponse": { + "com.amazonaws.iottwinmaker#GetSyncJobResponse": { "type": "structure", "members": { + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "

The sync job ARN.

", + "smithy.api#required": {} + } + }, "workspaceId": { "target": "com.amazonaws.iottwinmaker#Id", "traits": { - "smithy.api#documentation": "

The ID of the workspace.

", + "smithy.api#documentation": "

The ID of the workspace that contains the sync job.

", + "smithy.api#required": {} + } + }, + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", + "traits": { + "smithy.api#documentation": "

The sync soucre.

\n \n

Currently the only supported syncSoucre is SITEWISE .

\n ", + "smithy.api#required": {} + } + }, + "syncRole": { + "target": "com.amazonaws.iottwinmaker#RoleArn", + "traits": { + "smithy.api#documentation": "

The sync IAM role.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.iottwinmaker#SyncJobStatus", + "traits": { + "smithy.api#documentation": "

The SyncJob response status.

", + "smithy.api#required": {} + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation date and time.

", + "smithy.api#required": {} + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The update date and time.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetWorkspace": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#GetWorkspaceRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#GetWorkspaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a workspace.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/workspaces/{workspaceId}", + "code": 200 + } + } + }, + "com.amazonaws.iottwinmaker#GetWorkspaceRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#IdOrArn", + "traits": { + "smithy.api#documentation": "

The ID of the workspace.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iottwinmaker#GetWorkspaceResponse": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The ID of the workspace.

", "smithy.api#required": {} } }, @@ -3926,6 +4278,188 @@ } } }, + "com.amazonaws.iottwinmaker#ListSyncJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#ListSyncJobsRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#ListSyncJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all SyncJobs.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/sync-jobs-list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iottwinmaker#ListSyncJobsRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The ID of the workspace that contains the sync job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 50.

\n

Valid Range: Minimum value of 0. Maximum value of 200.

" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "

The string that specifies the next page of results.

" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListSyncJobsResponse": { + "type": "structure", + "members": { + "syncJobSummaries": { + "target": "com.amazonaws.iottwinmaker#SyncJobSummaries", + "traits": { + "smithy.api#documentation": "

The listed SyncJob summaries.

" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "

The string that specifies the next page of results.

" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListSyncResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.iottwinmaker#ListSyncResourcesRequest" + }, + "output": { + "target": "com.amazonaws.iottwinmaker#ListSyncResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iottwinmaker#AccessDeniedException" + }, + { + "target": "com.amazonaws.iottwinmaker#InternalServerException" + }, + { + "target": "com.amazonaws.iottwinmaker#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iottwinmaker#ThrottlingException" + }, + { + "target": "com.amazonaws.iottwinmaker#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the sync resources.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/workspaces/{workspaceId}/sync-jobs/{syncSource}/resources-list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iottwinmaker#ListSyncResourcesRequest": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The ID of the workspace that contains the sync job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", + "traits": { + "smithy.api#documentation": "

The sync soucre.

\n \n

Currently the only supported syncSoucre is SITEWISE .

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.iottwinmaker#SyncResourceFilters", + "traits": { + "smithy.api#documentation": "

A list of objects that filter the request.

" + } + }, + "maxResults": { + "target": "com.amazonaws.iottwinmaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 50.

\n

Valid Range: Minimum value of 0. Maximum value of 200.

" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "

The string that specifies the next page of results.

" + } + } + } + }, + "com.amazonaws.iottwinmaker#ListSyncResourcesResponse": { + "type": "structure", + "members": { + "syncResources": { + "target": "com.amazonaws.iottwinmaker#SyncResourceSummaries", + "traits": { + "smithy.api#documentation": "

The sync resources.

" + } + }, + "nextToken": { + "target": "com.amazonaws.iottwinmaker#NextToken", + "traits": { + "smithy.api#documentation": "

The string that specifies the next page of results.

" + } + } + } + }, "com.amazonaws.iottwinmaker#ListTagsForResource": { "type": "operation", "input": { @@ -4355,6 +4889,12 @@ "traits": { "smithy.api#documentation": "

A mapping that specifies configuration information about the property. Use this field to\n specify information that you read from and write to an external source.

" } + }, + "displayName": { + "target": "com.amazonaws.iottwinmaker#PropertyDisplayName", + "traits": { + "smithy.api#documentation": "

A friendly name for the property.

" + } } }, "traits": { @@ -4431,6 +4971,12 @@ "traits": { "smithy.api#documentation": "

A mapping that specifies configuration information about the property.

" } + }, + "displayName": { + "target": "com.amazonaws.iottwinmaker#PropertyDisplayName", + "traits": { + "smithy.api#documentation": "

A friendly name for the property.

" + } } }, "traits": { @@ -4455,6 +5001,16 @@ "target": "com.amazonaws.iottwinmaker#PropertyDefinitionResponse" } }, + "com.amazonaws.iottwinmaker#PropertyDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "[^\\u0000-\\u001F\\u007F]*" + } + }, "com.amazonaws.iottwinmaker#PropertyFilter": { "type": "structure", "members": { @@ -5128,6 +5684,253 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.iottwinmaker#SyncJobState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CREATING", + "value": "CREATING" + }, + { + "name": "INITIALIZING", + "value": "INITIALIZING" + }, + { + "name": "ACTIVE", + "value": "ACTIVE" + }, + { + "name": "DELETING", + "value": "DELETING" + }, + { + "name": "ERROR", + "value": "ERROR" + } + ] + } + }, + "com.amazonaws.iottwinmaker#SyncJobStatus": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.iottwinmaker#SyncJobState", + "traits": { + "smithy.api#documentation": "

The SyncJob status state.

" + } + }, + "error": { + "target": "com.amazonaws.iottwinmaker#ErrorDetails", + "traits": { + "smithy.api#documentation": "

The SyncJob error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SyncJob status.

" + } + }, + "com.amazonaws.iottwinmaker#SyncJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#SyncJobSummary" + } + }, + "com.amazonaws.iottwinmaker#SyncJobSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.iottwinmaker#TwinMakerArn", + "traits": { + "smithy.api#documentation": "

The SyncJob summary ARN.

" + } + }, + "workspaceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The ID of the workspace that contains the sync job.

" + } + }, + "syncSource": { + "target": "com.amazonaws.iottwinmaker#SyncSource", + "traits": { + "smithy.api#documentation": "

The sync source.

" + } + }, + "status": { + "target": "com.amazonaws.iottwinmaker#SyncJobStatus", + "traits": { + "smithy.api#documentation": "

The SyncJob summaries status.

" + } + }, + "creationDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation date and time.

" + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The update date and time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SyncJob summary.

" + } + }, + "com.amazonaws.iottwinmaker#SyncResourceFilter": { + "type": "union", + "members": { + "state": { + "target": "com.amazonaws.iottwinmaker#SyncResourceState", + "traits": { + "smithy.api#documentation": "

The sync resource filter's state.

" + } + }, + "resourceType": { + "target": "com.amazonaws.iottwinmaker#SyncResourceType", + "traits": { + "smithy.api#documentation": "

The sync resource filter resoucre type

" + } + }, + "resourceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The sync resource filter resource Id.

" + } + }, + "externalId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The external Id.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sync resource filter.

" + } + }, + "com.amazonaws.iottwinmaker#SyncResourceFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#SyncResourceFilter" + } + }, + "com.amazonaws.iottwinmaker#SyncResourceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "INITIALIZING", + "value": "INITIALIZING" + }, + { + "name": "PROCESSING", + "value": "PROCESSING" + }, + { + "name": "DELETED", + "value": "DELETED" + }, + { + "name": "IN_SYNC", + "value": "IN_SYNC" + }, + { + "name": "ERROR", + "value": "ERROR" + } + ] + } + }, + "com.amazonaws.iottwinmaker#SyncResourceStatus": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.iottwinmaker#SyncResourceState", + "traits": { + "smithy.api#documentation": "

The sync resource status state.

" + } + }, + "error": { + "target": "com.amazonaws.iottwinmaker#ErrorDetails", + "traits": { + "smithy.api#documentation": "

The status error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sync resource status.

" + } + }, + "com.amazonaws.iottwinmaker#SyncResourceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iottwinmaker#SyncResourceSummary" + } + }, + "com.amazonaws.iottwinmaker#SyncResourceSummary": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.iottwinmaker#SyncResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

" + } + }, + "externalId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The external Id.

" + } + }, + "resourceId": { + "target": "com.amazonaws.iottwinmaker#Id", + "traits": { + "smithy.api#documentation": "

The resource Id.

" + } + }, + "status": { + "target": "com.amazonaws.iottwinmaker#SyncResourceStatus", + "traits": { + "smithy.api#documentation": "

The sync resource summary status.

" + } + }, + "updateDateTime": { + "target": "com.amazonaws.iottwinmaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The update date and time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sync resource summary.

" + } + }, + "com.amazonaws.iottwinmaker#SyncResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ENTITY", + "value": "ENTITY" + }, + { + "name": "COMPONENT_TYPE", + "value": "COMPONENT_TYPE" + } + ] + } + }, + "com.amazonaws.iottwinmaker#SyncSource": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z_0-9]+$" + } + }, "com.amazonaws.iottwinmaker#TabularConditions": { "type": "structure", "members": { @@ -5451,7 +6254,7 @@ "workspaceId": { "target": "com.amazonaws.iottwinmaker#Id", "traits": { - "smithy.api#documentation": "

The ID of the workspace that contains the component type.

", + "smithy.api#documentation": "

The ID of the workspace.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5499,6 +6302,12 @@ "traits": { "smithy.api#documentation": "

The property groups

" } + }, + "componentTypeName": { + "target": "com.amazonaws.iottwinmaker#ComponentTypeName", + "traits": { + "smithy.api#documentation": "

The component type name.

" + } } } }, @@ -5978,4 +6787,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/ivschat.2020-07-14.json b/codegen/sdk-codegen/aws-models/ivschat.2020-07-14.json index ee086fe97e8..ce9b1da8a3c 100644 --- a/codegen/sdk-codegen/aws-models/ivschat.2020-07-14.json +++ b/codegen/sdk-codegen/aws-models/ivschat.2020-07-14.json @@ -3132,4 +3132,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/kendra.2019-02-03.json b/codegen/sdk-codegen/aws-models/kendra.2019-02-03.json index d4aa2c4f838..f549c467df0 100644 --- a/codegen/sdk-codegen/aws-models/kendra.2019-02-03.json +++ b/codegen/sdk-codegen/aws-models/kendra.2019-02-03.json @@ -9252,7 +9252,7 @@ "type": "float", "traits": { "smithy.api#range": { - "min": 0.000001, + "min": 1.0E-6, "max": 50 } } diff --git a/codegen/sdk-codegen/aws-models/kinesis-video-webrtc-storage.2018-05-10.json b/codegen/sdk-codegen/aws-models/kinesis-video-webrtc-storage.2018-05-10.json new file mode 100644 index 00000000000..4b522ca477a --- /dev/null +++ b/codegen/sdk-codegen/aws-models/kinesis-video-webrtc-storage.2018-05-10.json @@ -0,0 +1,804 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.kinesisvideowebrtcstorage#AWSAcuityRoutingServiceLambda": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#JoinStorageSession" + }, + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#JoinStorageSessionAsViewer" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Kinesis Video WebRTC Storage", + "arnNamespace": "kinesisvideo", + "endpointPrefix": "kinesisvideo" + }, + "aws.auth#sigv4": { + "name": "kinesisvideo" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "Authorization", + "Content-Type", + "Credentials", + "X-Amz-Date", + "X-Api-Key", + "X-Amz-Security-Token", + "x-amz-content-sha256", + "X-Amz-User-Agent" + ] + }, + "smithy.api#documentation": "

\n

", + "smithy.api#title": "Amazon Kinesis Video WebRTC Storage", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://kinesisvideo.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesisvideo.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "
    \n
  1. \n

    You do not have required permissions to perform this operation

    \n
    2. \n
\n
    \n
  1. \n

    The AccessDeniedException can be thrown for operation access as well as tokens or resource access

    \n
    2. \n
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#ChannelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+$" + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#ClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#ClientLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

\n Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#InvalidArgumentException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "
    \n
  1. \n

    The value for this input parameter is invalid.

    \n
    2. \n
\n
    \n
  1. \n

    Additional details may notbe returned.

    \n
    2. \n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#JoinStorageSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideowebrtcstorage#JoinStorageSessionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Join the ongoing one way-video and/or multi-way audio WebRTC session as \n a video producing device for an input channel. If there’s no existing \n session for the channel, a new streaming session needs to be created, and the\n Amazon Resource Name (ARN) of the signaling channel must be provided.\n

\n

Currently for the SINGLE_MASTER type, a video producing\n device is able to ingest both audio and video media into a stream,\n while viewers can only ingest audio. Both a video producing device \n and viewers can join the session first, and wait for other participants.

\n

While participants are having peer to peer conversations through webRTC, \n the ingested media session will be stored into the Kinesis Video Stream.\n Multiple viewers are able to playback real-time media.

\n

Customers can also use existing Kinesis Video Streams features like \n HLS or DASH playback, Image generation, and more\n with ingested WebRTC media.

\n \n

Assume that only one video producing device client\n can be associated with a session for the channel. If more than one \n client joins the session of a specific channel as a video producing device,\n the most recent client request takes precedence.

\n ", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/joinStorageSession" + } + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#JoinStorageSessionAsViewer": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideowebrtcstorage#JoinStorageSessionAsViewerInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideowebrtcstorage#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Join the ongoing one way-video and/or multi-way audio WebRTC session as \n a viewer for an input channel. If there’s\n no existing session for the channel, create a new streaming session and provide\n the Amazon Resource Name (ARN) of the signaling channel (channelArn)\n and client id (clientId).\n

\n

Currently for SINGLE_MASTER type, a video producing device\n is able to ingest both audio and video media into a stream, while viewers\n can only ingest audio. Both a video producing device and viewers can join\n a session first and wait for other participants. While participants are having peer to peer conversations through webRTC,\n the ingested media session will be stored into the Kinesis Video Stream.\n Multiple viewers are able to playback real-time media.\n

\n

Customers can also use existing Kinesis Video Streams features like\n HLS or DASH playback, Image generation, and more \n with ingested WebRTC media. If there’s an existing session with the same\n clientId that's found in the join session request, the new request takes precedence.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/joinStorageSessionAsViewer" + } + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#JoinStorageSessionAsViewerInput": { + "type": "structure", + "members": { + "channelArn": { + "target": "com.amazonaws.kinesisvideowebrtcstorage#ChannelArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the signaling channel.\n

", + "smithy.api#required": {} + } + }, + "clientId": { + "target": "com.amazonaws.kinesisvideowebrtcstorage#ClientId", + "traits": { + "smithy.api#documentation": "

\n The unique identifier for the sender client.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#JoinStorageSessionInput": { + "type": "structure", + "members": { + "channelArn": { + "target": "com.amazonaws.kinesisvideowebrtcstorage#ChannelArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the signaling channel.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kinesisvideowebrtcstorage#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "
    \n
  1. \n

    The specified resource is not found

    \n
    2. \n
\n
    \n
  1. \n

    You have not specified a channel in this API call.

    \n
    2. \n
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/kinesis-video.2017-09-30.json b/codegen/sdk-codegen/aws-models/kinesis-video.2017-09-30.json index e64cd9798cc..3584812a671 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-video.2017-09-30.json +++ b/codegen/sdk-codegen/aws-models/kinesis-video.2017-09-30.json @@ -30,42 +30,56 @@ }, "shapes": { "com.amazonaws.kinesisvideo#APIName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PUT_MEDIA", - "name": "PUT_MEDIA" - }, - { - "value": "GET_MEDIA", - "name": "GET_MEDIA" - }, - { - "value": "LIST_FRAGMENTS", - "name": "LIST_FRAGMENTS" - }, - { - "value": "GET_MEDIA_FOR_FRAGMENT_LIST", - "name": "GET_MEDIA_FOR_FRAGMENT_LIST" - }, - { - "value": "GET_HLS_STREAMING_SESSION_URL", - "name": "GET_HLS_STREAMING_SESSION_URL" - }, - { - "value": "GET_DASH_STREAMING_SESSION_URL", - "name": "GET_DASH_STREAMING_SESSION_URL" - }, - { - "value": "GET_CLIP", - "name": "GET_CLIP" - }, - { - "value": "GET_IMAGES", - "name": "GET_IMAGES" + "type": "enum", + "members": { + "PUT_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT_MEDIA" + } + }, + "GET_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET_MEDIA" + } + }, + "LIST_FRAGMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIST_FRAGMENTS" + } + }, + "GET_MEDIA_FOR_FRAGMENT_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET_MEDIA_FOR_FRAGMENT_LIST" + } + }, + "GET_HLS_STREAMING_SESSION_URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET_HLS_STREAMING_SESSION_URL" + } + }, + "GET_DASH_STREAMING_SESSION_URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET_DASH_STREAMING_SESSION_URL" + } + }, + "GET_CLIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET_CLIP" + } + }, + "GET_IMAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GET_IMAGES" } - ] + } } }, "com.amazonaws.kinesisvideo#AccessDeniedException": { @@ -194,48 +208,60 @@ } }, "com.amazonaws.kinesisvideo#ChannelProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WSS", - "name": "WSS" - }, - { - "value": "HTTPS", - "name": "HTTPS" + "type": "enum", + "members": { + "WSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WSS" } - ] + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + }, + "WEBRTC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEBRTC" + } + } } }, "com.amazonaws.kinesisvideo#ChannelRole": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MASTER", - "name": "MASTER" - }, - { - "value": "VIEWER", - "name": "VIEWER" + "type": "enum", + "members": { + "MASTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASTER" + } + }, + "VIEWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIEWER" } - ] + } } }, "com.amazonaws.kinesisvideo#ChannelType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SINGLE_MASTER", - "name": "SINGLE_MASTER" - }, - { - "value": "FULL_MESH", - "name": "FULL_MESH" + "type": "enum", + "members": { + "SINGLE_MASTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_MASTER" + } + }, + "FULL_MESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_MESH" } - ] + } } }, "com.amazonaws.kinesisvideo#ClientLimitExceededException": { @@ -252,29 +278,31 @@ } }, "com.amazonaws.kinesisvideo#ComparisonOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BEGINS_WITH", - "name": "BEGINS_WITH" + "type": "enum", + "members": { + "BEGINS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEGINS_WITH" } - ] + } } }, "com.amazonaws.kinesisvideo#ConfigurationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" } - ] + } } }, "com.amazonaws.kinesisvideo#CreateSignalingChannel": { @@ -306,7 +334,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a signaling channel.

\n

\n CreateSignalingChannel is an asynchronous operation.

", + "smithy.api#documentation": "

Creates a signaling channel.

\n

\n CreateSignalingChannel is an asynchronous operation.

", "smithy.api#http": { "method": "POST", "uri": "/createSignalingChannel", @@ -387,7 +415,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Kinesis video stream.

\n\n

When you create a new stream, Kinesis Video Streams assigns it a version number.\n When you change the stream's metadata, Kinesis Video Streams updates the version.

\n

\n CreateStream is an asynchronous operation.

\n

For information about how the service works, see How it Works.

\n

You must have permissions for the KinesisVideo:CreateStream\n action.

", + "smithy.api#documentation": "

Creates a new Kinesis video stream.

\n

When you create a new stream, Kinesis Video Streams assigns it a version number.\n When you change the stream's metadata, Kinesis Video Streams updates the version.

\n

\n CreateStream is an asynchronous operation.

\n

For information about how the service works, see How it Works.

\n

You must have permissions for the KinesisVideo:CreateStream\n action.

", "smithy.api#http": { "method": "POST", "uri": "/createStream", @@ -401,32 +429,32 @@ "DeviceName": { "target": "com.amazonaws.kinesisvideo#DeviceName", "traits": { - "smithy.api#documentation": "

The name of the device that is writing to the stream.

\n \n

In the current implementation, Kinesis Video Streams does not use this\n name.

\n " + "smithy.api#documentation": "

The name of the device that is writing to the stream.

\n \n

In the current implementation, Kinesis Video Streams does not use this\n name.

\n " } }, "StreamName": { "target": "com.amazonaws.kinesisvideo#StreamName", "traits": { - "smithy.api#documentation": "

A name for the stream that you are creating.

\n

The stream name is an identifier for the stream, and must be unique for each\n account and region.

", + "smithy.api#documentation": "

A name for the stream that you are creating.

\n

The stream name is an identifier for the stream, and must be unique for each\n account and region.

", "smithy.api#required": {} } }, "MediaType": { "target": "com.amazonaws.kinesisvideo#MediaType", "traits": { - "smithy.api#documentation": "

The media type of the stream. Consumers of the stream can use this information when\n processing the stream. For more information about media types, see Media\n Types. If you choose to specify the MediaType, see Naming Requirements\n for guidelines.

\n\n

Example valid values include \"video/h264\" and \"video/h264,audio/aac\".

\n

This parameter is optional; the default value is null (or empty in\n JSON).

" + "smithy.api#documentation": "

The media type of the stream. Consumers of the stream can use this information when\n processing the stream. For more information about media types, see Media\n Types. If you choose to specify the MediaType, see Naming Requirements\n for guidelines.

\n

Example valid values include \"video/h264\" and \"video/h264,audio/aac\".

\n

This parameter is optional; the default value is null (or empty in\n JSON).

" } }, "KmsKeyId": { "target": "com.amazonaws.kinesisvideo#KmsKeyId", "traits": { - "smithy.api#documentation": "

The ID of the Key Management Service (KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.

\n

If no key ID is specified, the default, Kinesis Video-managed key\n (aws/kinesisvideo) is used.

\n

For more information, see DescribeKey.

" + "smithy.api#documentation": "

The ID of the Key Management Service (KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.

\n

If no key ID is specified, the default, Kinesis Video-managed key\n (aws/kinesisvideo) is used.

\n

For more information, see DescribeKey.

" } }, "DataRetentionInHours": { "target": "com.amazonaws.kinesisvideo#DataRetentionInHours", "traits": { - "smithy.api#documentation": "

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

\n

The default value is 0, indicating that the stream does not persist data.

\n

When the DataRetentionInHours value is 0, consumers can still consume\n the fragments that remain in the service host buffer, which has a retention time limit\n of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the\n buffer when either limit is reached.

" + "smithy.api#documentation": "

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

\n

The default value is 0, indicating that the stream does not persist data.

\n

When the DataRetentionInHours value is 0, consumers can still consume\n the fragments that remain in the service host buffer, which has a retention time limit\n of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the\n buffer when either limit is reached.

" } }, "Tags": { @@ -467,6 +495,9 @@ } } }, + "com.amazonaws.kinesisvideo#DeleteAfterUpload": { + "type": "boolean" + }, "com.amazonaws.kinesisvideo#DeleteSignalingChannel": { "type": "operation", "input": { @@ -555,7 +586,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Kinesis video stream and the data contained in the stream.

\n

This method marks the stream for deletion, and makes the data in the stream\n inaccessible immediately.

\n

\n

To ensure that you have the latest version of the stream before deleting it, you\n can specify the stream version. Kinesis Video Streams assigns a version to each stream.\n When you update a stream, Kinesis Video Streams assigns a new version number. To get the\n latest stream version, use the DescribeStream API.

\n

This operation requires permission for the KinesisVideo:DeleteStream\n action.

", + "smithy.api#documentation": "

Deletes a Kinesis video stream and the data contained in the stream.

\n

This method marks the stream for deletion, and makes the data in the stream\n inaccessible immediately.

\n

\n

To ensure that you have the latest version of the stream before deleting it, you\n can specify the stream version. Kinesis Video Streams assigns a version to each stream.\n When you update a stream, Kinesis Video Streams assigns a new version number. To get the\n latest stream version, use the DescribeStream API.

\n

This operation requires permission for the KinesisVideo:DeleteStream\n action.

", "smithy.api#http": { "method": "POST", "uri": "/deleteStream", @@ -576,7 +607,7 @@ "CurrentVersion": { "target": "com.amazonaws.kinesisvideo#Version", "traits": { - "smithy.api#documentation": "

Optional: The version of the stream that you want to delete.

\n

Specify the version as a safeguard to ensure that your are deleting the correct\n stream. To get the stream version, use the DescribeStream API.

\n

If not specified, only the CreationTime is checked before deleting the\n stream.

" + "smithy.api#documentation": "

Optional: The version of the stream that you want to delete.

\n

Specify the version as a safeguard to ensure that your are deleting the correct\n stream. To get the stream version, use the DescribeStream API.

\n

If not specified, only the CreationTime is checked before deleting the\n stream.

" } } } @@ -585,6 +616,130 @@ "type": "structure", "members": {} }, + "com.amazonaws.kinesisvideo#DeletionConfig": { + "type": "structure", + "members": { + "EdgeRetentionInHours": { + "target": "com.amazonaws.kinesisvideo#EdgeRetentionInHours", + "traits": { + "smithy.api#documentation": "

The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention\n time is 720 hours, which translates to 30 days.

" + } + }, + "LocalSizeConfig": { + "target": "com.amazonaws.kinesisvideo#LocalSizeConfig", + "traits": { + "smithy.api#documentation": "

The value of the local size required in order to delete the edge configuration.

" + } + }, + "DeleteAfterUpload": { + "target": "com.amazonaws.kinesisvideo#DeleteAfterUpload", + "traits": { + "smithy.api#documentation": "

The boolean value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to \n the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are \n set to true, such as when the limit for the EdgeRetentionInHours, or the\n MaxLocalMediaSizeInMB, has been reached. \n

\n

Since the default value is set to true, configure the uploader schedule such \n that the media files are not being deleted before they are initially uploaded to AWS cloud.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details required to delete the connection of the stream from the Edge Agent.

" + } + }, + "com.amazonaws.kinesisvideo#DescribeEdgeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#DescribeEdgeConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#DescribeEdgeConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kinesisvideo#StreamEdgeConfigurationNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. \n Use this API to get the status of the configuration if the configuration is in sync with the \n Edge Agent.

", + "smithy.api#http": { + "method": "POST", + "uri": "/describeEdgeConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#DescribeEdgeConfigurationInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream whose edge configuration you want to update. Specify either the StreamName or \n the StreamARN.\n

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor the StreamARN.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#DescribeEdgeConfigurationOutput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream from which the edge configuration was updated.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which a stream’s edge configuration was first created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which a stream’s edge configuration was last updated.

" + } + }, + "SyncStatus": { + "target": "com.amazonaws.kinesisvideo#SyncStatus", + "traits": { + "smithy.api#documentation": "

The latest status of the edge configuration update.

" + } + }, + "FailedStatusDetails": { + "target": "com.amazonaws.kinesisvideo#FailedStatusDetails", + "traits": { + "smithy.api#documentation": "

A description of the generated failure status.

" + } + }, + "EdgeConfig": { + "target": "com.amazonaws.kinesisvideo#EdgeConfig", + "traits": { + "smithy.api#documentation": "

A description of the stream's edge configuration that will be used to sync \n with the Edge Agent IoT Greengrass component. The Edge Agent component will run\n on an IoT Hub Device setup at your premise.

" + } + } + } + }, "com.amazonaws.kinesisvideo#DescribeImageGenerationConfiguration": { "type": "operation", "input": { @@ -644,6 +799,148 @@ } } }, + "com.amazonaws.kinesisvideo#DescribeMappedResourceConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#DescribeMappedResourceConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#DescribeMappedResourceConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.

\n

Returns the most current information about the stream. The streamName\n or streamARN should be provided in the input.

", + "smithy.api#http": { + "method": "POST", + "uri": "/describeMappedResourceConfiguration", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MappedResourceConfigurationList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kinesisvideo#DescribeMappedResourceConfigurationInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.kinesisvideo#MappedResourceConfigurationListLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.kinesisvideo#NextToken", + "traits": { + "smithy.api#documentation": "

The token to provide in your next request, to get another batch of results.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#DescribeMappedResourceConfigurationOutput": { + "type": "structure", + "members": { + "MappedResourceConfigurationList": { + "target": "com.amazonaws.kinesisvideo#MappedResourceConfigurationList", + "traits": { + "smithy.api#documentation": "

A structure that encapsulates, or contains, the media storage configuration properties.

" + } + }, + "NextToken": { + "target": "com.amazonaws.kinesisvideo#NextToken", + "traits": { + "smithy.api#documentation": "

The token that was used in the NextTokenrequest to fetch the next set of results.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#DescribeMediaStorageConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#DescribeMediaStorageConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#DescribeMediaStorageConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the most current information about the channel. Specify the ChannelName\n or ChannelARN in the input.

", + "smithy.api#http": { + "method": "POST", + "uri": "/describeMediaStorageConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#DescribeMediaStorageConfigurationInput": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.kinesisvideo#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the channel.

" + } + }, + "ChannelARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the channel.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#DescribeMediaStorageConfigurationOutput": { + "type": "structure", + "members": { + "MediaStorageConfiguration": { + "target": "com.amazonaws.kinesisvideo#MediaStorageConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that encapsulates, or contains, the media storage configuration properties.

" + } + } + } + }, "com.amazonaws.kinesisvideo#DescribeNotificationConfiguration": { "type": "operation", "input": { @@ -864,22 +1161,79 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.kinesisvideo#DurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.kinesisvideo#EdgeConfig": { + "type": "structure", + "members": { + "HubDeviceArn": { + "target": "com.amazonaws.kinesisvideo#HubDeviceArn", + "traits": { + "smithy.api#documentation": "

The \"Internet of Things (IoT) Thing\" Arn of the stream.

", + "smithy.api#required": {} + } + }, + "RecorderConfig": { + "target": "com.amazonaws.kinesisvideo#RecorderConfig", + "traits": { + "smithy.api#documentation": "

The recorder configuration consists of the local MediaSourceConfig details, that are used as \n credentials to access the local media files streamed on the camera.

", + "smithy.api#required": {} + } + }, + "UploaderConfig": { + "target": "com.amazonaws.kinesisvideo#UploaderConfig", + "traits": { + "smithy.api#documentation": "

The uploader configuration contains the ScheduleExpression details that are used to\n schedule upload jobs for the recorded media files from the Edge Agent to a Kinesis Video Stream.

" + } + }, + "DeletionConfig": { + "target": "com.amazonaws.kinesisvideo#DeletionConfig", + "traits": { + "smithy.api#documentation": "

The deletion configuration is made up of the retention time (EdgeRetentionInHours) and local size configuration\n (LocalSizeConfig) details that are used to make the deletion.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A description of the stream's edge configuration that will be used to sync \n with the Edge Agent IoT Greengrass component. The Edge Agent component will run\n on an IoT Hub Device setup at your premise.

" + } + }, + "com.amazonaws.kinesisvideo#EdgeRetentionInHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 720 + } + } + }, "com.amazonaws.kinesisvideo#ErrorMessage": { "type": "string" }, + "com.amazonaws.kinesisvideo#FailedStatusDetails": { + "type": "string" + }, "com.amazonaws.kinesisvideo#Format": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JPEG", - "name": "JPEG" - }, - { - "value": "PNG", - "name": "PNG" + "type": "enum", + "members": { + "JPEG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JPEG" } - ] + }, + "PNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PNG" + } + } } }, "com.amazonaws.kinesisvideo#FormatConfig": { @@ -898,14 +1252,14 @@ } }, "com.amazonaws.kinesisvideo#FormatConfigKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JPEGQuality", - "name": "JPEGQuality" + "type": "enum", + "members": { + "JPEGQuality": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JPEGQuality" } - ] + } } }, "com.amazonaws.kinesisvideo#FormatConfigValue": { @@ -941,7 +1295,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an endpoint for a specified stream for either reading or writing. Use this\n endpoint in your application to read from the specified stream (using the\n GetMedia or GetMediaForFragmentList operations) or write\n to it (using the PutMedia operation).\n

\n \n

The returned endpoint does not have the API name appended. The client needs to\n add the API name to the returned endpoint.

\n \n\n

In the request, specify the stream either by StreamName or\n StreamARN.

", + "smithy.api#documentation": "

Gets an endpoint for a specified stream for either reading or writing. Use this\n endpoint in your application to read from the specified stream (using the\n GetMedia or GetMediaForFragmentList operations) or write\n to it (using the PutMedia operation).\n

\n \n

The returned endpoint does not have the API name appended. The client needs to\n add the API name to the returned endpoint.

\n \n

In the request, specify the stream either by StreamName or\n StreamARN.

", "smithy.api#http": { "method": "POST", "uri": "/getDataEndpoint", @@ -1010,7 +1364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides an endpoint for the specified signaling channel to send and receive messages.\n This API uses the SingleMasterChannelEndpointConfiguration input parameter,\n which consists of the Protocols and Role properties.

\n

\n Protocols is used to determine the communication mechanism. For example,\n if you specify WSS as the protocol, this API produces a secure websocket\n endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS\n endpoint.

\n

\n Role determines the messaging permissions. A MASTER role\n results in this API generating an endpoint that a client can use to communicate with any\n of the viewers on the channel. A VIEWER role results in this API generating\n an endpoint that a client can use to communicate only with a MASTER.\n

", + "smithy.api#documentation": "

Provides an endpoint for the specified signaling channel to send and receive messages.\n This API uses the SingleMasterChannelEndpointConfiguration input parameter,\n which consists of the Protocols and Role properties.

\n

\n Protocols is used to determine the communication mechanism. For example,\n if you specify WSS as the protocol, this API produces a secure websocket\n endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS\n endpoint.

\n

\n Role determines the messaging permissions. A MASTER role\n results in this API generating an endpoint that a client can use to communicate with any\n of the viewers on the channel. A VIEWER role results in this API generating\n an endpoint that a client can use to communicate only with a MASTER.\n

", "smithy.api#http": { "method": "POST", "uri": "/getSignalingChannelEndpoint", @@ -1056,6 +1410,16 @@ } } }, + "com.amazonaws.kinesisvideo#HubDeviceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:[a-z\\d-]+:iot:[a-z0-9-]+:[0-9]+:thing/[a-zA-Z0-9_.-]+$" + } + }, "com.amazonaws.kinesisvideo#ImageGenerationConfiguration": { "type": "structure", "members": { @@ -1123,7 +1487,7 @@ "Uri": { "target": "com.amazonaws.kinesisvideo#DestinationUri", "traits": { - "smithy.api#documentation": "

The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.

", + "smithy.api#documentation": "

The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

", "smithy.api#required": {} } }, @@ -1140,18 +1504,20 @@ } }, "com.amazonaws.kinesisvideo#ImageSelectorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SERVER_TIMESTAMP", - "name": "SERVER_TIMESTAMP" - }, - { - "value": "PRODUCER_TIMESTAMP", - "name": "PRODUCER_TIMESTAMP" + "type": "enum", + "members": { + "SERVER_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_TIMESTAMP" } - ] + }, + "PRODUCER_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCER_TIMESTAMP" + } + } } }, "com.amazonaws.kinesisvideo#InvalidArgumentException": { @@ -1209,9 +1575,18 @@ { "target": "com.amazonaws.kinesisvideo#DeleteStream" }, + { + "target": "com.amazonaws.kinesisvideo#DescribeEdgeConfiguration" + }, { "target": "com.amazonaws.kinesisvideo#DescribeImageGenerationConfiguration" }, + { + "target": "com.amazonaws.kinesisvideo#DescribeMappedResourceConfiguration" + }, + { + "target": "com.amazonaws.kinesisvideo#DescribeMediaStorageConfiguration" + }, { "target": "com.amazonaws.kinesisvideo#DescribeNotificationConfiguration" }, @@ -1239,6 +1614,9 @@ { "target": "com.amazonaws.kinesisvideo#ListTagsForStream" }, + { + "target": "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdate" + }, { "target": "com.amazonaws.kinesisvideo#TagResource" }, @@ -1257,6 +1635,9 @@ { "target": "com.amazonaws.kinesisvideo#UpdateImageGenerationConfiguration" }, + { + "target": "com.amazonaws.kinesisvideo#UpdateMediaStorageConfiguration" + }, { "target": "com.amazonaws.kinesisvideo#UpdateNotificationConfiguration" }, @@ -1289,7 +1670,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -1338,15 +1719,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -1609,9 +1981,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -1622,9 +1994,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -1635,9 +2007,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -1648,9 +2020,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -1661,9 +2033,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -1674,9 +2046,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -1687,9 +2059,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -1700,9 +2072,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -1713,9 +2085,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -1726,9 +2098,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -1739,9 +2111,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -1752,9 +2124,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -1765,9 +2137,9 @@ } }, "params": { + "UseFIPS": true, "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -1778,9 +2150,9 @@ } }, "params": { + "UseFIPS": true, "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -1791,9 +2163,9 @@ } }, "params": { + "UseFIPS": false, "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -1804,9 +2176,9 @@ } }, "params": { + "UseFIPS": false, "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -1815,9 +2187,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "UseFIPS": true, "Region": "us-iso-west-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -1828,9 +2200,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-iso-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -1839,9 +2211,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "UseFIPS": false, "Region": "us-iso-west-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -1852,9 +2224,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-iso-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -1865,9 +2237,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -1878,9 +2250,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -1891,9 +2263,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -1904,9 +2276,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -1917,9 +2289,9 @@ } }, "params": { + "UseFIPS": true, "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -1930,9 +2302,9 @@ } }, "params": { + "UseFIPS": true, "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -1943,9 +2315,9 @@ } }, "params": { + "UseFIPS": false, "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -1956,61 +2328,9 @@ } }, "params": { + "UseFIPS": false, "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kinesisvideo-fips.eu-north-1.api.aws" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kinesisvideo-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kinesisvideo.eu-north-1.api.aws" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kinesisvideo.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2021,9 +2341,9 @@ } }, "params": { + "UseFIPS": true, "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2034,9 +2354,9 @@ } }, "params": { + "UseFIPS": true, "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2047,9 +2367,9 @@ } }, "params": { + "UseFIPS": false, "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2060,9 +2380,9 @@ } }, "params": { + "UseFIPS": false, "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2073,9 +2393,9 @@ } }, "params": { + "UseFIPS": true, "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2086,9 +2406,9 @@ } }, "params": { + "UseFIPS": true, "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2099,9 +2419,9 @@ } }, "params": { + "UseFIPS": false, "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2112,9 +2432,9 @@ } }, "params": { + "UseFIPS": false, "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2125,9 +2445,9 @@ } }, "params": { + "UseFIPS": true, "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2138,9 +2458,9 @@ } }, "params": { + "UseFIPS": true, "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2151,9 +2471,9 @@ } }, "params": { + "UseFIPS": false, "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2164,9 +2484,9 @@ } }, "params": { + "UseFIPS": false, "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2177,9 +2497,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2190,9 +2510,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2203,9 +2523,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2216,9 +2536,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2229,9 +2549,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2242,9 +2562,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2255,9 +2575,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2268,61 +2588,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kinesisvideo-fips.me-south-1.api.aws" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kinesisvideo-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://kinesisvideo.me-south-1.api.aws" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://kinesisvideo.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2333,9 +2601,9 @@ } }, "params": { + "UseFIPS": true, "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2346,9 +2614,9 @@ } }, "params": { + "UseFIPS": true, "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2359,9 +2627,9 @@ } }, "params": { + "UseFIPS": false, "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2372,9 +2640,9 @@ } }, "params": { + "UseFIPS": false, "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2385,9 +2653,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2398,9 +2666,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2411,9 +2679,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2424,9 +2692,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2437,9 +2705,9 @@ } }, "params": { + "UseFIPS": true, "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2450,9 +2718,9 @@ } }, "params": { + "UseFIPS": true, "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2463,9 +2731,9 @@ } }, "params": { + "UseFIPS": false, "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2476,9 +2744,9 @@ } }, "params": { + "UseFIPS": false, "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2489,9 +2757,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-gov-west-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2502,9 +2770,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2515,9 +2783,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-gov-west-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2528,9 +2796,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2541,9 +2809,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2554,9 +2822,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2567,9 +2835,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2580,9 +2848,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2593,9 +2861,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2606,9 +2874,9 @@ } }, "params": { + "UseFIPS": true, "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2619,9 +2887,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2632,9 +2900,9 @@ } }, "params": { + "UseFIPS": false, "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2643,9 +2911,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "UseFIPS": true, "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2656,9 +2924,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2667,9 +2935,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "UseFIPS": false, "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2680,9 +2948,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2693,9 +2961,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2706,9 +2974,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2719,9 +2987,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2732,9 +3000,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2745,9 +3013,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2758,9 +3026,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2771,9 +3039,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2784,9 +3052,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2795,9 +3063,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "UseFIPS": true, "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -2808,9 +3076,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -2819,9 +3087,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "UseFIPS": false, "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -2832,9 +3100,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -2845,9 +3113,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -2857,9 +3125,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseFIPS": true, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -2869,9 +3137,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, "Endpoint": "https://example.com" } } @@ -3148,7 +3416,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of tags associated with the specified stream.

\n

In the request, you must specify either the StreamName or the\n StreamARN.

", + "smithy.api#documentation": "

Returns a list of tags associated with the specified stream.

\n

In the request, you must specify either the StreamName or the\n StreamARN.

", "smithy.api#http": { "method": "POST", "uri": "/listTagsForStream", @@ -3191,21 +3459,179 @@ "Tags": { "target": "com.amazonaws.kinesisvideo#ResourceTags", "traits": { - "smithy.api#documentation": "

A map of tag keys and values associated with the specified stream.

" + "smithy.api#documentation": "

A map of tag keys and values associated with the specified stream.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#LocalSizeConfig": { + "type": "structure", + "members": { + "MaxLocalMediaSizeInMB": { + "target": "com.amazonaws.kinesisvideo#MaxLocalMediaSizeInMB", + "traits": { + "smithy.api#documentation": "

The overall maximum size of the media that you want to store for a stream on the Edge Agent.

" + } + }, + "StrategyOnFullSize": { + "target": "com.amazonaws.kinesisvideo#StrategyOnFullSize", + "traits": { + "smithy.api#documentation": "

The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details that include the maximum size of the media \n (MaxLocalMediaSizeInMB) that you want to\n store for a stream on the Edge Agent, as well as the strategy that should be used (StrategyOnFullSize) when a stream's\n maximum size has been reached.

" + } + }, + "com.amazonaws.kinesisvideo#MappedResourceConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.kinesisvideo#MappedResourceConfigurationListItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.kinesisvideo#MappedResourceConfigurationListItem": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.kinesisvideo#Type", + "traits": { + "smithy.api#documentation": "

The type of the associated resource for the kinesis video stream.

" + } + }, + "ARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis Video Stream resource, associated with the stream.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that encapsulates, or contains, the media storage configuration properties.

" + } + }, + "com.amazonaws.kinesisvideo#MappedResourceConfigurationListLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.kinesisvideo#MaxLocalMediaSizeInMB": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 64, + "max": 2000000 + } + } + }, + "com.amazonaws.kinesisvideo#MediaSourceConfig": { + "type": "structure", + "members": { + "MediaUriSecretArn": { + "target": "com.amazonaws.kinesisvideo#MediaUriSecretArn", + "traits": { + "smithy.api#documentation": "

The AWS Secrets Manager ARN for the username and password of the camera, or a local media file location.

", + "smithy.api#required": {} + } + }, + "MediaUriType": { + "target": "com.amazonaws.kinesisvideo#MediaUriType", + "traits": { + "smithy.api#documentation": "

The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to stream \n local media files.

\n \n

Preview only supports the RTSP_URI media source URI format .

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details that consist of the credentials required \n (MediaUriSecretArn and MediaUriType) to access the media files that are \n streamed to the camera.

" + } + }, + "com.amazonaws.kinesisvideo#MediaStorageConfiguration": { + "type": "structure", + "members": { + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream

" + } + }, + "Status": { + "target": "com.amazonaws.kinesisvideo#MediaStorageConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The status of the media storage configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that encapsulates, or contains, the media storage configuration properties.

" + } + }, + "com.amazonaws.kinesisvideo#MediaStorageConfigurationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.kinesisvideo#MediaType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+(,[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+)*$" + } + }, + "com.amazonaws.kinesisvideo#MediaUriSecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z\\d-]+:secretsmanager:[a-z0-9-]+:[0-9]+:secret:[a-zA-Z0-9_.-]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.kinesisvideo#MediaUriType": { + "type": "enum", + "members": { + "RTSP_URI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RTSP_URI" + } + }, + "FILE_URI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_URI" } } } }, - "com.amazonaws.kinesisvideo#MediaType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+(,[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+)*$" - } - }, "com.amazonaws.kinesisvideo#MessageTtlSeconds": { "type": "integer", "traits": { @@ -3279,7 +3705,7 @@ "Uri": { "target": "com.amazonaws.kinesisvideo#DestinationUri", "traits": { - "smithy.api#documentation": "

The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.

", + "smithy.api#documentation": "

The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

", "smithy.api#required": {} } } @@ -3288,6 +3714,27 @@ "smithy.api#documentation": "

The structure that contains the information required to deliver a notification to a customer.

" } }, + "com.amazonaws.kinesisvideo#RecorderConfig": { + "type": "structure", + "members": { + "MediaSourceConfig": { + "target": "com.amazonaws.kinesisvideo#MediaSourceConfig", + "traits": { + "smithy.api#documentation": "

The configuration details that consist of the credentials required \n (MediaUriSecretArn and MediaUriType) to access the media files \n streamed to the camera.\n

", + "smithy.api#required": {} + } + }, + "ScheduleConfig": { + "target": "com.amazonaws.kinesisvideo#ScheduleConfig", + "traits": { + "smithy.api#documentation": "

The configuration that consists of the ScheduleExpression and the \n DurationInMinutes details that specify the scheduling to record from a camera, or\n local media file, onto the Edge Agent. If the ScheduleExpression attribute is not provided,\n then the Edge Agent will always be set to recording mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The recorder configuration consists of the local MediaSourceConfig details that are used as \n credentials to accesss the local media files streamed on the camera.

" + } + }, "com.amazonaws.kinesisvideo#ResourceARN": { "type": "string", "traits": { @@ -3335,7 +3782,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource is currently not available for this operation. New resources cannot be\n created with the same name as existing resources. Also, resources cannot be updated or\n deleted unless they are in an ACTIVE state.

\n

If this exception is returned, do not use it to determine whether the requested\n resource already exists. Instead, it is recommended you use the resource-specific\n describe API, for example, DescribeStream for video streams.

", + "smithy.api#documentation": "

When the input StreamARN or ChannelARN\n in CLOUD_STORAGE_MODE is already mapped to a different\n Kinesis Video Stream resource, or if the provided input StreamARN\n or ChannelARN is not in Active status, try one of the following :

\n
    \n
  1. \n

    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to. \n

    \n
    2. \n
  2. \n

    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to. \n

    \n
    3. \n
  3. \n

    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.\n

    \n
    4. \n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3377,6 +3824,38 @@ } } }, + "com.amazonaws.kinesisvideo#ScheduleConfig": { + "type": "structure", + "members": { + "ScheduleExpression": { + "target": "com.amazonaws.kinesisvideo#ScheduleExpression", + "traits": { + "smithy.api#documentation": "

The Quartz cron expression that takes care of scheduling jobs to record from the\n camera, or local media file, onto the Edge Agent. If the ScheduleExpression is not provided for the RecorderConfig,\n then the Edge Agent will always be set to recording mode.

\n

For more information about Quartz, refer to the \n \n Cron Trigger Tutorial\n page to understand the valid expressions and its use.

", + "smithy.api#required": {} + } + }, + "DurationInSeconds": { + "target": "com.amazonaws.kinesisvideo#DurationInSeconds", + "traits": { + "smithy.api#documentation": "

The total duration to record the media. If the ScheduleExpression attribute is provided, then the\n DurationInSeconds attribute should also be specified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This API enables you to specify the duration that the camera,\n or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the \n DurationInMinutes attributes.

\n

If the ScheduleExpression is not provided,\n then the Edge Agent will always be set to recording mode.

" + } + }, + "com.amazonaws.kinesisvideo#ScheduleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 100 + }, + "smithy.api#pattern": "^[^\\n]{11,100}$" + } + }, "com.amazonaws.kinesisvideo#SingleMasterChannelEndpointConfiguration": { "type": "structure", "members": { @@ -3411,27 +3890,171 @@ "smithy.api#documentation": "

A structure that contains the configuration for the SINGLE_MASTER channel\n type.

" } }, - "com.amazonaws.kinesisvideo#Status": { - "type": "string", + "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdateInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#NoDataRetentionException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceInUseException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "DELETING", - "name": "DELETING" + "smithy.api#documentation": "

An asynchronous API that updates a stream’s existing edge configuration. \n The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass \n component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary\n and depends on the connectivity of the Hub Device. \n The SyncStatus will be updated as the edge configuration is acknowledged, \n and synced with the Edge Agent.

\n

If this API is invoked for the first time, a new edge configuration will be created for the stream,\n and the sync status will be set to SYNCING. You will have to wait for the sync status\n to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. \n If you invoke this API during the syncing process, a ResourceInUseException will be thrown. \n The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes,\n the status will transition into the SYNC_FAILED state.

", + "smithy.api#http": { + "method": "POST", + "uri": "/startEdgeConfigurationUpdate", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdateInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream whose edge configuration you want to update. Specify either the StreamName\n or the StreamARN.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream. Specify either the \n StreamName or the StreamARN.

" + } + }, + "EdgeConfig": { + "target": "com.amazonaws.kinesisvideo#EdgeConfig", + "traits": { + "smithy.api#documentation": "

The edge configuration details required to invoke the update process.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kinesisvideo#StartEdgeConfigurationUpdateOutput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream from which the edge configuration was updated.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which a stream’s edge configuration was first created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.kinesisvideo#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which a stream’s edge configuration was last updated.

" + } + }, + "SyncStatus": { + "target": "com.amazonaws.kinesisvideo#SyncStatus", + "traits": { + "smithy.api#documentation": "

The current sync status of the stream's edge configuration. When you invoke this API, the sync\n status will be set to the SYNCING state. Use the DescribeEdgeConfiguration API\n to get the latest status of the edge configuration.

" + } + }, + "FailedStatusDetails": { + "target": "com.amazonaws.kinesisvideo#FailedStatusDetails", + "traits": { + "smithy.api#documentation": "

A description of the generated failure status.

" + } + }, + "EdgeConfig": { + "target": "com.amazonaws.kinesisvideo#EdgeConfig", + "traits": { + "smithy.api#documentation": "

A description of the stream's edge configuration that will be used to sync \n with the Edge Agent IoT Greengrass component. The Edge Agent component will run\n on an IoT Hub Device setup at your premise.

" } - ] + } + } + }, + "com.amazonaws.kinesisvideo#Status": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.kinesisvideo#StrategyOnFullSize": { + "type": "enum", + "members": { + "DELETE_OLDEST_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_OLDEST_MEDIA" + } + }, + "DENY_NEW_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY_NEW_MEDIA" + } + } + } + }, + "com.amazonaws.kinesisvideo#StreamEdgeConfigurationNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kinesisvideo#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration\n that you specified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 } }, "com.amazonaws.kinesisvideo#StreamInfo": { @@ -3532,6 +4155,47 @@ "smithy.api#documentation": "

Specifies the condition that streams must satisfy to be returned when you list\n streams (see the ListStreams API). A condition has a comparison operation\n and a value. Currently, you can specify only the BEGINS_WITH operator,\n which finds streams whose names start with a given prefix.

" } }, + "com.amazonaws.kinesisvideo#SyncStatus": { + "type": "enum", + "members": { + "SYNCING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCING" + } + }, + "ACKNOWLEDGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACKNOWLEDGED" + } + }, + "IN_SYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_SYNC" + } + }, + "SYNC_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNC_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, "com.amazonaws.kinesisvideo#Tag": { "type": "structure", "members": { @@ -3686,7 +4350,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to a stream. A tag is a key-value pair\n (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify\n a tag that already exists, the tag value is replaced with the value that you specify in\n the request. For more information, see Using Cost Allocation\n Tags in the Billing and Cost Management and Cost Management User Guide.

\n

You must provide either the StreamName or the\n StreamARN.

\n

This operation requires permission for the KinesisVideo:TagStream\n action.

\n

A Kinesis video stream can support up to 50 tags.

", + "smithy.api#documentation": "

Adds one or more tags to a stream. A tag is a key-value pair\n (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify\n a tag that already exists, the tag value is replaced with the value that you specify in\n the request. For more information, see Using Cost Allocation\n Tags in the Billing and Cost Management and Cost Management User Guide.

\n

You must provide either the StreamName or the\n StreamARN.

\n

This operation requires permission for the KinesisVideo:TagStream\n action.

\n

A Kinesis video stream can support up to 50 tags.

", "smithy.api#http": { "method": "POST", "uri": "/tagStream", @@ -3748,6 +4412,9 @@ "com.amazonaws.kinesisvideo#Timestamp": { "type": "timestamp" }, + "com.amazonaws.kinesisvideo#Type": { + "type": "string" + }, "com.amazonaws.kinesisvideo#UntagResource": { "type": "operation", "input": { @@ -3828,7 +4495,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more tags from a stream. In the request, specify only a tag key or\n keys; don't specify the value. If you specify a tag key that does not exist, it's\n ignored.

\n

In the request, you must provide the StreamName or\n StreamARN.

", + "smithy.api#documentation": "

Removes one or more tags from a stream. In the request, specify only a tag key or\n keys; don't specify the value. If you specify a tag key that does not exist, it's\n ignored.

\n

In the request, you must provide the StreamName or\n StreamARN.

", "smithy.api#http": { "method": "POST", "uri": "/untagStream", @@ -3893,7 +4560,7 @@ } ], "traits": { - "smithy.api#documentation": "

Increases or decreases the stream's data retention period by the value that you\n specify. To indicate whether you want to increase or decrease the data retention period,\n specify the Operation parameter in the request body. In the request, you\n must specify either the StreamName or the StreamARN.

\n \n

The retention period that you specify replaces the current value.

\n \n\n

This operation requires permission for the\n KinesisVideo:UpdateDataRetention action.

\n\n

Changing the data retention period affects the data in the stream as\n follows:

\n ", + "smithy.api#documentation": "

Increases or decreases the stream's data retention period by the value that you\n specify. To indicate whether you want to increase or decrease the data retention period,\n specify the Operation parameter in the request body. In the request, you\n must specify either the StreamName or the StreamARN.

\n \n

The retention period that you specify replaces the current value.

\n \n

This operation requires permission for the\n KinesisVideo:UpdateDataRetention action.

\n

Changing the data retention period affects the data in the stream as\n follows:

\n ", "smithy.api#http": { "method": "POST", "uri": "/updateDataRetention", @@ -3940,18 +4607,20 @@ } }, "com.amazonaws.kinesisvideo#UpdateDataRetentionOperation": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INCREASE_DATA_RETENTION", - "name": "INCREASE_DATA_RETENTION" - }, - { - "value": "DECREASE_DATA_RETENTION", - "name": "DECREASE_DATA_RETENTION" + "type": "enum", + "members": { + "INCREASE_DATA_RETENTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREASE_DATA_RETENTION" + } + }, + "DECREASE_DATA_RETENTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECREASE_DATA_RETENTION" } - ] + } } }, "com.amazonaws.kinesisvideo#UpdateDataRetentionOutput": { @@ -4022,6 +4691,66 @@ "type": "structure", "members": {} }, + "com.amazonaws.kinesisvideo#UpdateMediaStorageConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#UpdateMediaStorageConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#UpdateMediaStorageConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#NoDataRetentionException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceInUseException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that \n can specified :

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/updateMediaStorageConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#UpdateMediaStorageConfigurationInput": { + "type": "structure", + "members": { + "ChannelARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the channel.

", + "smithy.api#required": {} + } + }, + "MediaStorageConfiguration": { + "target": "com.amazonaws.kinesisvideo#MediaStorageConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that encapsulates, or contains, the media storage configuration properties.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kinesisvideo#UpdateMediaStorageConfigurationOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.kinesisvideo#UpdateNotificationConfiguration": { "type": "operation", "input": { @@ -4115,7 +4844,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the existing signaling channel. This is an asynchronous operation and takes\n time to complete.

\n

If the MessageTtlSeconds value is updated (either increased or reduced),\n it only applies to new messages sent via this channel after it's been updated. Existing\n messages are still expired as per the previous MessageTtlSeconds\n value.

", + "smithy.api#documentation": "

Updates the existing signaling channel. This is an asynchronous operation and takes\n time to complete.

\n

If the MessageTtlSeconds value is updated (either increased or reduced),\n it only applies to new messages sent via this channel after it's been updated. Existing\n messages are still expired as per the previous MessageTtlSeconds\n value.

", "smithy.api#http": { "method": "POST", "uri": "/updateSignalingChannel", @@ -4181,7 +4910,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates stream metadata, such as the device name and media type.

\n

You must provide the stream name or the Amazon Resource Name (ARN) of the\n stream.

\n

To make sure that you have the latest version of the stream before updating it, you\n can specify the stream version. Kinesis Video Streams assigns a version to each stream.\n When you update a stream, Kinesis Video Streams assigns a new version number. To get the\n latest stream version, use the DescribeStream API.

\n

\n UpdateStream is an asynchronous operation, and takes time to\n complete.

", + "smithy.api#documentation": "

Updates stream metadata, such as the device name and media type.

\n

You must provide the stream name or the Amazon Resource Name (ARN) of the\n stream.

\n

To make sure that you have the latest version of the stream before updating it, you\n can specify the stream version. Kinesis Video Streams assigns a version to each stream.\n When you update a stream, Kinesis Video Streams assigns a new version number. To get the\n latest stream version, use the DescribeStream API.

\n

\n UpdateStream is an asynchronous operation, and takes time to\n complete.

", "smithy.api#http": { "method": "POST", "uri": "/updateStream", @@ -4195,7 +4924,7 @@ "StreamName": { "target": "com.amazonaws.kinesisvideo#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream whose metadata you want to update.

\n

The stream name is an identifier for the stream, and must be unique for each\n account and region.

" + "smithy.api#documentation": "

The name of the stream whose metadata you want to update.

\n

The stream name is an identifier for the stream, and must be unique for each\n account and region.

" } }, "StreamARN": { @@ -4214,13 +4943,13 @@ "DeviceName": { "target": "com.amazonaws.kinesisvideo#DeviceName", "traits": { - "smithy.api#documentation": "

The name of the device that is writing to the stream.

\n \n

In the current implementation, Kinesis Video Streams does not use this name.\n

\n " + "smithy.api#documentation": "

The name of the device that is writing to the stream.

\n \n

In the current implementation, Kinesis Video Streams does not use this name.\n

\n " } }, "MediaType": { "target": "com.amazonaws.kinesisvideo#MediaType", "traits": { - "smithy.api#documentation": "

The stream's media type. Use MediaType to specify the type of content\n that the stream contains to the consumers of the stream. For more information about\n media types, see Media\n Types. If you choose to specify the MediaType, see Naming\n Requirements.

\n

To play video on the console, you must specify the correct video type. For example,\n if the video in the stream is H.264, specify video/h264 as the\n MediaType.

" + "smithy.api#documentation": "

The stream's media type. Use MediaType to specify the type of content\n that the stream contains to the consumers of the stream. For more information about\n media types, see Media\n Types. If you choose to specify the MediaType, see Naming\n Requirements.

\n

To play video on the console, you must specify the correct video type. For example,\n if the video in the stream is H.264, specify video/h264 as the\n MediaType.

" } } } @@ -4229,6 +4958,21 @@ "type": "structure", "members": {} }, + "com.amazonaws.kinesisvideo#UploaderConfig": { + "type": "structure", + "members": { + "ScheduleConfig": { + "target": "com.amazonaws.kinesisvideo#ScheduleConfig", + "traits": { + "smithy.api#documentation": "

The configuration that consists of the ScheduleExpression and the \n DurationInMinutesdetails that specify the scheduling to record from a camera, or\n local media file, onto the Edge Agent. If the ScheduleExpression is not provided,\n then the Edge Agent will always be in recording mode.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that consists of the ScheduleExpression\n and the DurationInMinutesdetails, that specify the scheduling to record from a camera,\n or local media file, onto the Edge Agent. If the ScheduleExpression\n is not provided, then the Edge Agent will always be in upload mode.\n

" + } + }, "com.amazonaws.kinesisvideo#Version": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/kinesis.2013-12-02.json b/codegen/sdk-codegen/aws-models/kinesis.2013-12-02.json index a1854861621..f1af2324e85 100644 --- a/codegen/sdk-codegen/aws-models/kinesis.2013-12-02.json +++ b/codegen/sdk-codegen/aws-models/kinesis.2013-12-02.json @@ -29,6 +29,18 @@ ] }, "shapes": { + "com.amazonaws.kinesis#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.kinesis#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that you do not have the permissions required to perform this\n operation.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.kinesis#AddTagsToStream": { "type": "operation", "input": { @@ -38,6 +50,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -52,7 +67,12 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates tags for the specified Kinesis data stream. You can assign up to 50\n tags to a data stream.

\n

If tags have already been assigned to the stream, AddTagsToStream\n overwrites any existing tags that correspond to the specified tag keys.

\n

\n AddTagsToStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Adds or updates tags for the specified Kinesis data stream. You can assign up to 50\n tags to a data stream.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

If tags have already been assigned to the stream, AddTagsToStream\n overwrites any existing tags that correspond to the specified tag keys.

\n

\n AddTagsToStream has a limit of five transactions per second per\n account.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#AddTagsToStreamInput": { @@ -61,8 +81,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream.

" } }, "Tags": { @@ -71,6 +90,15 @@ "smithy.api#documentation": "

A set of up to 10 key-value pairs to use to create the tags.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -127,7 +155,7 @@ "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { - "smithy.api#documentation": "

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need\n this ARN to be able to call SubscribeToShard.

\n

If you delete a consumer and then create a new one with the same name, it won't have\n the same ARN. That's because consumer ARNs contain the creation timestamp. This is\n important to keep in mind if you have IAM policies that reference consumer ARNs.

", + "smithy.api#documentation": "

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need\n this ARN to be able to call SubscribeToShard.

\n

If you delete a consumer and then create a new one with the same name, it won't have\n the same ARN. That's because consumer ARNs contain the creation timestamp. This is\n important to keep in mind if you have IAM policies that reference consumer ARNs.

", "smithy.api#required": {} } }, @@ -182,7 +210,7 @@ "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { - "smithy.api#documentation": "

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need\n this ARN to be able to call SubscribeToShard.

\n

If you delete a consumer and then create a new one with the same name, it won't have\n the same ARN. That's because consumer ARNs contain the creation timestamp. This is\n important to keep in mind if you have IAM policies that reference consumer ARNs.

", + "smithy.api#documentation": "

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need\n this ARN to be able to call SubscribeToShard.

\n

If you delete a consumer and then create a new one with the same name, it won't have\n the same ARN. That's because consumer ARNs contain the creation timestamp. This is\n important to keep in mind if you have IAM policies that reference consumer ARNs.

", "smithy.api#required": {} } }, @@ -229,22 +257,26 @@ } }, "com.amazonaws.kinesis#ConsumerStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" } - ] + } } }, "com.amazonaws.kinesis#CreateStream": { @@ -267,7 +299,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You specify and control the number of shards that a stream is composed of. Each shard\n can support reads up to five transactions per second, up to a maximum data read total of\n 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a\n maximum data write total of 1 MiB per second. If the amount of data input increases or\n decreases, you can add or remove shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

" } }, "com.amazonaws.kinesis#CreateStreamInput": { @@ -315,6 +347,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -329,7 +364,12 @@ } ], "traits": { - "smithy.api#documentation": "

Decreases the Kinesis data stream's retention period, which is the length of time data\n records are accessible after they are added to the stream. The minimum value of a\n stream's retention period is 24 hours.

\n

This operation may result in lost data. For example, if the stream's retention period\n is 48 hours and is decreased to 24 hours, any data already in the stream that is older\n than 24 hours is inaccessible.

" + "smithy.api#documentation": "

Decreases the Kinesis data stream's retention period, which is the length of time data\n records are accessible after they are added to the stream. The minimum value of a\n stream's retention period is 24 hours.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

This operation may result in lost data. For example, if the stream's retention period\n is 48 hours and is decreased to 24 hours, any data already in the stream that is older\n than 24 hours is inaccessible.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#DecreaseStreamRetentionPeriodInput": { @@ -338,8 +378,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream to modify.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream to modify.

" } }, "RetentionPeriodHours": { @@ -348,6 +387,15 @@ "smithy.api#documentation": "

The new retention period of the stream, in hours. Must be less than the current\n retention period.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -363,6 +411,12 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesis#InvalidArgumentException" + }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, @@ -374,7 +428,12 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Kinesis data stream and all its shards and data. You must shut down any\n applications that are operating on the stream before you delete the stream. If an\n application attempts to operate on a deleted stream, it receives the exception\n ResourceNotFoundException.

\n

If the stream is in the ACTIVE state, you can delete it. After a\n DeleteStream request, the specified stream is in the\n DELETING state until Kinesis Data Streams completes the\n deletion.

\n

\n Note: Kinesis Data Streams might continue to accept\n data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the\n DELETING state until the stream deletion is complete.

\n

When you delete a stream, any shards in that stream are also deleted, and any tags are\n dissociated from the stream.

\n

You can use the DescribeStreamSummary operation to check the state\n of the stream, which is returned in StreamStatus.

\n \n

\n DeleteStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Deletes a Kinesis data stream and all its shards and data. You must shut down any\n applications that are operating on the stream before you delete the stream. If an\n application attempts to operate on a deleted stream, it receives the exception\n ResourceNotFoundException.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

If the stream is in the ACTIVE state, you can delete it. After a\n DeleteStream request, the specified stream is in the\n DELETING state until Kinesis Data Streams completes the\n deletion.

\n

\n Note: Kinesis Data Streams might continue to accept\n data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the\n DELETING state until the stream deletion is complete.

\n

When you delete a stream, any shards in that stream are also deleted, and any tags are\n dissociated from the stream.

\n

You can use the DescribeStreamSummary operation to check the state\n of the stream, which is returned in StreamStatus.

\n

\n DeleteStream has a limit of five transactions per second per\n account.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#DeleteStreamInput": { @@ -383,8 +442,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream to delete.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream to delete.

" } }, "EnforceConsumerDeletion": { @@ -392,6 +450,15 @@ "traits": { "smithy.api#documentation": "

If this parameter is unset (null) or if you set it to false,\n and the stream has registered consumers, the call to DeleteStream fails\n with a ResourceInUseException.

" } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -418,7 +485,12 @@ } ], "traits": { - "smithy.api#documentation": "

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of\n the data stream and the name you gave the consumer when you registered it. You may also\n provide all three parameters, as long as they don't conflict with each other. If you\n don't know the name or ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of\n all the consumers that are currently registered with a given data stream. The\n description of a consumer contains its name and ARN.

\n

This operation has a limit of five transactions per second per stream.

" + "smithy.api#documentation": "

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of\n the data stream and the name you gave the consumer when you registered it. You may also\n provide all three parameters, as long as they don't conflict with each other. If you\n don't know the name or ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of\n all the consumers that are currently registered with a given data stream. The\n description of a consumer contains its name and ARN.

\n

This operation has a limit of five transactions per second per stream.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#DeregisterStreamConsumerInput": { @@ -427,7 +499,10 @@ "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { - "smithy.api#documentation": "

The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

" + "smithy.api#documentation": "

The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } } }, "ConsumerName": { @@ -439,7 +514,10 @@ "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { - "smithy.api#documentation": "

The ARN returned by Kinesis Data Streams when you registered the consumer. If you\n don't know the ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of all the consumers\n that are currently registered with a given data stream. The description of a consumer\n contains its ARN.

" + "smithy.api#documentation": "

The ARN returned by Kinesis Data Streams when you registered the consumer. If you\n don't know the ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of all the consumers\n that are currently registered with a given data stream. The description of a consumer\n contains its ARN.

", + "smithy.rules#contextParam": { + "name": "ConsumerARN" + } } } } @@ -458,7 +536,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the shard limits and usage for the account.

\n

If you update your account limits, the old limits might be returned for a few\n minutes.

\n

This operation has a limit of one transaction per second per account.

" + "smithy.api#documentation": "

Describes the shard limits and usage for the account.

\n

If you update your account limits, the old limits might be returned for a few\n minutes.

\n

This operation has a limit of one transaction per second per account.

" } }, "com.amazonaws.kinesis#DescribeLimitsInput": { @@ -507,6 +585,12 @@ "target": "com.amazonaws.kinesis#DescribeStreamOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesis#InvalidArgumentException" + }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, @@ -515,7 +599,12 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified Kinesis data stream.

\n \n

This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the\n specified Kinesis data stream and the ListShards API to list the\n shards in a specified data stream and obtain information about each shard.

\n \n

The information returned includes the stream name, Amazon Resource Name (ARN),\n creation time, enhanced metric configuration, and shard map. The shard map is an array\n of shard objects. For each shard object, there is the hash key and sequence number\n ranges that the shard spans, and the IDs of any earlier shards that played in a role in\n creating the shard. Every record ingested in the stream is identified by a sequence\n number, which is assigned when the record is put into the stream.

\n\n

You can limit the number of shards returned by each call. For more information, see\n Retrieving\n Shards from a Stream in the Amazon Kinesis Data Streams Developer\n Guide.

\n

There are no guarantees about the chronological order shards returned. To process\n shards in chronological order, use the ID of the parent shard to track the lineage to\n the oldest shard.

\n

This operation has a limit of 10 transactions per second per account.

", + "smithy.api#documentation": "

Describes the specified Kinesis data stream.

\n \n

This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the\n specified Kinesis data stream and the ListShards API to list the\n shards in a specified data stream and obtain information about each shard.

\n \n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

The information returned includes the stream name, Amazon Resource Name (ARN),\n creation time, enhanced metric configuration, and shard map. The shard map is an array\n of shard objects. For each shard object, there is the hash key and sequence number\n ranges that the shard spans, and the IDs of any earlier shards that played in a role in\n creating the shard. Every record ingested in the stream is identified by a sequence\n number, which is assigned when the record is put into the stream.

\n

You can limit the number of shards returned by each call. For more information, see\n Retrieving\n Shards from a Stream in the Amazon Kinesis Data Streams Developer\n Guide.

\n

There are no guarantees about the chronological order shards returned. To process\n shards in chronological order, use the ID of the parent shard to track the lineage to\n the oldest shard.

\n

This operation has a limit of 10 transactions per second per account.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + }, "smithy.waiters#waitable": { "StreamExists": { "acceptors": [ @@ -566,7 +655,12 @@ } ], "traits": { - "smithy.api#documentation": "

To get the description of a registered consumer, provide the ARN of the consumer.\n Alternatively, you can provide the ARN of the data stream and the name you gave the\n consumer when you registered it. You may also provide all three parameters, as long as\n they don't conflict with each other. If you don't know the name or ARN of the consumer\n that you want to describe, you can use the ListStreamConsumers\n operation to get a list of the descriptions of all the consumers that are currently\n registered with a given data stream.

\n

This operation has a limit of 20 transactions per second per stream.

" + "smithy.api#documentation": "

To get the description of a registered consumer, provide the ARN of the consumer.\n Alternatively, you can provide the ARN of the data stream and the name you gave the\n consumer when you registered it. You may also provide all three parameters, as long as\n they don't conflict with each other. If you don't know the name or ARN of the consumer\n that you want to describe, you can use the ListStreamConsumers\n operation to get a list of the descriptions of all the consumers that are currently\n registered with a given data stream.

\n

This operation has a limit of 20 transactions per second per stream.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#DescribeStreamConsumerInput": { @@ -575,7 +669,10 @@ "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { - "smithy.api#documentation": "

The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

" + "smithy.api#documentation": "

The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } } }, "ConsumerName": { @@ -587,7 +684,10 @@ "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { - "smithy.api#documentation": "

The ARN returned by Kinesis Data Streams when you registered the consumer.

" + "smithy.api#documentation": "

The ARN returned by Kinesis Data Streams when you registered the consumer.

", + "smithy.rules#contextParam": { + "name": "ConsumerARN" + } } } } @@ -610,8 +710,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream to describe.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream to describe.

" } }, "Limit": { @@ -623,7 +722,16 @@ "ExclusiveStartShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

The shard ID of the shard to start with.

\n

Specify this parameter to indicate that you want to describe the stream starting with\n the shard whose ID immediately follows ExclusiveStartShardId.

\n

If you don't specify this parameter, the default behavior for\n DescribeStream is to describe the stream starting with the first shard\n in the stream.

" + "smithy.api#documentation": "

The shard ID of the shard to start with.

\n

Specify this parameter to indicate that you want to describe the stream starting with\n the shard whose ID immediately follows ExclusiveStartShardId.

\n

If you don't specify this parameter, the default behavior for\n DescribeStream is to describe the stream starting with the first shard\n in the stream.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } } } }, @@ -664,6 +772,12 @@ "target": "com.amazonaws.kinesis#DescribeStreamSummaryOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesis#InvalidArgumentException" + }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, @@ -672,7 +786,12 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a summarized description of the specified Kinesis data stream without the\n shard list.

\n

The information returned includes the stream name, Amazon Resource Name (ARN), status,\n record retention period, approximate creation time, monitoring, encryption details, and\n open shard count.

\n

\n DescribeStreamSummary has a limit of 20 transactions per second per\n account.

" + "smithy.api#documentation": "

Provides a summarized description of the specified Kinesis data stream without the\n shard list.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

The information returned includes the stream name, Amazon Resource Name (ARN), status,\n record retention period, approximate creation time, monitoring, encryption details, and\n open shard count.

\n

\n DescribeStreamSummary has a limit of 20 transactions per second per\n account.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#DescribeStreamSummaryInput": { @@ -681,8 +800,16 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream to describe.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream to describe.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } } } } @@ -708,6 +835,9 @@ "target": "com.amazonaws.kinesis#EnhancedMonitoringOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -722,7 +852,12 @@ } ], "traits": { - "smithy.api#documentation": "

Disables enhanced monitoring.

" + "smithy.api#documentation": "

Disables enhanced monitoring.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n ", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#DisableEnhancedMonitoringInput": { @@ -731,16 +866,24 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the Kinesis data stream for which to disable enhanced monitoring.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the Kinesis data stream for which to disable enhanced monitoring.

" } }, "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "

List of shard-level metrics to disable.

\n

The following are the valid shard-level metrics. The value \"ALL\" disables\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", + "smithy.api#documentation": "

List of shard-level metrics to disable.

\n

The following are the valid shard-level metrics. The value \"ALL\" disables\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -756,6 +899,9 @@ "target": "com.amazonaws.kinesis#EnhancedMonitoringOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -770,7 +916,12 @@ } ], "traits": { - "smithy.api#documentation": "

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

" + "smithy.api#documentation": "

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n ", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#EnableEnhancedMonitoringInput": { @@ -779,16 +930,24 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream for which to enable enhanced monitoring.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream for which to enable enhanced monitoring.

" } }, "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "

List of shard-level metrics to enable.

\n

The following are the valid shard-level metrics. The value \"ALL\" enables\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", + "smithy.api#documentation": "

List of shard-level metrics to enable.

\n

The following are the valid shard-level metrics. The value \"ALL\" enables\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -796,18 +955,20 @@ } }, "com.amazonaws.kinesis#EncryptionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "KMS", - "name": "KMS" + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" } - ] + } } }, "com.amazonaws.kinesis#EnhancedMetrics": { @@ -816,7 +977,7 @@ "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { - "smithy.api#documentation": "

List of shard-level metrics.

\n

The following are the valid shard-level metrics. The value \"ALL\" enhances\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

" + "smithy.api#documentation": "

List of shard-level metrics.

\n

The following are the valid shard-level metrics. The value \"ALL\" enhances\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

" } } }, @@ -850,6 +1011,12 @@ "traits": { "smithy.api#documentation": "

Represents the list of all the metrics that would be in the enhanced state after the\n operation.

" } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

" + } } }, "traits": { @@ -898,6 +1065,9 @@ "target": "com.amazonaws.kinesis#GetRecordsOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#ExpiredIteratorException" }, @@ -930,7 +1100,12 @@ } ], "traits": { - "smithy.api#documentation": "

Gets data records from a Kinesis data stream's shard.

\n

Specify a shard iterator using the ShardIterator parameter. The shard\n iterator specifies the position in the shard from which you want to start reading data\n records sequentially. If there are no records available in the portion of the shard that\n the iterator points to, GetRecords returns an empty list. It might\n take multiple calls to get to a portion of the shard that contains records.

\n

You can scale by provisioning multiple shards per stream while considering service\n limits (for more information, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide). Your application should have one thread per shard, each reading\n continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the\n shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in\n NextShardIterator. Specify the shard iterator returned in\n NextShardIterator in subsequent calls to GetRecords.\n If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator.\n You can terminate the loop when the shard is closed, or when the shard iterator reaches\n the record with the sequence number or other attribute that marks it as the last record\n to process.

\n

Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per\n second. You can ensure that your calls don't exceed the maximum supported size or\n throughput by using the Limit parameter to specify the maximum number of\n records that GetRecords can return. Consider your average record size\n when determining this limit. The maximum number of records that can be returned per call\n is 10,000.

\n\n

The size of the data returned by GetRecords varies depending on the\n utilization of the shard. It is recommended that consumer applications retrieve records\n via the GetRecords command using the 5 TPS limit to remain caught up.\n Retrieving records less frequently can lead to consumer applications falling behind. The\n maximum size of data that GetRecords can return is 10 MiB. If a call\n returns this amount of data, subsequent calls made within the next 5 seconds throw\n ProvisionedThroughputExceededException. If there is insufficient\n provisioned throughput on the stream, subsequent calls made within the next 1 second\n throw ProvisionedThroughputExceededException. GetRecords\n doesn't return any data when it throws an exception. For this reason, we recommend that\n you wait 1 second between calls to GetRecords. However, it's possible\n that the application will get exceptions for longer than 1 second.

\n\n\n\n\n\n\n\n\n

To detect whether the application is falling behind in processing, you can use the\n MillisBehindLatest response attribute. You can also monitor the stream\n using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon\n Kinesis Data Streams Developer Guide).

\n

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp,\n that is set when a stream successfully receives and stores a record. This is commonly\n referred to as a server-side time stamp, whereas a client-side time stamp is set when a\n data producer creates or sends the record to a stream (a data producer is any data\n source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time\n stamp accuracy, or that the time stamp is always increasing. For example, records in a\n shard or across a stream might have time stamps that are out of order.

\n

This operation has a limit of five transactions per second per shard.

" + "smithy.api#documentation": "

Gets data records from a Kinesis data stream's shard.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter in addition to the ShardIterator parameter.

\n \n

Specify a shard iterator using the ShardIterator parameter. The shard\n iterator specifies the position in the shard from which you want to start reading data\n records sequentially. If there are no records available in the portion of the shard that\n the iterator points to, GetRecords returns an empty list. It might\n take multiple calls to get to a portion of the shard that contains records.

\n

You can scale by provisioning multiple shards per stream while considering service\n limits (for more information, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide). Your application should have one thread per shard, each reading\n continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the\n shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in\n NextShardIterator. Specify the shard iterator returned in\n NextShardIterator in subsequent calls to GetRecords.\n If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator.\n You can terminate the loop when the shard is closed, or when the shard iterator reaches\n the record with the sequence number or other attribute that marks it as the last record\n to process.

\n

Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per\n second. You can ensure that your calls don't exceed the maximum supported size or\n throughput by using the Limit parameter to specify the maximum number of\n records that GetRecords can return. Consider your average record size\n when determining this limit. The maximum number of records that can be returned per call\n is 10,000.

\n

The size of the data returned by GetRecords varies depending on the\n utilization of the shard. It is recommended that consumer applications retrieve records\n via the GetRecords command using the 5 TPS limit to remain caught up.\n Retrieving records less frequently can lead to consumer applications falling behind. The\n maximum size of data that GetRecords can return is 10 MiB. If a call\n returns this amount of data, subsequent calls made within the next 5 seconds throw\n ProvisionedThroughputExceededException. If there is insufficient\n provisioned throughput on the stream, subsequent calls made within the next 1 second\n throw ProvisionedThroughputExceededException. GetRecords\n doesn't return any data when it throws an exception. For this reason, we recommend that\n you wait 1 second between calls to GetRecords. However, it's possible\n that the application will get exceptions for longer than 1 second.

\n

To detect whether the application is falling behind in processing, you can use the\n MillisBehindLatest response attribute. You can also monitor the stream\n using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon\n Kinesis Data Streams Developer Guide).

\n

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp,\n that is set when a stream successfully receives and stores a record. This is commonly\n referred to as a server-side time stamp, whereas a client-side time stamp is set when a\n data producer creates or sends the record to a stream (a data producer is any data\n source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time\n stamp accuracy, or that the time stamp is always increasing. For example, records in a\n shard or across a stream might have time stamps that are out of order.

\n

This operation has a limit of five transactions per second per shard.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "data" + } + } } }, "com.amazonaws.kinesis#GetRecordsInput": { @@ -948,6 +1123,15 @@ "traits": { "smithy.api#documentation": "

The maximum number of records to return. Specify a value of up to 10,000. If you\n specify a value that is greater than 10,000, GetRecords throws\n InvalidArgumentException. The default value is 10,000.

" } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -1005,6 +1189,9 @@ "target": "com.amazonaws.kinesis#GetShardIteratorOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -1016,7 +1203,12 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is\n returned to the requester.

\n

A shard iterator specifies the shard position from which to start reading data records\n sequentially. The position is specified using the sequence number of a data record in a\n shard. A sequence number is the identifier associated with every record ingested in the\n stream, and is assigned when a record is put into the stream. Each stream has one or\n more shards.

\n

You must specify the shard iterator type. For example, you can set the\n ShardIteratorType parameter to read exactly from the position denoted\n by a specific sequence number by using the AT_SEQUENCE_NUMBER shard\n iterator type. Alternatively, the parameter can read right after the sequence number by\n using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers\n returned by earlier calls to PutRecord, PutRecords,\n GetRecords, or DescribeStream. In the request,\n you can specify the shard iterator type AT_TIMESTAMP to read records from\n an arbitrary point in time, TRIM_HORIZON to cause\n ShardIterator to point to the last untrimmed record in the shard in the\n system (the oldest data record in the shard), or LATEST so that you always\n read the most recent data in the shard.

\n

When you read repeatedly from a stream, use a GetShardIterator\n request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard\n iterator is returned by every GetRecords request in\n NextShardIterator, which you use in the ShardIterator\n parameter of the next GetRecords request.

\n

If a GetShardIterator request is made too often, you receive a\n ProvisionedThroughputExceededException. For more information about\n throughput limits, see GetRecords, and Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide.

\n

If the shard is closed, GetShardIterator returns a valid iterator\n for the last sequence number of the shard. A shard can be closed as a result of using\n SplitShard or MergeShards.

\n

\n GetShardIterator has a limit of five transactions per second per\n account per open shard.

" + "smithy.api#documentation": "

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is\n returned to the requester.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

A shard iterator specifies the shard position from which to start reading data records\n sequentially. The position is specified using the sequence number of a data record in a\n shard. A sequence number is the identifier associated with every record ingested in the\n stream, and is assigned when a record is put into the stream. Each stream has one or\n more shards.

\n

You must specify the shard iterator type. For example, you can set the\n ShardIteratorType parameter to read exactly from the position denoted\n by a specific sequence number by using the AT_SEQUENCE_NUMBER shard\n iterator type. Alternatively, the parameter can read right after the sequence number by\n using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers\n returned by earlier calls to PutRecord, PutRecords,\n GetRecords, or DescribeStream. In the request,\n you can specify the shard iterator type AT_TIMESTAMP to read records from\n an arbitrary point in time, TRIM_HORIZON to cause\n ShardIterator to point to the last untrimmed record in the shard in the\n system (the oldest data record in the shard), or LATEST so that you always\n read the most recent data in the shard.

\n

When you read repeatedly from a stream, use a GetShardIterator\n request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard\n iterator is returned by every GetRecords request in\n NextShardIterator, which you use in the ShardIterator\n parameter of the next GetRecords request.

\n

If a GetShardIterator request is made too often, you receive a\n ProvisionedThroughputExceededException. For more information about\n throughput limits, see GetRecords, and Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide.

\n

If the shard is closed, GetShardIterator returns a valid iterator\n for the last sequence number of the shard. A shard can be closed as a result of using\n SplitShard or MergeShards.

\n

\n GetShardIterator has a limit of five transactions per second per\n account per open shard.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "data" + } + } } }, "com.amazonaws.kinesis#GetShardIteratorInput": { @@ -1025,8 +1217,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream.

" } }, "ShardId": { @@ -1039,7 +1230,7 @@ "ShardIteratorType": { "target": "com.amazonaws.kinesis#ShardIteratorType", "traits": { - "smithy.api#documentation": "

Determines how the shard iterator is used to start reading data records from the\n shard.

\n

The following are the valid Amazon Kinesis shard iterator types:

\n ", + "smithy.api#documentation": "

Determines how the shard iterator is used to start reading data records from the\n shard.

\n

The following are the valid Amazon Kinesis shard iterator types:

\n ", "smithy.api#required": {} } }, @@ -1054,6 +1245,15 @@ "traits": { "smithy.api#documentation": "

The time stamp of the data record from which to start reading. Used with shard\n iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in\n milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or\n 1459799926.480. If a record with this exact time stamp does not exist,\n the iterator returned is for the next (later) record. If the time stamp is older than\n the current trim horizon, the iterator returned is for the oldest untrimmed data record\n (TRIM_HORIZON).

" } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -1111,6 +1311,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -1125,7 +1328,12 @@ } ], "traits": { - "smithy.api#documentation": "

Increases the Kinesis data stream's retention period, which is the length of time data\n records are accessible after they are added to the stream. The maximum value of a\n stream's retention period is 8760 hours (365 days).

\n

If you choose a longer stream retention period, this operation increases the time\n period during which records that have not yet expired are accessible. However, it does\n not make previous, expired data (older than the stream's previous retention period)\n accessible after the operation has been called. For example, if a stream's retention\n period is set to 24 hours and is increased to 168 hours, any data that is older than 24\n hours remains inaccessible to consumer applications.

" + "smithy.api#documentation": "

Increases the Kinesis data stream's retention period, which is the length of time data\n records are accessible after they are added to the stream. The maximum value of a\n stream's retention period is 8760 hours (365 days).

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

If you choose a longer stream retention period, this operation increases the time\n period during which records that have not yet expired are accessible. However, it does\n not make previous, expired data (older than the stream's previous retention period)\n accessible after the operation has been called. For example, if a stream's retention\n period is set to 24 hours and is increased to 168 hours, any data that is older than 24\n hours remains inaccessible to consumer applications.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#IncreaseStreamRetentionPeriodInput": { @@ -1134,8 +1342,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream to modify.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream to modify.

" } }, "RetentionPeriodHours": { @@ -1144,6 +1351,15 @@ "smithy.api#documentation": "

The new retention period of the stream, in hours. Must be more than the current\n retention period.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -1388,17 +1604,17 @@ "h2" ] }, - "smithy.api#documentation": "Amazon Kinesis Data Streams Service API Reference\n

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time\n processing of streaming big data.

", + "smithy.api#documentation": "Amazon Kinesis Data Streams Service API Reference\n

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time\n processing of streaming big data.

", "smithy.api#title": "Amazon Kinesis", "smithy.api#xmlNamespace": { "uri": "http://kinesis.amazonaws.com/doc/2013-12-02" }, "smithy.rules#endpointRuleSet": { - "version": "1.0", + "version": "1.3", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -1421,6 +1637,21 @@ "required": false, "documentation": "Override the endpoint used to send this request", "type": "String" + }, + "StreamARN": { + "required": false, + "documentation": "The ARN of the Kinesis stream", + "type": "String" + }, + "OperationType": { + "required": false, + "documentation": "Internal parameter to distinguish between Control/Data plane API and accordingly generate control/data plane endpoint", + "type": "String" + }, + "ConsumerARN": { + "required": false, + "documentation": "The ARN of the Kinesis consumer", + "type": "String" } }, "rules": [ @@ -1444,89 +1675,61 @@ "fn": "isSet", "argv": [ { - "ref": "Endpoint" + "ref": "StreamARN" } ] }, { - "fn": "parseURL", + "fn": "not", "argv": [ { - "ref": "Endpoint" - } - ], - "assign": "url" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseFIPS" - }, - true + "ref": "Endpoint" + } ] } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + ] }, { - "conditions": [], - "type": "tree", - "rules": [ + "fn": "not", + "argv": [ { - "conditions": [ + "fn": "stringEquals", + "argv": [ { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ { - "ref": "UseDualStack" + "ref": "PartitionResult" }, - true + "name" ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "aws-iso" + ] } ] - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] }, { - "fn": "booleanEquals", + "fn": "not", "argv": [ { - "ref": "UseDualStack" - }, - true + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-b" + ] + } ] } ], @@ -1535,14 +1738,1091 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.parseArn", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "ref": "StreamARN" + } + ], + "assign": "arn" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "arn" + }, + "accountId" + ] + }, + false + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "arn" + }, + "region" + ] + }, + false + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "arn" + }, + "service" + ] + }, + "kinesis" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "arn" + }, + "resourceId[0]" + ], + "assign": "arnType" + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "stream" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "{arn#partition}" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "OperationType" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled, but this partition does not support DualStack.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled, but this partition does not support FIPS.", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Operation Type is not set. Please contact service team for resolution.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Partition: {arn#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: Kinesis ARNs don't support `{arnType}` arn types.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: No ARN type specified", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn#service}.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: Invalid region.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: Invalid account id.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: Failed to parse ARN.", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "ConsumerARN" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso" + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-b" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "ConsumerARN" + } + ], + "assign": "arn" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "arn" + }, + "accountId" + ] + }, + false + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "arn" + }, + "region" + ] + }, + false + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "arn" + }, + "service" + ] + }, + "kinesis" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "arn" + }, + "resourceId[0]" + ], + "assign": "arnType" + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "arnType" + }, + "stream" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "{arn#partition}" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "OperationType" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled, but this partition does not support DualStack.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled, but this partition does not support FIPS.", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Operation Type is not set. Please contact service team for resolution.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Partition: {arn#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: Kinesis ARNs don't support `{arnType}` arn types.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: No ARN type specified", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn#service}.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: Invalid region.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: Invalid account id.", + "type": "error" + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid ARN: Failed to parse ARN.", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" }, "supportsFIPS" ] @@ -1719,8 +2999,8 @@ }, "params": { "Region": "ap-south-2", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1732,8 +3012,8 @@ }, "params": { "Region": "ap-south-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1745,8 +3025,8 @@ }, "params": { "Region": "ap-south-2", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1758,8 +3038,8 @@ }, "params": { "Region": "ap-south-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1771,8 +3051,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1784,8 +3064,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1797,8 +3077,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1810,8 +3090,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1823,8 +3103,8 @@ }, "params": { "Region": "eu-south-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1836,8 +3116,8 @@ }, "params": { "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1849,8 +3129,8 @@ }, "params": { "Region": "eu-south-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1862,8 +3142,8 @@ }, "params": { "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1875,8 +3155,8 @@ }, "params": { "Region": "eu-south-2", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1888,8 +3168,8 @@ }, "params": { "Region": "eu-south-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1901,8 +3181,8 @@ }, "params": { "Region": "eu-south-2", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1914,8 +3194,8 @@ }, "params": { "Region": "eu-south-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1927,8 +3207,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1940,8 +3220,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1953,8 +3233,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1966,8 +3246,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1979,8 +3259,8 @@ }, "params": { "Region": "me-central-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1992,8 +3272,8 @@ }, "params": { "Region": "me-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2005,8 +3285,8 @@ }, "params": { "Region": "me-central-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2018,8 +3298,8 @@ }, "params": { "Region": "me-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2031,8 +3311,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2044,8 +3324,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2057,8 +3337,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2070,8 +3350,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2083,8 +3363,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2096,8 +3376,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2109,8 +3389,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2122,8 +3402,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2133,8 +3413,8 @@ }, "params": { "Region": "us-iso-west-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2146,8 +3426,8 @@ }, "params": { "Region": "us-iso-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2157,8 +3437,8 @@ }, "params": { "Region": "us-iso-west-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2170,8 +3450,8 @@ }, "params": { "Region": "us-iso-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2183,8 +3463,8 @@ }, "params": { "Region": "eu-central-2", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2196,8 +3476,8 @@ }, "params": { "Region": "eu-central-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2209,8 +3489,8 @@ }, "params": { "Region": "eu-central-2", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2222,8 +3502,8 @@ }, "params": { "Region": "eu-central-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2235,8 +3515,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2248,8 +3528,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2261,8 +3541,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2274,8 +3554,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2287,8 +3567,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2300,8 +3580,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2313,8 +3593,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2326,8 +3606,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2339,8 +3619,8 @@ }, "params": { "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2352,8 +3632,8 @@ }, "params": { "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2365,8 +3645,8 @@ }, "params": { "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2378,8 +3658,8 @@ }, "params": { "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2391,8 +3671,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2404,8 +3684,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2417,8 +3697,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2430,8 +3710,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2443,8 +3723,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2456,8 +3736,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2469,8 +3749,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2482,8 +3762,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2495,8 +3775,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2508,8 +3788,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2521,8 +3801,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2534,8 +3814,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2547,8 +3827,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2560,8 +3840,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2573,8 +3853,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2586,8 +3866,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2599,8 +3879,8 @@ }, "params": { "Region": "ap-northeast-3", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2612,8 +3892,8 @@ }, "params": { "Region": "ap-northeast-3", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2625,8 +3905,8 @@ }, "params": { "Region": "ap-northeast-3", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2638,8 +3918,8 @@ }, "params": { "Region": "ap-northeast-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2651,8 +3931,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2664,8 +3944,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2677,8 +3957,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2690,8 +3970,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2703,8 +3983,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2716,8 +3996,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2729,8 +4009,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2742,8 +4022,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2755,8 +4035,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2768,8 +4048,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2781,8 +4061,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2794,8 +4074,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2807,8 +4087,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2820,8 +4100,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2833,8 +4113,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2846,8 +4126,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2859,8 +4139,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2872,8 +4152,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2885,8 +4165,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2898,8 +4178,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2911,8 +4191,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2924,8 +4204,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2937,8 +4217,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2950,8 +4230,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2963,8 +4243,8 @@ }, "params": { "Region": "ca-west-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2976,8 +4256,8 @@ }, "params": { "Region": "ca-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2989,8 +4269,8 @@ }, "params": { "Region": "ca-west-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -3002,8 +4282,8 @@ }, "params": { "Region": "ca-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -3015,8 +4295,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -3028,8 +4308,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -3041,8 +4321,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -3054,8 +4334,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -3067,8 +4347,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -3080,8 +4360,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -3093,8 +4373,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -3106,8 +4386,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -3119,8 +4399,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -3132,8 +4412,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -3145,8 +4425,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -3158,8 +4438,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -3169,8 +4449,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -3182,8 +4462,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -3193,8 +4473,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -3206,406 +4486,1189 @@ }, "params": { "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.ap-southeast-4.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis.ap-southeast-4.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.ap-southeast-5.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis.ap-southeast-5.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://kinesis.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Invalid ARN: Failed to parse ARN.", + "expect": { + "error": "Invalid ARN: Failed to parse ARN." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn" + } + }, + { + "documentation": "Invalid ARN: partition missing from ARN.", + "expect": { + "error": "Invalid ARN: Failed to parse ARN." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn::kinesis:us-west-2:123456789012:stream/testStream" + } + }, + { + "documentation": "Invalid ARN: partitions mismatch.", + "expect": { + "error": "Partition: aws from ARN doesn't match with partition name: aws-us-gov." + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/testStream" + } + }, + { + "documentation": "Invalid ARN: Not Kinesis", + "expect": { + "error": "Invalid ARN: The ARN was not for the Kinesis service, found: s3." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn:aws:s3:us-west-2:123456789012:stream/testStream" + } + }, + { + "documentation": "Invalid ARN: Region is missing in ARN", + "expect": { + "error": "Invalid ARN: Invalid region." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn:aws:kinesis::123456789012:stream/testStream" + } + }, + { + "documentation": "Invalid ARN: Region is empty string in ARN", + "expect": { + "error": "Invalid ARN: Invalid region." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn:aws:kinesis: :123456789012:stream/testStream" + } + }, + { + "documentation": "Invalid ARN: Invalid account id", + "expect": { + "error": "Invalid ARN: Invalid account id." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn:aws:kinesis:us-east-1::stream/testStream", + "OperationType": "control" + } + }, + { + "documentation": "Invalid ARN: Invalid account id", + "expect": { + "error": "Invalid ARN: Invalid account id." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn:aws:kinesis:us-east-1: :stream/testStream", + "OperationType": "control" + } + }, + { + "documentation": "Invalid ARN: Kinesis ARNs only support stream arn types", + "expect": { + "error": "Invalid ARN: Kinesis ARNs don't support `accesspoint` arn types." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream" + } + }, + { + "documentation": "Dual Stack not supported region.", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": true, + "UseDualStack": true, + "StreamARN": "arn:aws-iso:kinesis:us-iso-west-1:123456789012:stream/testStream", + "OperationType": "control" + } + }, + { + "documentation": "OperationType not set", + "expect": { + "error": "Operation Type is not set. Please contact service team for resolution." + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/testStream" + } + }, + { + "documentation": "Custom Endpoint is specified", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "control", + "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Account endpoint targeting control operation type", + "expect": { + "endpoint": { + "url": "https://123.control-kinesis.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "control", + "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint targeting data operation type", + "expect": { + "endpoint": { + "url": "https://123.data-kinesis.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "data", + "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint with fips targeting data operation type", + "expect": { + "endpoint": { + "url": "https://123.data-kinesis-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "OperationType": "data", + "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint with fips targeting control operation type", + "expect": { + "endpoint": { + "url": "https://123.control-kinesis-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "OperationType": "control", + "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint with Dual Stack and FIPS enabled", + "expect": { + "endpoint": { + "url": "https://123.control-kinesis-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true, + "OperationType": "control", + "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint with Dual Stack enabled", + "expect": { + "endpoint": { + "url": "https://123.data-kinesis.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": true, + "OperationType": "data", + "StreamARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint with FIPS and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://123.control-kinesis.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "control", + "StreamARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream" + } + }, + { + "documentation": "RegionMismatch: client region should be used for endpoint region", + "expect": { + "endpoint": { + "url": "https://123.data-kinesis.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "data", + "StreamARN": "arn:aws:kinesis:us-west-1:123:stream/testStream" + } + }, + { + "documentation": "Account endpoint with FIPS enabled", + "expect": { + "endpoint": { + "url": "https://123.data-kinesis-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": false, + "OperationType": "data", + "StreamARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint with FIPS and DualStack enabled for cn regions.", + "expect": { + "endpoint": { + "url": "https://123.data-kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": true, + "OperationType": "data", + "StreamARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint targeting control operation type in ADC regions", + "expect": { + "endpoint": { + "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "control", + "StreamARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint targeting control operation type in ADC regions", + "expect": { + "endpoint": { + "url": "https://kinesis.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "control", + "StreamARN": "arn:aws-iso:kinesis:us-iso-west-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint targeting data operation type in ADC regions", + "expect": { + "endpoint": { + "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "data", + "StreamARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream" + } + }, + { + "documentation": "Account endpoint with fips targeting control operation type in ADC regions", + "expect": { + "endpoint": { + "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false + "OperationType": "control", + "StreamARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream" } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "documentation": "Account endpoint with fips targeting data operation type in ADC regions", "expect": { "endpoint": { - "url": "https://kinesis-fips.ap-southeast-3.api.aws" + "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { - "Region": "ap-southeast-3", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false, + "OperationType": "data", + "StreamARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream" } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "documentation": "Invalid ConsumerARN: Failed to parse ARN.", "expect": { - "endpoint": { - "url": "https://kinesis-fips.ap-southeast-3.amazonaws.com" - } + "error": "Invalid ARN: Failed to parse ARN." }, "params": { - "Region": "ap-southeast-3", + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true + "ConsumerARN": "arn" } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "documentation": "Invalid ConsumerARN: partition missing from ARN.", "expect": { - "endpoint": { - "url": "https://kinesis.ap-southeast-3.api.aws" - } + "error": "Invalid ARN: Failed to parse ARN." }, "params": { - "Region": "ap-southeast-3", - "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "ConsumerARN": "arn::kinesis:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "Invalid ARN: partitions mismatch.", "expect": { - "endpoint": { - "url": "https://kinesis.ap-southeast-3.amazonaws.com" - } + "error": "Partition: aws from ARN doesn't match with partition name: aws-us-gov." }, "params": { - "Region": "ap-southeast-3", + "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "ConsumerARN": "arn:aws:kinesis:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "documentation": "Invalid ARN: Not Kinesis", "expect": { - "endpoint": { - "url": "https://kinesis-fips.ap-southeast-4.api.aws" - } + "error": "Invalid ARN: The ARN was not for the Kinesis service, found: s3." }, "params": { - "Region": "ap-southeast-4", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "ConsumerARN": "arn:aws:s3:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "documentation": "Invalid ARN: Region is missing in ARN", "expect": { - "endpoint": { - "url": "https://kinesis-fips.ap-southeast-4.amazonaws.com" - } + "error": "Invalid ARN: Invalid region." }, "params": { - "Region": "ap-southeast-4", + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true + "ConsumerARN": "arn:aws:kinesis::123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "documentation": "Invalid ARN: Region is empty string in ARN", "expect": { - "endpoint": { - "url": "https://kinesis.ap-southeast-4.api.aws" - } + "error": "Invalid ARN: Invalid region." }, "params": { - "Region": "ap-southeast-4", - "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "ConsumerARN": "arn:aws:kinesis: :123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "documentation": "Invalid ARN: Invalid account id", "expect": { - "endpoint": { - "url": "https://kinesis.ap-southeast-4.amazonaws.com" - } + "error": "Invalid ARN: Invalid account id." }, "params": { - "Region": "ap-southeast-4", + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "ConsumerARN": "arn:aws:kinesis:us-east-1::stream/testStream/consumer/test-consumer:1525898737", + "OperationType": "control" } }, { - "documentation": "For region ap-southeast-5 with FIPS enabled and DualStack enabled", + "documentation": "Invalid ARN: Invalid account id", "expect": { - "endpoint": { - "url": "https://kinesis-fips.ap-southeast-5.api.aws" - } + "error": "Invalid ARN: Invalid account id." }, "params": { - "Region": "ap-southeast-5", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "ConsumerARN": "arn:aws:kinesis:us-east-1: :stream/testStream/consumer/test-consumer:1525898737", + "OperationType": "control" } }, { - "documentation": "For region ap-southeast-5 with FIPS enabled and DualStack disabled", + "documentation": "Invalid ARN: Kinesis ARNs only support stream arn/consumer arn types", "expect": { - "endpoint": { - "url": "https://kinesis-fips.ap-southeast-5.amazonaws.com" - } + "error": "Invalid ARN: Kinesis ARNs don't support `accesspoint` arn types." }, "params": { - "Region": "ap-southeast-5", + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true + "ConsumerARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack enabled", + "documentation": "Dual Stack not supported region.", "expect": { - "endpoint": { - "url": "https://kinesis.ap-southeast-5.api.aws" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "ap-southeast-5", + "Region": "us-iso-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": false + "ConsumerARN": "arn:aws-iso:kinesis:us-iso-west-1:123456789012:stream/testStream/consumer/test-consumer:1525898737", + "OperationType": "control" } }, { - "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack disabled", + "documentation": "OperationType not set", "expect": { - "endpoint": { - "url": "https://kinesis.ap-southeast-5.amazonaws.com" - } + "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { - "Region": "ap-southeast-5", + "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "ConsumerARN": "arn:aws:kinesis:us-east-1:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "Custom Endpoint is specified", "expect": { "endpoint": { - "url": "https://kinesis-fips.us-east-1.api.aws" + "url": "https://example.com" } }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "control", + "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737", + "Endpoint": "https://example.com" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "Account endpoint targeting control operation type", "expect": { "endpoint": { - "url": "https://kinesis-fips.us-east-1.amazonaws.com" + "url": "https://123.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true + "OperationType": "control", + "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "Account endpoint targeting data operation type", "expect": { "endpoint": { - "url": "https://kinesis.us-east-1.api.aws" + "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "data", + "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "Account endpoint with fips targeting data operation type", "expect": { "endpoint": { - "url": "https://kinesis.us-east-1.amazonaws.com" + "url": "https://123.data-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false + "OperationType": "data", + "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "documentation": "Account endpoint with fips targeting control operation type", "expect": { "endpoint": { - "url": "https://kinesis-fips.us-east-2.api.aws" + "url": "https://123.control-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "OperationType": "control", + "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "Account endpoint with Dual Stack and FIPS enabled", "expect": { "endpoint": { - "url": "https://kinesis-fips.us-east-2.amazonaws.com" + "url": "https://123.control-kinesis-fips.us-east-1.api.aws" } }, "params": { - "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true, + "OperationType": "control", + "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "documentation": "Account endpoint with Dual Stack enabled", "expect": { "endpoint": { - "url": "https://kinesis.us-east-2.api.aws" + "url": "https://123.data-kinesis.us-west-1.api.aws" } }, "params": { - "Region": "us-east-2", + "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "OperationType": "data", + "ConsumerARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "Account endpoint with FIPS and DualStack disabled", "expect": { "endpoint": { - "url": "https://kinesis.us-east-2.amazonaws.com" + "url": "https://123.control-kinesis.us-west-1.amazonaws.com" } }, "params": { - "Region": "us-east-2", + "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "OperationType": "control", + "ConsumerARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "documentation": "RegionMismatch: client region should be used for endpoint region", "expect": { "endpoint": { - "url": "https://kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { - "Region": "cn-northwest-1", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "data", + "ConsumerARN": "arn:aws:kinesis:us-west-1:123:stream/testStream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "documentation": "Account endpoint with FIPS enabled", "expect": { "endpoint": { - "url": "https://kinesis-fips.cn-northwest-1.amazonaws.com.cn" + "url": "https://123.data-kinesis-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "OperationType": "data", + "ConsumerARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "documentation": "Account endpoint with FIPS and DualStack enabled for cn regions.", "expect": { "endpoint": { - "url": "https://kinesis.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://123.data-kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": false + "OperationType": "data", + "ConsumerARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "documentation": "Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { - "url": "https://kinesis.cn-northwest-1.amazonaws.com.cn" + "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "cn-northwest-1", + "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "OperationType": "control", + "ConsumerARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "documentation": "Account endpoint targeting control operation type in ADC regions", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://kinesis.us-iso-west-1.c2s.ic.gov" + } }, "params": { - "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": true + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false, + "OperationType": "control", + "ConsumerARN": "arn:aws-iso:kinesis:us-iso-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "documentation": "Account endpoint targeting data operation type in ADC regions", "expect": { "endpoint": { - "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" + "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": true + "OperationType": "data", + "ConsumerARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "documentation": "Account endpoint with fips targeting control operation type in ADC regions", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" + } }, "params": { - "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false, + "OperationType": "control", + "ConsumerARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "documentation": "Account endpoint with fips targeting data operation type in ADC regions", "expect": { "endpoint": { - "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" + "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false + "OperationType": "data", + "ConsumerARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "ConsumerARN targeting US-EAST-1", "expect": { "endpoint": { - "url": "https://example.com" + "url": "https://123456789123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, - "Endpoint": "https://example.com" + "OperationType": "data", + "ConsumerARN": "arn:aws:kinesis:us-east-1:123456789123:stream/foobar/consumer/test-consumer:1525898737" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "documentation": "Both StreamARN and ConsumerARN specified. StreamARN should take precedence", "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + "endpoint": { + "url": "https://123.data-kinesis.us-east-1.amazonaws.com" + } }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, - "Endpoint": "https://example.com" + "UseDualStack": false, + "OperationType": "data", + "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/foobar", + "ConsumerARN": "arn:aws:kinesis:us-east-1:123456789123:stream/foobar/consumer/test-consumer:1525898737" } } ], @@ -3637,6 +5700,9 @@ "target": "com.amazonaws.kinesis#ListShardsOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#ExpiredNextTokenException" }, @@ -3654,7 +5720,12 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the shards in a stream and provides information about each shard. This operation\n has a limit of 1000 transactions per second per data stream.

\n

This action does not list expired shards. For information about expired shards, see\n Data Routing, Data Persistence, and Shard State after a Reshard.

\n \n

This API is a new operation that is used by the Amazon Kinesis Client Library\n (KCL). If you have a fine-grained IAM policy that only allows specific operations,\n you must update your policy to allow calls to this API. For more information, see\n Controlling Access to Amazon Kinesis Data Streams Resources Using\n IAM.

\n " + "smithy.api#documentation": "

Lists the shards in a stream and provides information about each shard. This operation\n has a limit of 1000 transactions per second per data stream.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

This action does not list expired shards. For information about expired shards, see\n Data Routing, Data Persistence, and Shard State after a Reshard.

\n \n

This API is a new operation that is used by the Amazon Kinesis Client Library\n (KCL). If you have a fine-grained IAM policy that only allows specific operations,\n you must update your policy to allow calls to this API. For more information, see\n Controlling Access to Amazon Kinesis Data Streams Resources Using\n IAM.

\n ", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#ListShardsInput": { @@ -3663,37 +5734,46 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the data stream whose shards you want to list.

\n

You cannot specify this parameter if you specify the NextToken\n parameter.

" + "smithy.api#documentation": "

The name of the data stream whose shards you want to list.

\n

You cannot specify this parameter if you specify the NextToken\n parameter.

" } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { - "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards.

\n

Don't specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of shards that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListShards operation.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.

\n " + "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards.

\n

Don't specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of shards that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListShards operation.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.

\n " } }, "ExclusiveStartShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { - "smithy.api#documentation": "

Specify this parameter to indicate that you want to list the shards starting with the\n shard whose ID immediately follows ExclusiveStartShardId.

\n

If you don't specify this parameter, the default behavior is for\n ListShards to list the shards starting with the first one in the\n stream.

\n

You cannot specify this parameter if you specify NextToken.

" + "smithy.api#documentation": "

Specify this parameter to indicate that you want to list the shards starting with the\n shard whose ID immediately follows ExclusiveStartShardId.

\n

If you don't specify this parameter, the default behavior is for\n ListShards to list the shards starting with the first one in the\n stream.

\n

You cannot specify this parameter if you specify NextToken.

" } }, "MaxResults": { "target": "com.amazonaws.kinesis#ListShardsInputLimit", "traits": { - "smithy.api#documentation": "

The maximum number of shards to return in a single call to ListShards.\n The maximum number of shards to return in a single call. The default value is 1000. If\n you specify a value greater than 1000, at most 1000 results are returned.

\n

When the number of shards to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListShards to list the next set of\n shards.

" + "smithy.api#documentation": "

The maximum number of shards to return in a single call to ListShards.\n The maximum number of shards to return in a single call. The default value is 1000. If\n you specify a value greater than 1000, at most 1000 results are returned.

\n

When the number of shards to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListShards to list the next set of\n shards.

" } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { - "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the shards for.

\n

You cannot specify this parameter if you specify the NextToken\n parameter.

" + "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the shards for.

\n

You cannot specify this parameter if you specify the NextToken\n parameter.

" } }, "ShardFilter": { "target": "com.amazonaws.kinesis#ShardFilter", "traits": { - "smithy.api#documentation": "

Enables you to filter out the response of the ListShards API. You can\n only specify one filter at a time.

\n

If you use the ShardFilter parameter when invoking the ListShards API,\n the Type is the required property and must be specified. If you specify the\n AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or\n AT_LATEST types, you do not need to specify either the\n ShardId or the Timestamp optional properties.

\n

If you specify the AFTER_SHARD_ID type, you must also provide the value\n for the optional ShardId property. The ShardId property is\n identical in fuctionality to the ExclusiveStartShardId parameter of the\n ListShards API. When ShardId property is specified, the\n response includes the shards starting with the shard whose ID immediately follows the\n ShardId that you provided.

\n

If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type,\n you must also provide the value for the optional Timestamp property. If you\n specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp\n are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the\n provided timestamp to TIP are returned.

" + "smithy.api#documentation": "

Enables you to filter out the response of the ListShards API. You can\n only specify one filter at a time.

\n

If you use the ShardFilter parameter when invoking the ListShards API,\n the Type is the required property and must be specified. If you specify the\n AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or\n AT_LATEST types, you do not need to specify either the\n ShardId or the Timestamp optional properties.

\n

If you specify the AFTER_SHARD_ID type, you must also provide the value\n for the optional ShardId property. The ShardId property is\n identical in fuctionality to the ExclusiveStartShardId parameter of the\n ListShards API. When ShardId property is specified, the\n response includes the shards starting with the shard whose ID immediately follows the\n ShardId that you provided.

\n

If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type,\n you must also provide the value for the optional Timestamp property. If you\n specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp\n are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the\n provided timestamp to TIP are returned.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } } } } @@ -3719,7 +5799,7 @@ "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { - "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards. For more information about the use of this pagination token\n when calling the ListShards operation, see ListShardsInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.

\n " + "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards. For more information about the use of this pagination token\n when calling the ListShards operation, see ListShardsInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.

\n " } } } @@ -3750,11 +5830,16 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the consumers registered to receive data from a stream using enhanced fan-out,\n and provides information about each consumer.

\n

This operation has a limit of 5 transactions per second per stream.

", + "smithy.api#documentation": "

Lists the consumers registered to receive data from a stream using enhanced fan-out,\n and provides information about each consumer.

\n

This operation has a limit of 5 transactions per second per stream.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" + }, + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } } } }, @@ -3765,13 +5850,16 @@ "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the Kinesis data stream for which you want to list the registered\n consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "StreamARN" + } } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { - "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than\n the default value for the MaxResults parameter, or if you explicitly\n specify a value for MaxResults that is less than the number of consumers\n that are registered with the data stream, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a\n subsequent call to ListStreamConsumers to list the next set of registered\n consumers.

\n

Don't specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of consumers that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListStreamConsumers operation to list the next set of consumers.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to\n ListStreamConsumers, you have 300 seconds to use that value. If you\n specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n " + "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than\n the default value for the MaxResults parameter, or if you explicitly\n specify a value for MaxResults that is less than the number of consumers\n that are registered with the data stream, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a\n subsequent call to ListStreamConsumers to list the next set of registered\n consumers.

\n

Don't specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of consumers that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListStreamConsumers operation to list the next set of consumers.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to\n ListStreamConsumers, you have 300 seconds to use that value. If you\n specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n " } }, "MaxResults": { @@ -3783,7 +5871,7 @@ "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { - "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the consumers for.

\n

You can't specify this parameter if you specify the NextToken parameter.

" + "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the consumers for.

\n

You can't specify this parameter if you specify the NextToken parameter.

" } } } @@ -3809,7 +5897,7 @@ "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { - "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than\n the default value for the MaxResults parameter, or if you explicitly\n specify a value for MaxResults that is less than the number of registered\n consumers, the response includes a pagination token named NextToken. You\n can specify this NextToken value in a subsequent call to\n ListStreamConsumers to list the next set of registered consumers. For\n more information about the use of this pagination token when calling the\n ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to\n ListStreamConsumers, you have 300 seconds to use that value. If you\n specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n " + "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than\n the default value for the MaxResults parameter, or if you explicitly\n specify a value for MaxResults that is less than the number of registered\n consumers, the response includes a pagination token named NextToken. You\n can specify this NextToken value in a subsequent call to\n ListStreamConsumers to list the next set of registered consumers. For\n more information about the use of this pagination token when calling the\n ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to\n ListStreamConsumers, you have 300 seconds to use that value. If you\n specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n " } } } @@ -3823,12 +5911,23 @@ "target": "com.amazonaws.kinesis#ListStreamsOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#ExpiredNextTokenException" + }, + { + "target": "com.amazonaws.kinesis#InvalidArgumentException" + }, { "target": "com.amazonaws.kinesis#LimitExceededException" } ], "traits": { - "smithy.api#documentation": "

Lists your Kinesis data streams.

\n

The number of streams may be too large to return from a single call to\n ListStreams. You can limit the number of returned streams using the\n Limit parameter. If you do not specify a value for the\n Limit parameter, Kinesis Data Streams uses the default limit, which is\n currently 100.

\n

You can detect if there are more streams available to list by using the\n HasMoreStreams flag from the returned output. If there are more streams\n available, you can request more streams by using the name of the last stream returned by\n the ListStreams request in the ExclusiveStartStreamName\n parameter in a subsequent request to ListStreams. The group of stream names\n returned by the subsequent request is then added to the list. You can continue this\n process until all the stream names have been collected in the list.

\n

\n ListStreams has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Lists your Kinesis data streams.

\n

The number of streams may be too large to return from a single call to\n ListStreams. You can limit the number of returned streams using the\n Limit parameter. If you do not specify a value for the\n Limit parameter, Kinesis Data Streams uses the default limit, which is\n currently 100.

\n

You can detect if there are more streams available to list by using the\n HasMoreStreams flag from the returned output. If there are more streams\n available, you can request more streams by using the name of the last stream returned by\n the ListStreams request in the ExclusiveStartStreamName\n parameter in a subsequent request to ListStreams. The group of stream names\n returned by the subsequent request is then added to the list. You can continue this\n process until all the stream names have been collected in the list.

\n

\n ListStreams has a limit of five transactions per second per\n account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "Limit" + } } }, "com.amazonaws.kinesis#ListStreamsInput": { @@ -3845,6 +5944,12 @@ "traits": { "smithy.api#documentation": "

The name of the stream to start the list with.

" } + }, + "NextToken": { + "target": "com.amazonaws.kinesis#NextToken", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { @@ -3876,6 +5981,18 @@ "smithy.api#documentation": "

If set to true, there are more streams available to list.

", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.kinesis#NextToken", + "traits": { + "smithy.api#documentation": "

" + } + }, + "StreamSummaries": { + "target": "com.amazonaws.kinesis#StreamSummaryList", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { @@ -3891,6 +6008,9 @@ "target": "com.amazonaws.kinesis#ListTagsForStreamOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -3902,7 +6022,12 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags for the specified Kinesis data stream. This operation has a limit of\n five transactions per second per account.

" + "smithy.api#documentation": "

Lists the tags for the specified Kinesis data stream. This operation has a limit of\n five transactions per second per account.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n ", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#ListTagsForStreamInput": { @@ -3911,8 +6036,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream.

" } }, "ExclusiveStartTagKey": { @@ -3924,7 +6048,16 @@ "Limit": { "target": "com.amazonaws.kinesis#ListTagsForStreamInputLimit", "traits": { - "smithy.api#documentation": "

The number of tags to return. If this number is less than the total number of tags\n associated with the stream, HasMoreTags is set to true. To\n list additional tags, set ExclusiveStartTagKey to the last key in the\n response.

" + "smithy.api#documentation": "

The number of tags to return. If this number is less than the total number of tags\n associated with the stream, HasMoreTags is set to true. To\n list additional tags, set ExclusiveStartTagKey to the last key in the\n response.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } } } }, @@ -3972,6 +6105,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -3989,7 +6125,12 @@ } ], "traits": { - "smithy.api#documentation": "

Merges two adjacent shards in a Kinesis data stream and combines them into a single\n shard to reduce the stream's capacity to ingest and transport data. Two shards are\n considered adjacent if the union of the hash key ranges for the two shards form a\n contiguous set with no gaps. For example, if you have two shards, one with a hash key\n range of 276...381 and the other with a hash key range of 382...454, then you could\n merge these two shards into a single shard that would have a hash key range of\n 276...454. After the merge, the single child shard receives data for all hash key values\n covered by the two parent shards.

\n

\n MergeShards is called when there is a need to reduce the overall capacity\n of a stream because of excess capacity that is not being used. You must specify the\n shard to be merged and the adjacent shard for a stream. For more information about\n merging shards, see Merge Two\n Shards in the Amazon Kinesis Data Streams Developer\n Guide.

\n

If the stream is in the ACTIVE state, you can call\n MergeShards. If a stream is in the CREATING,\n UPDATING, or DELETING state, MergeShards\n returns a ResourceInUseException. If the specified stream does not exist,\n MergeShards returns a ResourceNotFoundException.

\n

You can use DescribeStreamSummary to check the state of the stream,\n which is returned in StreamStatus.

\n

\n MergeShards is an asynchronous operation. Upon receiving a\n MergeShards request, Amazon Kinesis Data Streams immediately returns a\n response and sets the StreamStatus to UPDATING. After the\n operation is completed, Kinesis Data Streams sets the StreamStatus to\n ACTIVE. Read and write operations continue to work while the stream is\n in the UPDATING state.

\n

You use DescribeStreamSummary and the ListShards\n APIs to determine the shard IDs that are specified in the MergeShards\n request.

\n

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards,\n or SplitShard, you receive a LimitExceededException.

\n

\n MergeShards has a limit of five transactions per second per account.

" + "smithy.api#documentation": "

Merges two adjacent shards in a Kinesis data stream and combines them into a single\n shard to reduce the stream's capacity to ingest and transport data. This API is only\n supported for the data streams with the provisioned capacity mode. Two shards are\n considered adjacent if the union of the hash key ranges for the two shards form a\n contiguous set with no gaps. For example, if you have two shards, one with a hash key\n range of 276...381 and the other with a hash key range of 382...454, then you could\n merge these two shards into a single shard that would have a hash key range of\n 276...454. After the merge, the single child shard receives data for all hash key values\n covered by the two parent shards.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

\n MergeShards is called when there is a need to reduce the overall capacity\n of a stream because of excess capacity that is not being used. You must specify the\n shard to be merged and the adjacent shard for a stream. For more information about\n merging shards, see Merge Two\n Shards in the Amazon Kinesis Data Streams Developer\n Guide.

\n

If the stream is in the ACTIVE state, you can call\n MergeShards. If a stream is in the CREATING,\n UPDATING, or DELETING state, MergeShards\n returns a ResourceInUseException. If the specified stream does not exist,\n MergeShards returns a ResourceNotFoundException.

\n

You can use DescribeStreamSummary to check the state of the stream,\n which is returned in StreamStatus.

\n

\n MergeShards is an asynchronous operation. Upon receiving a\n MergeShards request, Amazon Kinesis Data Streams immediately returns a\n response and sets the StreamStatus to UPDATING. After the\n operation is completed, Kinesis Data Streams sets the StreamStatus to\n ACTIVE. Read and write operations continue to work while the stream is\n in the UPDATING state.

\n

You use DescribeStreamSummary and the ListShards\n APIs to determine the shard IDs that are specified in the MergeShards\n request.

\n

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards,\n or SplitShard, you receive a LimitExceededException.

\n

\n MergeShards has a limit of five transactions per second per account.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#MergeShardsInput": { @@ -3998,8 +6139,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream for the merge.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream for the merge.

" } }, "ShardToMerge": { @@ -4015,6 +6155,15 @@ "smithy.api#documentation": "

The shard ID of the adjacent shard for the merge.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -4022,42 +6171,56 @@ } }, "com.amazonaws.kinesis#MetricsName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IncomingBytes", - "name": "INCOMING_BYTES" - }, - { - "value": "IncomingRecords", - "name": "INCOMING_RECORDS" - }, - { - "value": "OutgoingBytes", - "name": "OUTGOING_BYTES" - }, - { - "value": "OutgoingRecords", - "name": "OUTGOING_RECORDS" - }, - { - "value": "WriteProvisionedThroughputExceeded", - "name": "WRITE_PROVISIONED_THROUGHPUT_EXCEEDED" - }, - { - "value": "ReadProvisionedThroughputExceeded", - "name": "READ_PROVISIONED_THROUGHPUT_EXCEEDED" - }, - { - "value": "IteratorAgeMilliseconds", - "name": "ITERATOR_AGE_MILLISECONDS" - }, - { - "value": "ALL", - "name": "ALL" + "type": "enum", + "members": { + "INCOMING_BYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IncomingBytes" + } + }, + "INCOMING_RECORDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IncomingRecords" + } + }, + "OUTGOING_BYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OutgoingBytes" + } + }, + "OUTGOING_RECORDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OutgoingRecords" + } + }, + "WRITE_PROVISIONED_THROUGHPUT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WriteProvisionedThroughputExceeded" + } + }, + "READ_PROVISIONED_THROUGHPUT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReadProvisionedThroughputExceeded" + } + }, + "ITERATOR_AGE_MILLISECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IteratorAgeMilliseconds" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" } - ] + } } }, "com.amazonaws.kinesis#MetricsNameList": { @@ -4148,6 +6311,9 @@ "target": "com.amazonaws.kinesis#PutRecordOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -4177,7 +6343,12 @@ } ], "traits": { - "smithy.api#documentation": "

Writes a single data record into an Amazon Kinesis data stream. Call\n PutRecord to send data into the stream for real-time ingestion and\n subsequent processing, one record at a time. Each shard can support writes up to 1,000\n records per second, up to a maximum data write total of 1 MiB per second.

\n

You must specify the name of the stream that captures, stores, and transports the\n data; a partition key; and the data blob itself.

\n

The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams to distribute data across shards.\n Kinesis Data Streams segregates the data records that belong to a stream into multiple\n shards, using the partition key associated with each data record to determine the shard\n to which a given data record belongs.

\n

Partition keys are Unicode strings, with a maximum length limit of 256 characters for\n each key. An MD5 hash function is used to map partition keys to 128-bit integer values\n and to map associated data records to shards using the hash key ranges of the shards.\n You can override hashing the partition key to determine the shard by explicitly\n specifying a hash value using the ExplicitHashKey parameter. For more\n information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

\n PutRecord returns the shard ID of where the data record was placed and the\n sequence number that was assigned to the data record.

\n

Sequence numbers increase over time and are specific to a shard within a stream, not\n across all shards within a stream. To guarantee strictly increasing ordering, write\n serially to a shard and use the SequenceNumberForOrdering parameter. For\n more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n \n

After you write a record to a stream, you cannot modify that record or its order\n within the stream.

\n \n

If a PutRecord request cannot be processed because of insufficient\n provisioned throughput on the shard involved in the request, PutRecord\n throws ProvisionedThroughputExceededException.

\n

By default, data records are accessible for 24 hours from the time that they are added\n to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

" + "smithy.api#documentation": "

Writes a single data record into an Amazon Kinesis data stream. Call\n PutRecord to send data into the stream for real-time ingestion and\n subsequent processing, one record at a time. Each shard can support writes up to 1,000\n records per second, up to a maximum data write total of 1 MiB per second.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

You must specify the name of the stream that captures, stores, and transports the\n data; a partition key; and the data blob itself.

\n

The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams to distribute data across shards.\n Kinesis Data Streams segregates the data records that belong to a stream into multiple\n shards, using the partition key associated with each data record to determine the shard\n to which a given data record belongs.

\n

Partition keys are Unicode strings, with a maximum length limit of 256 characters for\n each key. An MD5 hash function is used to map partition keys to 128-bit integer values\n and to map associated data records to shards using the hash key ranges of the shards.\n You can override hashing the partition key to determine the shard by explicitly\n specifying a hash value using the ExplicitHashKey parameter. For more\n information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

\n PutRecord returns the shard ID of where the data record was placed and the\n sequence number that was assigned to the data record.

\n

Sequence numbers increase over time and are specific to a shard within a stream, not\n across all shards within a stream. To guarantee strictly increasing ordering, write\n serially to a shard and use the SequenceNumberForOrdering parameter. For\n more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n \n

After you write a record to a stream, you cannot modify that record or its order\n within the stream.

\n \n

If a PutRecord request cannot be processed because of insufficient\n provisioned throughput on the shard involved in the request, PutRecord\n throws ProvisionedThroughputExceededException.

\n

By default, data records are accessible for 24 hours from the time that they are added\n to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "data" + } + } } }, "com.amazonaws.kinesis#PutRecordInput": { @@ -4186,8 +6357,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream to put the data record into.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream to put the data record into.

" } }, "Data": { @@ -4215,6 +6385,15 @@ "traits": { "smithy.api#documentation": "

Guarantees strictly increasing sequence numbers, for puts from the same client and to\n the same partition key. Usage: set the SequenceNumberForOrdering of record\n n to the sequence number of record n-1 (as\n returned in the result when putting record n-1). If this parameter\n is not set, records are coarsely ordered based on arrival time.

" } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -4241,7 +6420,7 @@ "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The encryption type to use on the record. This parameter can be one of the following\n values:

\n " + "smithy.api#documentation": "

The encryption type to use on the record. This parameter can be one of the following\n values:

\n " } } }, @@ -4258,6 +6437,9 @@ "target": "com.amazonaws.kinesis#PutRecordsOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -4287,7 +6469,12 @@ } ], "traits": { - "smithy.api#documentation": "

Writes multiple data records into a Kinesis data stream in a single call (also\n referred to as a PutRecords request). Use this operation to send data into\n the stream for data ingestion and processing.

\n

Each PutRecords request can support up to 500 records. Each record in the\n request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request,\n including partition keys. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MiB per second.

\n

You must specify the name of the stream that captures, stores, and transports the\n data; and an array of request Records, with each record in the array\n requiring a partition key and data blob. The record size limit applies to the total size\n of the partition key and data blob.

\n

The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams as input to a hash function that\n maps the partition key and associated data to a specific shard. An MD5 hash function is\n used to map partition keys to 128-bit integer values and to map associated data records\n to shards. As a result of this hashing mechanism, all data records with the same\n partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

Each record in the Records array may include an optional parameter,\n ExplicitHashKey, which overrides the partition key to shard mapping.\n This parameter allows a data producer to determine explicitly the shard where the record\n is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n

The PutRecords response includes an array of response\n Records. Each record in the response array directly correlates with a\n record in the request array using natural ordering, from the top to the bottom of the\n request and response. The response Records array always includes the same\n number of records as the request array.

\n

The response Records array includes both successfully and unsuccessfully\n processed records. Kinesis Data Streams attempts to process all records in each\n PutRecords request. A single record failure does not stop the\n processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering\n of records. If you need to read records in the same order they are written to the\n stream, use PutRecord instead of PutRecords, and write to\n the same shard.

\n

A successfully processed record includes ShardId and\n SequenceNumber values. The ShardId parameter identifies\n the shard in the stream where the record is stored. The SequenceNumber\n parameter is an identifier assigned to the put record, unique to all records in the\n stream.

\n

An unsuccessfully processed record includes ErrorCode and\n ErrorMessage values. ErrorCode reflects the type of error\n and can be one of the following values:\n ProvisionedThroughputExceededException or InternalFailure.\n ErrorMessage provides more detailed information about the\n ProvisionedThroughputExceededException exception including the account\n ID, stream name, and shard ID of the record that was throttled. For more information\n about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n \n

After you write a record to a stream, you cannot modify that record or its order\n within the stream.

\n \n

By default, data records are accessible for 24 hours from the time that they are added\n to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

" + "smithy.api#documentation": "

Writes multiple data records into a Kinesis data stream in a single call (also\n referred to as a PutRecords request). Use this operation to send data into\n the stream for data ingestion and processing.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

Each PutRecords request can support up to 500 records. Each record in the\n request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request,\n including partition keys. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MiB per second.

\n

You must specify the name of the stream that captures, stores, and transports the\n data; and an array of request Records, with each record in the array\n requiring a partition key and data blob. The record size limit applies to the total size\n of the partition key and data blob.

\n

The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams as input to a hash function that\n maps the partition key and associated data to a specific shard. An MD5 hash function is\n used to map partition keys to 128-bit integer values and to map associated data records\n to shards. As a result of this hashing mechanism, all data records with the same\n partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

Each record in the Records array may include an optional parameter,\n ExplicitHashKey, which overrides the partition key to shard mapping.\n This parameter allows a data producer to determine explicitly the shard where the record\n is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n

The PutRecords response includes an array of response\n Records. Each record in the response array directly correlates with a\n record in the request array using natural ordering, from the top to the bottom of the\n request and response. The response Records array always includes the same\n number of records as the request array.

\n

The response Records array includes both successfully and unsuccessfully\n processed records. Kinesis Data Streams attempts to process all records in each\n PutRecords request. A single record failure does not stop the\n processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering\n of records. If you need to read records in the same order they are written to the\n stream, use PutRecord instead of PutRecords, and write to\n the same shard.

\n

A successfully processed record includes ShardId and\n SequenceNumber values. The ShardId parameter identifies\n the shard in the stream where the record is stored. The SequenceNumber\n parameter is an identifier assigned to the put record, unique to all records in the\n stream.

\n

An unsuccessfully processed record includes ErrorCode and\n ErrorMessage values. ErrorCode reflects the type of error\n and can be one of the following values:\n ProvisionedThroughputExceededException or InternalFailure.\n ErrorMessage provides more detailed information about the\n ProvisionedThroughputExceededException exception including the account\n ID, stream name, and shard ID of the record that was throttled. For more information\n about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n \n

After you write a record to a stream, you cannot modify that record or its order\n within the stream.

\n \n

By default, data records are accessible for 24 hours from the time that they are added\n to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "data" + } + } } }, "com.amazonaws.kinesis#PutRecordsInput": { @@ -4303,8 +6490,16 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The stream name associated with the request.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The stream name associated with the request.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } } } }, @@ -4331,7 +6526,7 @@ "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The encryption type used on the records. This parameter can be one of the following\n values:

\n " + "smithy.api#documentation": "

The encryption type used on the records. This parameter can be one of the following\n values:

\n " } } }, @@ -4456,7 +6651,7 @@ "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The encryption type used on the record. This parameter can be one of the following\n values:

\n " + "smithy.api#documentation": "

The encryption type used on the record. This parameter can be one of the following\n values:

\n " } } }, @@ -4493,7 +6688,12 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

" + "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#RegisterStreamConsumerInput": { @@ -4503,7 +6703,10 @@ "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the Kinesis data stream that you want to register the consumer with. For\n more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "StreamARN" + } } }, "ConsumerName": { @@ -4536,6 +6739,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -4550,7 +6756,12 @@ } ], "traits": { - "smithy.api#documentation": "

Removes tags from the specified Kinesis data stream. Removed tags are deleted and\n cannot be recovered after this operation successfully completes.

\n

If you specify a tag that does not exist, it is ignored.

\n

\n RemoveTagsFromStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Removes tags from the specified Kinesis data stream. Removed tags are deleted and\n cannot be recovered after this operation successfully completes.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

If you specify a tag that does not exist, it is ignored.

\n

\n RemoveTagsFromStream has a limit of five transactions per second per\n account.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#RemoveTagsFromStreamInput": { @@ -4559,8 +6770,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream.

" } }, "TagKeys": { @@ -4569,6 +6779,15 @@ "smithy.api#documentation": "

A list of tag keys. Each corresponding tag is removed from the stream.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -4609,14 +6828,14 @@ "type": "integer" }, "com.amazonaws.kinesis#ScalingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNIFORM_SCALING", - "name": "UNIFORM_SCALING" + "type": "enum", + "members": { + "UNIFORM_SCALING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNIFORM_SCALING" } - ] + } } }, "com.amazonaws.kinesis#SequenceNumber": { @@ -4702,7 +6921,7 @@ "Type": { "target": "com.amazonaws.kinesis#ShardFilterType", "traits": { - "smithy.api#documentation": "

The shard type specified in the ShardFilter parameter. This is a required\n property of the ShardFilter parameter.

\n

You can specify the following valid values:

\n ", + "smithy.api#documentation": "

The shard type specified in the ShardFilter parameter. This is a required\n property of the ShardFilter parameter.

\n

You can specify the following valid values:

\n ", "smithy.api#required": {} } }, @@ -4724,34 +6943,44 @@ } }, "com.amazonaws.kinesis#ShardFilterType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AFTER_SHARD_ID", - "name": "AFTER_SHARD_ID" - }, - { - "value": "AT_TRIM_HORIZON", - "name": "AT_TRIM_HORIZON" - }, - { - "value": "FROM_TRIM_HORIZON", - "name": "FROM_TRIM_HORIZON" - }, - { - "value": "AT_LATEST", - "name": "AT_LATEST" - }, - { - "value": "AT_TIMESTAMP", - "name": "AT_TIMESTAMP" - }, - { - "value": "FROM_TIMESTAMP", - "name": "FROM_TIMESTAMP" + "type": "enum", + "members": { + "AFTER_SHARD_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_SHARD_ID" + } + }, + "AT_TRIM_HORIZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_TRIM_HORIZON" + } + }, + "FROM_TRIM_HORIZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FROM_TRIM_HORIZON" + } + }, + "AT_LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_LATEST" + } + }, + "AT_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_TIMESTAMP" + } + }, + "FROM_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FROM_TIMESTAMP" } - ] + } } }, "com.amazonaws.kinesis#ShardId": { @@ -4780,30 +7009,38 @@ } }, "com.amazonaws.kinesis#ShardIteratorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AT_SEQUENCE_NUMBER", - "name": "AT_SEQUENCE_NUMBER" - }, - { - "value": "AFTER_SEQUENCE_NUMBER", - "name": "AFTER_SEQUENCE_NUMBER" - }, - { - "value": "TRIM_HORIZON", - "name": "TRIM_HORIZON" - }, - { - "value": "LATEST", - "name": "LATEST" - }, - { - "value": "AT_TIMESTAMP", - "name": "AT_TIMESTAMP" + "type": "enum", + "members": { + "AT_SEQUENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_SEQUENCE_NUMBER" + } + }, + "AFTER_SEQUENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_SEQUENCE_NUMBER" + } + }, + "TRIM_HORIZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIM_HORIZON" } - ] + }, + "LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST" + } + }, + "AT_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_TIMESTAMP" + } + } } }, "com.amazonaws.kinesis#ShardList": { @@ -4821,6 +7058,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -4838,7 +7078,12 @@ } ], "traits": { - "smithy.api#documentation": "

Splits a shard into two new shards in the Kinesis data stream, to increase the\n stream's capacity to ingest and transport data. SplitShard is called when\n there is a need to increase the overall capacity of a stream because of an expected\n increase in the volume of data records being ingested.

\n

You can also use SplitShard when a shard appears to be approaching its\n maximum utilization; for example, the producers sending data into the specific shard are\n suddenly sending more than previously anticipated. You can also call\n SplitShard to increase stream capacity, so that more Kinesis Data\n Streams applications can simultaneously read data from the stream for real-time\n processing.

\n

You must specify the shard to be split and the new hash key, which is the position in\n the shard where the shard gets split in two. In many cases, the new hash key might be\n the average of the beginning and ending hash key, but it can be any hash key value in\n the range being mapped into the shard. For more information, see Split a\n Shard in the Amazon Kinesis Data Streams Developer\n Guide.

\n

You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the ShardToSplit\n and NewStartingHashKey parameters that are specified in the\n SplitShard request.

\n

\n SplitShard is an asynchronous operation. Upon receiving a\n SplitShard request, Kinesis Data Streams immediately returns a response\n and sets the stream status to UPDATING. After the operation is completed,\n Kinesis Data Streams sets the stream status to ACTIVE. Read and write\n operations continue to work while the stream is in the UPDATING state.

\n

You can use DescribeStreamSummary to check the status of the stream,\n which is returned in StreamStatus. If the stream is in the\n ACTIVE state, you can call SplitShard.\n

\n

If the specified stream does not exist, DescribeStreamSummary\n returns a ResourceNotFoundException. If you try to create more shards than\n are authorized for your account, you receive a LimitExceededException.

\n

For the default shard limit for an Amazon Web Services account, see Kinesis\n Data Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a\n LimitExceededException.

\n

\n SplitShard has a limit of five transactions per second per account.

" + "smithy.api#documentation": "

Splits a shard into two new shards in the Kinesis data stream, to increase the\n stream's capacity to ingest and transport data. SplitShard is called when\n there is a need to increase the overall capacity of a stream because of an expected\n increase in the volume of data records being ingested. This API is only supported for\n the data streams with the provisioned capacity mode.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

You can also use SplitShard when a shard appears to be approaching its\n maximum utilization; for example, the producers sending data into the specific shard are\n suddenly sending more than previously anticipated. You can also call\n SplitShard to increase stream capacity, so that more Kinesis Data\n Streams applications can simultaneously read data from the stream for real-time\n processing.

\n

You must specify the shard to be split and the new hash key, which is the position in\n the shard where the shard gets split in two. In many cases, the new hash key might be\n the average of the beginning and ending hash key, but it can be any hash key value in\n the range being mapped into the shard. For more information, see Split a\n Shard in the Amazon Kinesis Data Streams Developer\n Guide.

\n

You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the ShardToSplit\n and NewStartingHashKey parameters that are specified in the\n SplitShard request.

\n

\n SplitShard is an asynchronous operation. Upon receiving a\n SplitShard request, Kinesis Data Streams immediately returns a response\n and sets the stream status to UPDATING. After the operation is completed,\n Kinesis Data Streams sets the stream status to ACTIVE. Read and write\n operations continue to work while the stream is in the UPDATING state.

\n

You can use DescribeStreamSummary to check the status of the stream,\n which is returned in StreamStatus. If the stream is in the\n ACTIVE state, you can call SplitShard.\n

\n

If the specified stream does not exist, DescribeStreamSummary\n returns a ResourceNotFoundException. If you try to create more shards than\n are authorized for your account, you receive a LimitExceededException.

\n

For the default shard limit for an Amazon Web Services account, see Kinesis\n Data Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a\n LimitExceededException.

\n

\n SplitShard has a limit of five transactions per second per account.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#SplitShardInput": { @@ -4847,8 +7092,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream for the shard split.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream for the shard split.

" } }, "ShardToSplit": { @@ -4864,6 +7108,15 @@ "smithy.api#documentation": "

A hash key value for the starting hash key of one of the child shards created by the\n split. The hash key range for a given shard constitutes a set of ordered contiguous\n positive integers. The value for NewStartingHashKey must be in the range of\n hash keys being mapped into the shard. The NewStartingHashKey hash key\n value and all higher hash key values in hash key range are distributed to one of the\n child shards. All the lower hash key values in the range are distributed to the other\n child shard.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } }, "traits": { @@ -4879,6 +7132,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -4911,7 +7167,12 @@ } ], "traits": { - "smithy.api#documentation": "

Enables or updates server-side encryption using an Amazon Web Services KMS key for a\n specified stream.

\n

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis\n Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Updating or applying encryption\n normally takes a few seconds to complete, but it can take minutes. You can continue to\n read and write data to your stream while its status is UPDATING. Once the\n status of the stream is ACTIVE, encryption begins for records written to\n the stream.

\n

API Limits: You can successfully apply a new Amazon Web Services KMS key for\n server-side encryption 25 times in a rolling 24-hour period.

\n

Note: It can take up to 5 seconds after the stream is in an ACTIVE status\n before all records written to the stream are encrypted. After you enable encryption, you\n can verify that encryption is applied by inspecting the API response from\n PutRecord or PutRecords.

" + "smithy.api#documentation": "

Enables or updates server-side encryption using an Amazon Web Services KMS key for a\n specified stream.

\n

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis\n Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Updating or applying encryption\n normally takes a few seconds to complete, but it can take minutes. You can continue to\n read and write data to your stream while its status is UPDATING. Once the\n status of the stream is ACTIVE, encryption begins for records written to\n the stream.

\n

API Limits: You can successfully apply a new Amazon Web Services KMS key for\n server-side encryption 25 times in a rolling 24-hour period.

\n

Note: It can take up to 5 seconds after the stream is in an ACTIVE status\n before all records written to the stream are encrypted. After you enable encryption, you\n can verify that encryption is applied by inspecting the API response from\n PutRecord or PutRecords.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n ", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#StartStreamEncryptionInput": { @@ -4920,8 +7181,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream for which to start encrypting records.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream for which to start encrypting records.

" } }, "EncryptionType": { @@ -4934,9 +7194,18 @@ "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { - "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified Amazon Resource Name\n (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\n use a master key owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", + "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified Amazon Resource Name\n (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\n use a master key owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } } }, @@ -4946,7 +7215,7 @@ "Type": { "target": "com.amazonaws.kinesis#ShardIteratorType", "traits": { - "smithy.api#documentation": "

You can set the starting position to one of the following values:

\n

\n AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the\n sequence number specified in the SequenceNumber field.

\n

\n AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted\n by the sequence number specified in the SequenceNumber field.

\n

\n AT_TIMESTAMP: Start streaming from the position denoted by the time stamp\n specified in the Timestamp field.

\n

\n TRIM_HORIZON: Start streaming at the last untrimmed record in the shard,\n which is the oldest data record in the shard.

\n

\n LATEST: Start streaming just after the most recent record in the shard,\n so that you always read the most recent data in the shard.

", + "smithy.api#documentation": "

You can set the starting position to one of the following values:

\n

\n AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the\n sequence number specified in the SequenceNumber field.

\n

\n AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted\n by the sequence number specified in the SequenceNumber field.

\n

\n AT_TIMESTAMP: Start streaming from the position denoted by the time stamp\n specified in the Timestamp field.

\n

\n TRIM_HORIZON: Start streaming at the last untrimmed record in the shard,\n which is the oldest data record in the shard.

\n

\n LATEST: Start streaming just after the most recent record in the shard,\n so that you always read the most recent data in the shard.

", "smithy.api#required": {} } }, @@ -4976,6 +7245,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -4990,7 +7262,12 @@ } ], "traits": { - "smithy.api#documentation": "

Disables server-side encryption for a specified stream.

\n

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis\n Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Stopping encryption normally takes a\n few seconds to complete, but it can take minutes. You can continue to read and write\n data to your stream while its status is UPDATING. Once the status of the\n stream is ACTIVE, records written to the stream are no longer encrypted by\n Kinesis Data Streams.

\n

API Limits: You can successfully disable server-side encryption 25 times in a rolling\n 24-hour period.

\n

Note: It can take up to 5 seconds after the stream is in an ACTIVE status\n before all records written to the stream are no longer subject to encryption. After you\n disabled encryption, you can verify that encryption is not applied by inspecting the API\n response from PutRecord or PutRecords.

" + "smithy.api#documentation": "

Disables server-side encryption for a specified stream.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis\n Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Stopping encryption normally takes a\n few seconds to complete, but it can take minutes. You can continue to read and write\n data to your stream while its status is UPDATING. Once the status of the\n stream is ACTIVE, records written to the stream are no longer encrypted by\n Kinesis Data Streams.

\n

API Limits: You can successfully disable server-side encryption 25 times in a rolling\n 24-hour period.

\n

Note: It can take up to 5 seconds after the stream is in an ACTIVE status\n before all records written to the stream are no longer subject to encryption. After you\n disabled encryption, you can verify that encryption is not applied by inspecting the API\n response from PutRecord or PutRecords.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#StopStreamEncryptionInput": { @@ -4999,8 +7276,7 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream on which to stop encrypting records.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream on which to stop encrypting records.

" } }, "EncryptionType": { @@ -5013,9 +7289,18 @@ "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { - "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified Amazon Resource Name\n (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\n use a master key owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", + "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified Amazon Resource Name\n (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\n use a master key owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } } }, @@ -5026,7 +7311,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^arn:aws.*:kinesis:.*:\\d{12}:stream/.+$" + "smithy.api#pattern": "^arn:aws.*:kinesis:.*:\\d{12}:stream/\\S+$" } }, "com.amazonaws.kinesis#StreamDescription": { @@ -5049,7 +7334,7 @@ "StreamStatus": { "target": "com.amazonaws.kinesis#StreamStatus", "traits": { - "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the\n following states:

\n ", + "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the\n following states:

\n ", "smithy.api#required": {} } }, @@ -5097,13 +7382,13 @@ "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The server-side encryption type used on the stream. This parameter can be one of the\n following values:

\n " + "smithy.api#documentation": "

The server-side encryption type used on the stream. This parameter can be one of the\n following values:

\n " } }, "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { - "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified ARN to either an alias\n or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by\n Kinesis Data Streams by specifying the alias aws/kinesis.

\n " + "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified ARN to either an alias\n or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by\n Kinesis Data Streams by specifying the alias aws/kinesis.

\n " } } }, @@ -5131,7 +7416,7 @@ "StreamStatus": { "target": "com.amazonaws.kinesis#StreamStatus", "traits": { - "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the\n following states:

\n ", + "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the\n following states:

\n ", "smithy.api#required": {} } }, @@ -5165,13 +7450,13 @@ "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { - "smithy.api#documentation": "

The encryption type used. This value is one of the following:

\n " + "smithy.api#documentation": "

The encryption type used. This value is one of the following:

\n " } }, "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { - "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified ARN to either an alias\n or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by\n Kinesis Data Streams by specifying the alias aws/kinesis.

\n " + "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified ARN to either an alias\n or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by\n Kinesis Data Streams by specifying the alias aws/kinesis.

\n " } }, "OpenShardCount": { @@ -5193,18 +7478,20 @@ } }, "com.amazonaws.kinesis#StreamMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROVISIONED", - "name": "PROVISIONED" - }, - { - "value": "ON_DEMAND", - "name": "ON_DEMAND" + "type": "enum", + "members": { + "PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONED" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" } - ] + } } }, "com.amazonaws.kinesis#StreamModeDetails": { @@ -5239,26 +7526,76 @@ } }, "com.amazonaws.kinesis#StreamStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "UPDATING", - "name": "UPDATING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.kinesis#StreamSummary": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesis#StreamName", + "traits": { + "smithy.api#documentation": "

The name of a stream.

", + "smithy.api#required": {} + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.api#required": {} + } + }, + "StreamStatus": { + "target": "com.amazonaws.kinesis#StreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the stream.

", + "smithy.api#required": {} + } + }, + "StreamModeDetails": { + "target": "com.amazonaws.kinesis#StreamModeDetails" + }, + "StreamCreationTimestamp": { + "target": "com.amazonaws.kinesis#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the stream was created.

" } - ] + } + }, + "traits": { + "smithy.api#documentation": "

The summary of a stream.

" + } + }, + "com.amazonaws.kinesis#StreamSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.kinesis#StreamSummary" } }, "com.amazonaws.kinesis#SubscribeToShard": { @@ -5270,6 +7607,9 @@ "target": "com.amazonaws.kinesis#SubscribeToShardOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -5284,7 +7624,12 @@ } ], "traits": { - "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

" + "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "data" + } + } } }, "com.amazonaws.kinesis#SubscribeToShardEvent": { @@ -5374,7 +7719,10 @@ "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { "smithy.api#documentation": "

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ConsumerARN" + } } }, "ShardId": { @@ -5495,6 +7843,9 @@ "target": "com.amazonaws.kinesis#UpdateShardCountOutput" }, "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -5512,7 +7863,12 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the shard count of the specified stream to the specified number of\n shards.

\n

Updating the shard count is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Depending on the size of the stream,\n the scaling action could take a few minutes to complete. You can continue to read and\n write data to your stream while its status is UPDATING.

\n

To update the shard count, Kinesis Data Streams performs splits or merges on\n individual shards. This can cause short-lived shards to be created, in addition to the\n final shards. These short-lived shards count towards your total shard limit for your\n account in the Region.

\n

When using this operation, we recommend that you specify a target shard count that is\n a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your\n shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling\n action might take longer to complete.

\n

This operation has the following default limits. By default, you cannot do the\n following:

\n \n

For the default limits for an Amazon Web Services account, see Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To request an increase in the call rate limit, the shard limit for\n this API, or your overall shard limit, use the limits form.

" + "smithy.api#documentation": "

Updates the shard count of the specified stream to the specified number of shards.\n This API is only supported for the data streams with the provisioned capacity\n mode.

\n \n

When invoking this API, it is recommended you use the StreamARN input\n parameter rather than the StreamName input parameter.

\n \n

Updating the shard count is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Depending on the size of the stream,\n the scaling action could take a few minutes to complete. You can continue to read and\n write data to your stream while its status is UPDATING.

\n

To update the shard count, Kinesis Data Streams performs splits or merges on\n individual shards. This can cause short-lived shards to be created, in addition to the\n final shards. These short-lived shards count towards your total shard limit for your\n account in the Region.

\n

When using this operation, we recommend that you specify a target shard count that is\n a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your\n shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling\n action might take longer to complete.

\n

This operation has the following default limits. By default, you cannot do the\n following:

\n \n

For the default limits for an Amazon Web Services account, see Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To request an increase in the call rate limit, the shard limit for\n this API, or your overall shard limit, use the limits form.

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#UpdateShardCountInput": { @@ -5521,14 +7877,13 @@ "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the stream.

" } }, "TargetShardCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "

The new number of shards. This value has the following default limits. By default, you\n cannot do the following:

\n ", + "smithy.api#documentation": "

The new number of shards. This value has the following default limits. By default, you\n cannot do the following:

\n ", "smithy.api#required": {} } }, @@ -5538,6 +7893,15 @@ "smithy.api#documentation": "

The scaling type. Uniform scaling creates shards of equal size.

", "smithy.api#required": {} } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

", + "smithy.rules#contextParam": { + "name": "StreamARN" + } + } } } }, @@ -5561,6 +7925,12 @@ "traits": { "smithy.api#documentation": "

The updated number of shards.

" } + }, + "StreamARN": { + "target": "com.amazonaws.kinesis#StreamARN", + "traits": { + "smithy.api#documentation": "

The ARN of the stream.

" + } } } }, @@ -5587,7 +7957,12 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you\n can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data stream.\n

" + "smithy.api#documentation": "

Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you\n can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data stream.\n

", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } } }, "com.amazonaws.kinesis#UpdateStreamModeInput": { @@ -5597,7 +7972,10 @@ "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

Specifies the ARN of the data stream whose capacity mode you want to update.

", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "StreamARN" + } } }, "StreamModeDetails": { @@ -5617,7 +7995,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n \n

", + "smithy.api#documentation": "

Specifies that you tried to invoke this API for a data stream with the on-demand\n capacity mode. This API is only supported for data streams with the provisioned capacity\n mode.

", "smithy.api#error": "client" } } diff --git a/codegen/sdk-codegen/aws-models/kms.2014-11-01.json b/codegen/sdk-codegen/aws-models/kms.2014-11-01.json index d390e1b4948..efab5d47f8c 100644 --- a/codegen/sdk-codegen/aws-models/kms.2014-11-01.json +++ b/codegen/sdk-codegen/aws-models/kms.2014-11-01.json @@ -627,7 +627,7 @@ "TrustAnchorCertificate": { "target": "com.amazonaws.kms#TrustAnchorCertificateType", "traits": { - "smithy.api#documentation": "

* CreateCustom

\n

Specifies the certificate for an CloudHSM key store. This parameter is required for custom\n key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

\n

Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the\n content of the customerCA.crt file that you created when you initialized the\n cluster.

" + "smithy.api#documentation": "

Specifies the certificate for an CloudHSM key store. This parameter is required for custom\n key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

\n

Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the\n content of the customerCA.crt file that you created when you initialized the\n cluster.

" } }, "KeyStorePassword": { @@ -1610,7 +1610,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides detailed information about a KMS key. You can run DescribeKey on a\n customer managed\n key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish different types of\n KMS keys. It also displays the key usage (encryption, signing, or generating and verifying\n MACs) and the algorithms that the KMS key supports. For multi-Region keys, it displays\n the primary key and all related replica keys. For KMS keys in CloudHSM key stores, it includes information\n about the custom key store, such as the key store ID and the CloudHSM cluster ID. For KMS key in\n external key stores, it includes\n the custom key store ID and the ID and status of the associated external key.

\n

\n DescribeKey does not return the following information:

\n \n

In general, DescribeKey is a non-mutating operation. It returns data about\n KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to\n create Amazon Web Services\n managed keys from a predefined Amazon Web Services alias with no key\n ID.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Provides detailed information about a KMS key. You can run DescribeKey on a\n customer managed\n key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish different types of\n KMS keys. It also displays the key usage (encryption, signing, or generating and verifying\n MACs) and the algorithms that the KMS key supports.

\n

For multi-Region keys,\n DescribeKey displays the primary key and all related replica keys. For KMS keys\n in CloudHSM key stores, it includes\n information about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS\n keys in external key stores, it\n includes the custom key store ID and the ID of the external key.

\n

\n DescribeKey does not return the following information:

\n \n

In general, DescribeKey is a non-mutating operation. It returns data about\n KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to\n create Amazon Web Services\n managed keys from a predefined Amazon Web Services alias with no key\n ID.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DescribeKeyRequest": { @@ -5697,15 +5697,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -5968,8 +5959,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-2" } }, @@ -5981,8 +5972,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-2" } }, @@ -5994,8 +5985,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-2" } }, @@ -6007,8 +5998,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-2" } }, @@ -6020,8 +6011,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -6033,8 +6024,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -6046,8 +6037,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -6059,8 +6050,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -6072,8 +6063,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-south-1" } }, @@ -6085,8 +6076,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-south-1" } }, @@ -6098,8 +6089,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-south-1" } }, @@ -6111,8 +6102,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-1" } }, @@ -6124,8 +6115,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-south-2" } }, @@ -6137,8 +6128,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-south-2" } }, @@ -6150,8 +6141,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-south-2" } }, @@ -6163,8 +6154,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-south-2" } }, @@ -6176,8 +6167,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-east-1" } }, @@ -6189,8 +6180,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-east-1" } }, @@ -6202,8 +6193,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-east-1" } }, @@ -6215,8 +6206,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-east-1" } }, @@ -6228,8 +6219,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "me-central-1" } }, @@ -6241,8 +6232,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "me-central-1" } }, @@ -6254,8 +6245,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "me-central-1" } }, @@ -6267,8 +6258,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "me-central-1" } }, @@ -6280,8 +6271,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -6293,8 +6284,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -6306,8 +6297,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -6319,8 +6310,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -6332,8 +6323,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -6345,8 +6336,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -6358,8 +6349,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -6371,8 +6362,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -6382,8 +6373,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-west-1" } }, @@ -6395,8 +6386,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-west-1" } }, @@ -6406,8 +6397,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-west-1" } }, @@ -6419,8 +6410,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-west-1" } }, @@ -6432,8 +6423,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-2" } }, @@ -6445,8 +6436,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-2" } }, @@ -6458,8 +6449,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-2" } }, @@ -6471,8 +6462,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-2" } }, @@ -6484,8 +6475,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-1" } }, @@ -6497,8 +6488,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -6510,8 +6501,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-1" } }, @@ -6523,8 +6514,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -6536,8 +6527,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -6549,8 +6540,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -6562,8 +6553,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -6575,8 +6566,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -6588,8 +6579,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "af-south-1" } }, @@ -6601,8 +6592,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -6614,8 +6605,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "af-south-1" } }, @@ -6627,8 +6618,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "af-south-1" } }, @@ -6640,8 +6631,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-north-1" } }, @@ -6653,8 +6644,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-north-1" } }, @@ -6666,8 +6657,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-north-1" } }, @@ -6679,8 +6670,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-north-1" } }, @@ -6692,8 +6683,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-3" } }, @@ -6705,8 +6696,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-3" } }, @@ -6718,8 +6709,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-3" } }, @@ -6731,8 +6722,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-3" } }, @@ -6744,8 +6735,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -6757,8 +6748,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -6770,8 +6761,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -6783,8 +6774,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -6796,8 +6787,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-1" } }, @@ -6809,8 +6800,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -6822,8 +6813,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-1" } }, @@ -6835,8 +6826,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -6848,8 +6839,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-3" } }, @@ -6861,8 +6852,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-3" } }, @@ -6874,8 +6865,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-3" } }, @@ -6887,8 +6878,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-3" } }, @@ -6900,8 +6891,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -6913,8 +6904,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -6926,8 +6917,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -6939,8 +6930,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -6952,8 +6943,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -6965,8 +6956,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -6978,8 +6969,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -6991,8 +6982,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -7004,8 +6995,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "me-south-1" } }, @@ -7017,8 +7008,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "me-south-1" } }, @@ -7030,8 +7021,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "me-south-1" } }, @@ -7043,8 +7034,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "me-south-1" } }, @@ -7056,8 +7047,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "sa-east-1" } }, @@ -7069,8 +7060,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "sa-east-1" } }, @@ -7082,8 +7073,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "sa-east-1" } }, @@ -7095,8 +7086,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "sa-east-1" } }, @@ -7108,8 +7099,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-east-1" } }, @@ -7121,8 +7112,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-east-1" } }, @@ -7134,8 +7125,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-east-1" } }, @@ -7147,8 +7138,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-east-1" } }, @@ -7160,8 +7151,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "cn-north-1" } }, @@ -7173,8 +7164,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "cn-north-1" } }, @@ -7186,8 +7177,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "cn-north-1" } }, @@ -7199,8 +7190,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "cn-north-1" } }, @@ -7212,8 +7203,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -7225,8 +7216,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -7238,8 +7229,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -7251,8 +7242,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -7264,8 +7255,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -7277,8 +7268,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -7290,8 +7281,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -7303,8 +7294,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -7316,8 +7307,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -7329,8 +7320,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -7342,8 +7333,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -7355,8 +7346,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -7366,8 +7357,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-iso-east-1" } }, @@ -7379,8 +7370,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-iso-east-1" } }, @@ -7390,8 +7381,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-iso-east-1" } }, @@ -7403,8 +7394,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-iso-east-1" } }, @@ -7416,8 +7407,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-3" } }, @@ -7429,8 +7420,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-3" } }, @@ -7442,8 +7433,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-3" } }, @@ -7455,8 +7446,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-3" } }, @@ -7468,8 +7459,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-4" } }, @@ -7481,8 +7472,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-4" } }, @@ -7494,8 +7485,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-4" } }, @@ -7507,8 +7498,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-4" } }, @@ -7520,8 +7511,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -7533,8 +7524,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -7546,8 +7537,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -7559,8 +7550,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -7572,8 +7563,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-2" } }, @@ -7585,8 +7576,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -7598,8 +7589,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-2" } }, @@ -7611,8 +7602,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -7624,8 +7615,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "cn-northwest-1" } }, @@ -7637,8 +7628,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "cn-northwest-1" } }, @@ -7650,8 +7641,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "cn-northwest-1" } }, @@ -7663,8 +7654,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "cn-northwest-1" } }, @@ -7674,8 +7665,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-isob-east-1" } }, @@ -7687,8 +7678,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-isob-east-1" } }, @@ -7698,8 +7689,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-isob-east-1" } }, @@ -7711,8 +7702,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-isob-east-1" } }, @@ -7724,8 +7715,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -7736,8 +7727,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -7748,8 +7739,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -8359,7 +8350,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the external key that is associated with a KMS key in an\n external key store.

\n

These fields appear in a CreateKey or DescribeKey\n response only for a KMS key in an external key store.

\n

The external key is a symmetric encryption key that is hosted by\n an external key manager outside of Amazon Web Services. When you use the KMS key in an external key store\n in a cryptographic operation, the cryptographic operation is performed in the\n external key manager using the specified external key. For more information, see External key in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Information about the external key that is associated with a KMS key in an\n external key store.

\n

This element appears in a CreateKey or DescribeKey\n response only for a KMS key in an external key store.

\n

The external key is a symmetric encryption key that is hosted by\n an external key manager outside of Amazon Web Services. When you use the KMS key in an external key store\n in a cryptographic operation, the cryptographic operation is performed in the\n external key manager using the specified external key. For more information, see External key in the Key Management Service Developer Guide.

" } }, "com.amazonaws.kms#XksKeyIdType": { diff --git a/codegen/sdk-codegen/aws-models/license-manager-user-subscriptions.2018-05-10.json b/codegen/sdk-codegen/aws-models/license-manager-user-subscriptions.2018-05-10.json index 453ca482ffe..73d2109619a 100644 --- a/codegen/sdk-codegen/aws-models/license-manager-user-subscriptions.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/license-manager-user-subscriptions.2018-05-10.json @@ -2900,4 +2900,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/location.2020-11-19.json b/codegen/sdk-codegen/aws-models/location.2020-11-19.json index ed6a7031ed8..843475d43a1 100644 --- a/codegen/sdk-codegen/aws-models/location.2020-11-19.json +++ b/codegen/sdk-codegen/aws-models/location.2020-11-19.json @@ -3447,7 +3447,7 @@ "FontStack": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid fonts stacks for Esri styles:

\n \n

Valid font stacks for HERE Technologies styles:

\n ", + "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid fonts stacks for Esri styles:

\n \n

Valid font stacks for HERE Technologies styles:

\n \n

Valid font stacks for Open Data (Preview) styles:

\n \n \n

The fonts used by VectorOpenDataStandardLight are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5464,9 +5464,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true + "Region": "eu-central-1" } }, { @@ -5477,9 +5477,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false + "Region": "eu-central-1" } }, { @@ -5490,9 +5490,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true + "Region": "eu-central-1" } }, { @@ -5503,9 +5503,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "Region": "eu-central-1" } }, { @@ -5516,9 +5516,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true + "Region": "us-west-2" } }, { @@ -5529,9 +5529,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false + "Region": "us-west-2" } }, { @@ -5542,9 +5542,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true + "Region": "us-west-2" } }, { @@ -5555,9 +5555,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "Region": "us-west-2" } }, { @@ -5568,9 +5568,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": true + "Region": "eu-north-1" } }, { @@ -5581,9 +5581,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": false + "Region": "eu-north-1" } }, { @@ -5594,9 +5594,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": true + "Region": "eu-north-1" } }, { @@ -5607,9 +5607,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": false + "Region": "eu-north-1" } }, { @@ -5620,9 +5620,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": true + "Region": "eu-west-1" } }, { @@ -5633,9 +5633,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": false + "Region": "eu-west-1" } }, { @@ -5646,9 +5646,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": true + "Region": "eu-west-1" } }, { @@ -5659,9 +5659,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": false + "Region": "eu-west-1" } }, { @@ -5672,9 +5672,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true + "Region": "ap-northeast-1" } }, { @@ -5685,9 +5685,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false + "Region": "ap-northeast-1" } }, { @@ -5698,9 +5698,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true + "Region": "ap-northeast-1" } }, { @@ -5711,9 +5711,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false + "Region": "ap-northeast-1" } }, { @@ -5724,9 +5724,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true + "Region": "ap-southeast-1" } }, { @@ -5737,9 +5737,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false + "Region": "ap-southeast-1" } }, { @@ -5750,9 +5750,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true + "Region": "ap-southeast-1" } }, { @@ -5763,9 +5763,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "Region": "ap-southeast-1" } }, { @@ -5776,9 +5776,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true + "Region": "ap-southeast-2" } }, { @@ -5789,9 +5789,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false + "Region": "ap-southeast-2" } }, { @@ -5802,9 +5802,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true + "Region": "ap-southeast-2" } }, { @@ -5815,9 +5815,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "Region": "ap-southeast-2" } }, { @@ -5828,9 +5828,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -5841,9 +5841,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -5854,9 +5854,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -5867,9 +5867,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -5880,9 +5880,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": true + "Region": "us-east-2" } }, { @@ -5893,9 +5893,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": false + "Region": "us-east-2" } }, { @@ -5906,9 +5906,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": true + "Region": "us-east-2" } }, { @@ -5919,9 +5919,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": false + "Region": "us-east-2" } }, { @@ -5932,9 +5932,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -5944,9 +5944,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", - "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -5956,9 +5956,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -5973,7 +5973,7 @@ "Style": { "target": "com.amazonaws.location#MapStyle", "traits": { - "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n \n

Valid HERE\n Technologies map styles:

\n ", + "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n \n

Valid HERE\n Technologies map styles:

\n \n

Valid Open Data (Preview) map styles:

\n ", "smithy.api#required": {} } } @@ -8176,4 +8176,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/lookoutequipment.2020-12-15.json b/codegen/sdk-codegen/aws-models/lookoutequipment.2020-12-15.json index 2b6c053ee33..4e15b10cf5a 100644 --- a/codegen/sdk-codegen/aws-models/lookoutequipment.2020-12-15.json +++ b/codegen/sdk-codegen/aws-models/lookoutequipment.2020-12-15.json @@ -152,7 +152,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -201,15 +201,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -472,9 +463,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -485,9 +476,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -498,9 +489,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -511,9 +502,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -524,9 +515,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -537,9 +528,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -550,9 +541,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -563,9 +554,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -576,9 +567,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -589,9 +580,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -602,9 +593,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -615,9 +606,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -628,9 +619,9 @@ } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -640,9 +631,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -652,9 +643,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -1468,30 +1459,38 @@ } }, "com.amazonaws.lookoutequipment#DataUploadFrequency": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PT5M", - "name": "PT5M" - }, - { - "value": "PT10M", - "name": "PT10M" - }, - { - "value": "PT15M", - "name": "PT15M" - }, - { - "value": "PT30M", - "name": "PT30M" - }, - { - "value": "PT1H", - "name": "PT1H" + "type": "enum", + "members": { + "PT5M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5M" } - ] + }, + "PT10M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10M" + } + }, + "PT15M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15M" + } + }, + "PT30M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30M" + } + }, + "PT1H": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1H" + } + } } }, "com.amazonaws.lookoutequipment#DatasetArn": { @@ -1539,22 +1538,26 @@ } }, "com.amazonaws.lookoutequipment#DatasetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "INGESTION_IN_PROGRESS", - "name": "INGESTION_IN_PROGRESS" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "INGESTION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION_IN_PROGRESS" } - ] + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } } }, "com.amazonaws.lookoutequipment#DatasetSummaries": { @@ -1618,6 +1621,9 @@ }, { "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } ], "traits": { @@ -1703,6 +1709,9 @@ }, { "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } ], "traits": { @@ -1732,6 +1741,9 @@ }, { "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } ], "traits": { @@ -1792,6 +1804,9 @@ }, { "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } ], "traits": { @@ -2684,22 +2699,26 @@ } }, "com.amazonaws.lookoutequipment#InferenceExecutionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lookoutequipment#InferenceExecutionSummaries": { @@ -2928,26 +2947,32 @@ } }, "com.amazonaws.lookoutequipment#InferenceSchedulerStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } } }, "com.amazonaws.lookoutequipment#InferenceSchedulerSummaries": { @@ -3066,22 +3091,26 @@ } }, "com.amazonaws.lookoutequipment#IngestionJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.lookoutequipment#IngestionS3InputConfiguration": { @@ -3262,22 +3291,26 @@ } }, "com.amazonaws.lookoutequipment#LabelRating": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ANOMALY", - "name": "ANOMALY" - }, - { - "value": "NO_ANOMALY", - "name": "NO_ANOMALY" - }, - { - "value": "NEUTRAL", - "name": "NEUTRAL" + "type": "enum", + "members": { + "ANOMALY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALY" } - ] + }, + "NO_ANOMALY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ANOMALY" + } + }, + "NEUTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUTRAL" + } + } } }, "com.amazonaws.lookoutequipment#LabelSummaries": { @@ -3417,18 +3450,20 @@ } }, "com.amazonaws.lookoutequipment#LatestInferenceResult": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ANOMALOUS", - "name": "ANOMALOUS" - }, - { - "value": "NORMAL", - "name": "NORMAL" + "type": "enum", + "members": { + "ANOMALOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALOUS" + } + }, + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" } - ] + } } }, "com.amazonaws.lookoutequipment#ListDataIngestionJobs": { @@ -3818,6 +3853,12 @@ "traits": { "smithy.api#documentation": "

The name of the ML model used by the inference scheduler to be listed.

" } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", + "traits": { + "smithy.api#documentation": "

Specifies the current status of the inference schedulers to list.

" + } } } }, @@ -4308,22 +4349,26 @@ } }, "com.amazonaws.lookoutequipment#ModelStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" } - ] + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lookoutequipment#ModelSummaries": { @@ -4398,22 +4443,26 @@ } }, "com.amazonaws.lookoutequipment#Monotonicity": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DECREASING", - "name": "DECREASING" - }, - { - "value": "INCREASING", - "name": "INCREASING" - }, - { - "value": "STATIC", - "name": "STATIC" + "type": "enum", + "members": { + "DECREASING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECREASING" + } + }, + "INCREASING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREASING" } - ] + }, + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" + } + } } }, "com.amazonaws.lookoutequipment#MultipleOperatingModes": { @@ -4828,18 +4877,20 @@ } }, "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "POTENTIAL_ISSUE_DETECTED", - "name": "POTENTIAL_ISSUE_DETECTED" - }, - { - "value": "NO_ISSUE_DETECTED", - "name": "NO_ISSUE_DETECTED" + "type": "enum", + "members": { + "POTENTIAL_ISSUE_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POTENTIAL_ISSUE_DETECTED" + } + }, + "NO_ISSUE_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ISSUE_DETECTED" } - ] + } } }, "com.amazonaws.lookoutequipment#StopInferenceScheduler": { @@ -5063,54 +5114,74 @@ } }, "com.amazonaws.lookoutequipment#TargetSamplingRate": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PT1S", - "name": "PT1S" - }, - { - "value": "PT5S", - "name": "PT5S" - }, - { - "value": "PT10S", - "name": "PT10S" - }, - { - "value": "PT15S", - "name": "PT15S" - }, - { - "value": "PT30S", - "name": "PT30S" - }, - { - "value": "PT1M", - "name": "PT1M" - }, - { - "value": "PT5M", - "name": "PT5M" - }, - { - "value": "PT10M", - "name": "PT10M" - }, - { - "value": "PT15M", - "name": "PT15M" - }, - { - "value": "PT30M", - "name": "PT30M" - }, - { - "value": "PT1H", - "name": "PT1H" + "type": "enum", + "members": { + "PT1S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1S" + } + }, + "PT5S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5S" + } + }, + "PT10S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10S" } - ] + }, + "PT15S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15S" + } + }, + "PT30S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30S" + } + }, + "PT1M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1M" + } + }, + "PT5M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5M" + } + }, + "PT10M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10M" + } + }, + "PT15M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15M" + } + }, + "PT30M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30M" + } + }, + "PT1H": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1H" + } + } } }, "com.amazonaws.lookoutequipment#ThrottlingException": { diff --git a/codegen/sdk-codegen/aws-models/lookoutvision.2020-11-20.json b/codegen/sdk-codegen/aws-models/lookoutvision.2020-11-20.json index 3ecaa793865..15ca7689e53 100644 --- a/codegen/sdk-codegen/aws-models/lookoutvision.2020-11-20.json +++ b/codegen/sdk-codegen/aws-models/lookoutvision.2020-11-20.json @@ -639,50 +639,68 @@ } }, "com.amazonaws.lookoutvision#DatasetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CREATE_COMPLETE", - "name": "CREATE_COMPLETE" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "UPDATE_COMPLETE", - "name": "UPDATE_COMPLETE" - }, - { - "value": "UPDATE_FAILED_ROLLBACK_IN_PROGRESS", - "name": "UPDATE_FAILED_ROLLBACK_IN_PROGRESS" - }, - { - "value": "UPDATE_FAILED_ROLLBACK_COMPLETE", - "name": "UPDATE_FAILED_ROLLBACK_COMPLETE" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETE_COMPLETE", - "name": "DELETE_COMPLETE" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_COMPLETE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_COMPLETE" + } + }, + "UPDATE_FAILED_ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED_ROLLBACK_IN_PROGRESS" + } + }, + "UPDATE_FAILED_ROLLBACK_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED_ROLLBACK_COMPLETE" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" } - ] + }, + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_COMPLETE" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } } }, "com.amazonaws.lookoutvision#DatasetStatusMessage": { @@ -2023,7 +2041,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -2072,15 +2090,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -2343,9 +2352,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -2356,9 +2365,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -2369,9 +2378,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -2382,9 +2391,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -2395,9 +2404,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -2408,9 +2417,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -2421,9 +2430,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -2434,9 +2443,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -2447,9 +2456,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -2460,9 +2469,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -2473,9 +2482,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -2486,9 +2495,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -2499,9 +2508,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -2512,9 +2521,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -2525,9 +2534,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -2538,9 +2547,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -2551,9 +2560,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -2564,9 +2573,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -2577,9 +2586,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -2590,9 +2599,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -2603,9 +2612,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -2616,9 +2625,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -2629,9 +2638,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -2642,9 +2651,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -2655,9 +2664,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -2668,9 +2677,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -2681,9 +2690,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -2694,9 +2703,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -2707,9 +2716,9 @@ } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -2719,9 +2728,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -2731,9 +2740,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -2848,30 +2857,38 @@ } }, "com.amazonaws.lookoutvision#ModelHostingStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING_HOSTING", - "name": "STARTING_HOSTING" - }, - { - "value": "HOSTED", - "name": "HOSTED" - }, - { - "value": "HOSTING_FAILED", - "name": "HOSTING_FAILED" - }, - { - "value": "STOPPING_HOSTING", - "name": "STOPPING_HOSTING" - }, - { - "value": "SYSTEM_UPDATING", - "name": "SYSTEM_UPDATING" + "type": "enum", + "members": { + "STARTING_HOSTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING_HOSTING" + } + }, + "HOSTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOSTED" + } + }, + "HOSTING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOSTING_FAILED" + } + }, + "STOPPING_HOSTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING_HOSTING" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_UPDATING" } - ] + } } }, "com.amazonaws.lookoutvision#ModelMetadata": { @@ -3102,26 +3119,32 @@ } }, "com.amazonaws.lookoutvision#ModelPackagingJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lookoutvision#ModelPackagingJobsList": { @@ -3184,46 +3207,62 @@ } }, "com.amazonaws.lookoutvision#ModelStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRAINING", - "name": "TRAINING" - }, - { - "value": "TRAINED", - "name": "TRAINED" - }, - { - "value": "TRAINING_FAILED", - "name": "TRAINING_FAILED" - }, - { - "value": "STARTING_HOSTING", - "name": "STARTING_HOSTING" - }, - { - "value": "HOSTED", - "name": "HOSTED" - }, - { - "value": "HOSTING_FAILED", - "name": "HOSTING_FAILED" - }, - { - "value": "STOPPING_HOSTING", - "name": "STOPPING_HOSTING" - }, - { - "value": "SYSTEM_UPDATING", - "name": "SYSTEM_UPDATING" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" } - ] + }, + "TRAINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINED" + } + }, + "TRAINING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING_FAILED" + } + }, + "STARTING_HOSTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING_HOSTING" + } + }, + "HOSTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOSTED" + } + }, + "HOSTING_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOSTING_FAILED" + } + }, + "STOPPING_HOSTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING_HOSTING" + } + }, + "SYSTEM_UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } } }, "com.amazonaws.lookoutvision#ModelStatusMessage": { @@ -3443,30 +3482,38 @@ } }, "com.amazonaws.lookoutvision#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROJECT", - "name": "PROJECT" - }, - { - "value": "DATASET", - "name": "DATASET" - }, - { - "value": "MODEL", - "name": "MODEL" - }, - { - "value": "TRIAL", - "name": "TRIAL" - }, - { - "value": "MODEL_PACKAGE_JOB", - "name": "MODEL_PACKAGE_JOB" + "type": "enum", + "members": { + "PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT" } - ] + }, + "DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET" + } + }, + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL" + } + }, + "TRIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIAL" + } + }, + "MODEL_PACKAGE_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_PACKAGE_JOB" + } + } } }, "com.amazonaws.lookoutvision#RetryAfterSeconds": { @@ -3650,7 +3697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for\n a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.\n

\n \n

Use the DescribeModelPackagingJob API to determine the current status of the job.\n \n The model packaging job is complete if the value of Status is SUCCEEDED.

\n

To deploy the component\n to the target device, use the component name and component version\n with the AWS IoT Greengrass CreateDeployment API.

\n\n

This operation requires the following permissions:

\n \n \n \n

For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

", + "smithy.api#documentation": "

Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for\n a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.\n

\n \n

Use the DescribeModelPackagingJob API to determine the current status of the job.\n \n The model packaging job is complete if the value of Status is SUCCEEDED.

\n

To deploy the component\n to the target device, use the component name and component version\n with the AWS IoT Greengrass CreateDeployment API.

\n\n

This operation requires the following permissions:

\n \n \n \n

For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-11-20/projects/{ProjectName}/modelpackagingjobs", @@ -3993,14 +4040,14 @@ } }, "com.amazonaws.lookoutvision#TargetDevice": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "jetson_xavier", - "name": "JETSON_XAVIER" + "type": "enum", + "members": { + "JETSON_XAVIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jetson_xavier" } - ] + } } }, "com.amazonaws.lookoutvision#TargetPlatform": { @@ -4032,40 +4079,42 @@ } }, "com.amazonaws.lookoutvision#TargetPlatformAccelerator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NVIDIA", - "name": "NVIDIA" + "type": "enum", + "members": { + "NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NVIDIA" } - ] + } } }, "com.amazonaws.lookoutvision#TargetPlatformArch": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARM64", - "name": "ARM64" - }, - { - "value": "X86_64", - "name": "X86_64" + "type": "enum", + "members": { + "ARM64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARM64" + } + }, + "X86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X86_64" } - ] + } } }, "com.amazonaws.lookoutvision#TargetPlatformOs": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LINUX", - "name": "LINUX" + "type": "enum", + "members": { + "LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX" } - ] + } } }, "com.amazonaws.lookoutvision#ThrottlingException": { diff --git a/codegen/sdk-codegen/aws-models/m2.2021-04-28.json b/codegen/sdk-codegen/aws-models/m2.2021-04-28.json index 462b0530f55..0dbb9987c88 100644 --- a/codegen/sdk-codegen/aws-models/m2.2021-04-28.json +++ b/codegen/sdk-codegen/aws-models/m2.2021-04-28.json @@ -206,6 +206,10 @@ { "value": "Deleting", "name": "DELETING" + }, + { + "value": "Deleting From Environment", + "name": "DELETING_FROM_ENVIRONMENT" } ] } @@ -277,7 +281,7 @@ "lastStartTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the application was last started. Null until the application has\n started running for the first time.

" + "smithy.api#documentation": "

The timestamp when you last started the application. Null until the application runs for the first time.

" } }, "versionStatus": { @@ -289,7 +293,7 @@ "deploymentStatus": { "target": "com.amazonaws.m2#ApplicationDeploymentLifecycle", "traits": { - "smithy.api#documentation": "

Indicates whether there is an ongoing deployment or if the application has ever deployed\n successfully.

" + "smithy.api#documentation": "

Indicates either an ongoing deployment or if the application has ever deployed\n successfully.

" } } }, @@ -448,7 +452,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -497,15 +501,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -760,6 +755,58 @@ }, "smithy.rules#endpointTests": { "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-south-1" + } + }, { "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", "expect": { @@ -768,9 +815,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -781,9 +828,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -794,9 +841,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -807,9 +854,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -820,9 +867,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -833,9 +880,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -846,9 +893,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -859,9 +906,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -872,9 +919,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -885,9 +932,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -898,9 +945,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -911,9 +958,113 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -924,9 +1075,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -937,9 +1088,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -950,9 +1101,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -963,9 +1114,61 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -976,9 +1179,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "sa-east-1" } }, { @@ -989,9 +1192,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "sa-east-1" } }, { @@ -1002,9 +1205,9 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "sa-east-1" } }, { @@ -1015,9 +1218,61 @@ } }, "params": { - "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://m2.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://m2.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -1028,9 +1283,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -1041,9 +1296,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -1054,9 +1309,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -1067,9 +1322,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -1080,9 +1335,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -1093,9 +1348,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -1106,9 +1361,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -1119,9 +1374,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -1132,9 +1387,9 @@ } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1144,9 +1399,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1156,9 +1411,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -1525,7 +1780,7 @@ "s3:GetObject", "s3:ListBucket" ], - "smithy.api#documentation": "

Creates a new application with given parameters. Requires an existing environment and\n application definition file.

", + "smithy.api#documentation": "

Creates a new application with given parameters. Requires an existing runtime environment and\n application definition file.

", "smithy.api#http": { "method": "POST", "uri": "/applications", @@ -1576,6 +1831,12 @@ "smithy.api#documentation": "

Unique, case-sensitive identifier the service generates to ensure the idempotency of the\n request to create an application. The service generates the clientToken when the API call\n is triggered. The token expires after one hour, so if you retry the API within this\n timeframe with the same clientToken, you will get the same response. The service also\n handles deleting the clientToken after it expires.

", "smithy.api#idempotencyToken": {} } + }, + "kmsKeyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of a customer managed key.

" + } } } }, @@ -1723,7 +1984,7 @@ "elasticloadbalancing:CreateTargetGroup", "elasticloadbalancing:CreateListener" ], - "smithy.api#documentation": "

Creates and starts a deployment to deploy an application into an environment.

", + "smithy.api#documentation": "

Creates and starts a deployment to deploy an application into a runtime environment.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/deployments", @@ -1738,7 +1999,7 @@ "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { - "smithy.api#documentation": "

The identifier of the environment where this application will be deployed.

", + "smithy.api#documentation": "

The identifier of the runtime environment where you want to deploy this application.

", "smithy.api#required": {} } }, @@ -1842,59 +2103,59 @@ "name": { "target": "com.amazonaws.m2#EntityName", "traits": { - "smithy.api#documentation": "

The unique identifier of the environment.

", + "smithy.api#documentation": "

The name of the runtime environment. Must be unique within the account.

", "smithy.api#required": {} } }, "instanceType": { "target": "com.amazonaws.m2#String20", "traits": { - "smithy.api#documentation": "

The type of instance for the environment.

", + "smithy.api#documentation": "

The type of instance for the runtime environment.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.m2#EntityDescription", "traits": { - "smithy.api#documentation": "

The description of the environment.

" + "smithy.api#documentation": "

The description of the runtime environment.

" } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { - "smithy.api#documentation": "

The engine type for the environment.

", + "smithy.api#documentation": "

The engine type for the runtime environment.

", "smithy.api#required": {} } }, "engineVersion": { "target": "com.amazonaws.m2#EngineVersion", "traits": { - "smithy.api#documentation": "

The version of the engine type for the environment.

" + "smithy.api#documentation": "

The version of the engine type for the runtime environment.

" } }, "subnetIds": { "target": "com.amazonaws.m2#String50List", "traits": { - "smithy.api#documentation": "

The list of subnets associated with the VPC for this environment.

" + "smithy.api#documentation": "

The list of subnets associated with the VPC for this runtime environment.

" } }, "securityGroupIds": { "target": "com.amazonaws.m2#String50List", "traits": { - "smithy.api#documentation": "

The list of security groups for the VPC associated with this environment.

" + "smithy.api#documentation": "

The list of security groups for the VPC associated with this runtime environment.

" } }, "storageConfigurations": { "target": "com.amazonaws.m2#StorageConfigurationList", "traits": { - "smithy.api#documentation": "

Optional. The storage configurations for this environment.

" + "smithy.api#documentation": "

Optional. The storage configurations for this runtime environment.

" } }, "publiclyAccessible": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the environment is publicly accessible.

" + "smithy.api#documentation": "

Specifies whether the runtime environment is publicly accessible.

" } }, "highAvailabilityConfig": { @@ -1906,13 +2167,13 @@ "tags": { "target": "com.amazonaws.m2#TagMap", "traits": { - "smithy.api#documentation": "

The tags for the environment.

" + "smithy.api#documentation": "

The tags for the runtime environment.

" } }, "preferredMaintenanceWindow": { "target": "com.amazonaws.m2#String50", "traits": { - "smithy.api#documentation": "

Configures a desired maintenance window for the environment. If you do not provide a\n value, a random system-generated value will be assigned.

" + "smithy.api#documentation": "

Configures the maintenance window you want for the runtime environment. If you do not provide a\n value, a random system-generated value will be assigned.

" } }, "clientToken": { @@ -1921,6 +2182,12 @@ "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the request\n to create an environment. The service generates the clientToken when the API call is\n triggered. The token expires after one hour, so if you retry the API within this timeframe\n with the same clientToken, you will get the same response. The service also handles\n deleting the clientToken after it expires.

", "smithy.api#idempotencyToken": {} } + }, + "kmsKeyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of a customer managed key.

" + } } } }, @@ -1930,7 +2197,7 @@ "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { - "smithy.api#documentation": "

The identifier of this environment.

", + "smithy.api#documentation": "

The unique identifier of the runtime environment.

", "smithy.api#required": {} } } @@ -1955,7 +2222,7 @@ "datasetOrg": { "target": "com.amazonaws.m2#DatasetOrgAttributes", "traits": { - "smithy.api#documentation": "

The type of dataset. Possible values include VSAM, IS, PS, GDG, PO, PS, UNKNOWN\n etc.

", + "smithy.api#documentation": "

The type of dataset. The only supported value is VSAM.

", "smithy.api#required": {} } }, @@ -2127,7 +2394,7 @@ "dataSetOrg": { "target": "com.amazonaws.m2#String20", "traits": { - "smithy.api#documentation": "

The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or\n unknown.

" + "smithy.api#documentation": "

The type of data set. The only supported value is VSAM.

" } }, "format": { @@ -2314,7 +2581,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Deletes a specific application from a specified environment where it has been previously\n deployed. You cannot delete an environment using DeleteEnvironment, if any application has\n ever been deployed to it. This API removes the association of the application with the\n environment so you can delete the environment smoothly.

", + "smithy.api#documentation": "

Deletes a specific application from the specific runtime environment where it was previously\n deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has\n ever been deployed to it. This API removes the association of the application with the\n runtime environment so you can delete the environment smoothly.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}/environment/{environmentId}", @@ -2394,7 +2661,7 @@ "aws.iam#requiredActions": [ "elasticloadbalancing:DeleteLoadBalancer" ], - "smithy.api#documentation": "

Deletes a specific environment. The environment cannot contain deployed applications. If\n it does, you must delete those applications before you delete the environment.

", + "smithy.api#documentation": "

Deletes a specific runtime environment. The environment cannot contain deployed applications. If\n it does, you must delete those applications before you delete the environment.

", "smithy.api#http": { "method": "DELETE", "uri": "/environments/{environmentId}", @@ -2493,7 +2760,7 @@ "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the environment.

", + "smithy.api#documentation": "

The unique identifier of the runtime environment.

", "smithy.api#required": {} } }, @@ -2680,6 +2947,10 @@ { "value": "Failed", "name": "FAILED" + }, + { + "value": "Updating", + "name": "UPDATING" } ] } @@ -2690,7 +2961,7 @@ "name": { "target": "com.amazonaws.m2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the environment.

", + "smithy.api#documentation": "

The name of the runtime environment.

", "smithy.api#required": {} } }, @@ -2711,21 +2982,21 @@ "instanceType": { "target": "com.amazonaws.m2#String20", "traits": { - "smithy.api#documentation": "

The instance type of the environment.

", + "smithy.api#documentation": "

The instance type of the runtime environment.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#EnvironmentLifecycle", "traits": { - "smithy.api#documentation": "

The status of the environment

", + "smithy.api#documentation": "

The status of the runtime environment

", "smithy.api#required": {} } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { - "smithy.api#documentation": "

The target platform for the environment.

", + "smithy.api#documentation": "

The target platform for the runtime environment.

", "smithy.api#required": {} } }, @@ -2739,13 +3010,13 @@ "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the environment was created.

", + "smithy.api#documentation": "

The timestamp when the runtime environment was created.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains a subset of the possible environment attributes. Used in the environment\n list.

" + "smithy.api#documentation": "

Contains a subset of the possible runtime environment attributes. Used in the environment\n list.

" } }, "com.amazonaws.m2#EnvironmentSummaryList": { @@ -2985,7 +3256,7 @@ "logGroups": { "target": "com.amazonaws.m2#LogGroupSummaries", "traits": { - "smithy.api#documentation": "

The list of log summaries. Each log summary includes the log type as well as the log\n group identifier. These are CloudWatch logs. The Amazon Web Services Mainframe Modernization application log is pushed to CloudWatch\n under the customer's account.

" + "smithy.api#documentation": "

The list of log summaries. Each log summary includes the log type as well as the log\n group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch\n under the customer's account.

" } }, "creationTime": { @@ -2998,7 +3269,7 @@ "lastStartTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the application was last started. Null until the application has\n started running for the first time.

" + "smithy.api#documentation": "

The timestamp when you last started the application. Null until the application runs for the first time.

" } }, "tags": { @@ -3010,7 +3281,7 @@ "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { - "smithy.api#documentation": "

The identifier of the environment where the application will be deployed.

" + "smithy.api#documentation": "

The identifier of the runtime environment where you want to deploy the application.

" } }, "targetGroupArns": { @@ -3022,7 +3293,7 @@ "listenerArns": { "target": "com.amazonaws.m2#ArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the network load balancer listener created in your\n Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener on your behalf the first time you deploy an\n application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the network load balancer listener created in your\n Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an\n application.

" } }, "listenerPorts": { @@ -3042,6 +3313,12 @@ "traits": { "smithy.api#documentation": "

The reason for the reported status.

" } + }, + "kmsKeyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of a customer managed key.

" + } } } }, @@ -3128,7 +3405,7 @@ "definitionContent": { "target": "com.amazonaws.m2#StringFree65000", "traits": { - "smithy.api#documentation": "

The content of the application definition. This is a JSON object that contains the\n resource configuration/definitions that identify an application.

", + "smithy.api#documentation": "

The content of the application definition. This is a JSON object that contains the\n resource configuration and definitions that identify an application.

", "smithy.api#required": {} } }, @@ -3359,7 +3636,7 @@ "dataSetOrg": { "target": "com.amazonaws.m2#DatasetDetailOrgAttributes", "traits": { - "smithy.api#documentation": "

The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or\n unknown.

" + "smithy.api#documentation": "

The type of data set. The only supported value is VSAM.

" } }, "recordLength": { @@ -3372,7 +3649,7 @@ "location": { "target": "com.amazonaws.m2#String2000", "traits": { - "smithy.api#documentation": "

The locaion where the data set is stored.

" + "smithy.api#documentation": "

The location where the data set is stored.

" } }, "blocksize": { @@ -3652,7 +3929,7 @@ "name": { "target": "com.amazonaws.m2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the runtime environment.

", + "smithy.api#documentation": "

The name of the runtime environment. Must be unique within the account.

", "smithy.api#required": {} } }, @@ -3776,9 +4053,9 @@ } }, "preferredMaintenanceWindow": { - "target": "smithy.api#String", + "target": "com.amazonaws.m2#String50", "traits": { - "smithy.api#documentation": "

Configures a desired maintenance window for the environment. If you do not provide a\n value, a random system-generated value will be assigned.

" + "smithy.api#documentation": "

Configures the maintenance window you want for the runtime environment. If you do not provide a\n value, a random system-generated value will be assigned.

" } }, "pendingMaintenance": { @@ -3786,6 +4063,12 @@ "traits": { "smithy.api#documentation": "

Indicates the pending maintenance scheduled on this environment.

" } + }, + "kmsKeyId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of a customer managed key.

" + } } } }, @@ -3974,7 +4257,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Lists the applications associated with a specific Amazon Web Services account. You can provide the\n unique identifier of a specific environment in a query parameter to see all applications\n associated with that environment.

", + "smithy.api#documentation": "

Lists the applications associated with a specific Amazon Web Services account. You can provide the\n unique identifier of a specific runtime environment in a query parameter to see all applications\n associated with that environment.

", "smithy.api#http": { "method": "GET", "uri": "/applications", @@ -4040,7 +4323,7 @@ "applications": { "target": "com.amazonaws.m2#ApplicationSummaryList", "traits": { - "smithy.api#documentation": "

Returns a list of summary details for all the applications in an environment.

", + "smithy.api#documentation": "

Returns a list of summary details for all the applications in a runtime environment.

", "smithy.api#required": {} } }, @@ -4082,7 +4365,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Lists all the available batch job definitions based on the batch job resources uploaded\n during the application creation. The listed batch job definitions can then be used to start\n a batch job.

", + "smithy.api#documentation": "

Lists all the available batch job definitions based on the batch job resources uploaded\n during the application creation. You can use the batch job definitions in the list to start\n a batch job.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/batch-job-definitions", @@ -4409,7 +4692,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are\n associated with applications deployed on environments. This is known as importing data\n sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.

", + "smithy.api#documentation": "

Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are\n associated with applications deployed on runtime environments. This is known as importing data\n sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/datasets", @@ -4471,7 +4754,7 @@ "dataSets": { "target": "com.amazonaws.m2#DataSetsSummaryList", "traits": { - "smithy.api#documentation": "

The list of data sets, containing ionformation including the creating time, the data set\n name, the data set organization, the data set format, and the last time the data set was\n referenced or updated.

", + "smithy.api#documentation": "

The list of data sets, containing information including the creation time, the data set\n name, the data set organization, the data set format, and the last time the data set was\n referenced or updated.

", "smithy.api#required": {} } }, @@ -4718,7 +5001,7 @@ "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token to control the number of environments displayed in the list.

", + "smithy.api#documentation": "

A pagination token to control the number of runtime environments displayed in the list.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4726,21 +5009,21 @@ "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of environments to return.

", + "smithy.api#documentation": "

The maximum number of runtime environments to return.

", "smithy.api#httpQuery": "maxResults" } }, "names": { "target": "com.amazonaws.m2#EntityNameList", "traits": { - "smithy.api#documentation": "

The name of the environment.

", + "smithy.api#documentation": "

The names of the runtime environments. Must be unique within the account.

", "smithy.api#httpQuery": "names" } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { - "smithy.api#documentation": "

The engine type for the environment.

", + "smithy.api#documentation": "

The engine type for the runtime environment.

", "smithy.api#httpQuery": "engineType" } } @@ -4755,14 +5038,14 @@ "environments": { "target": "com.amazonaws.m2#EnvironmentSummaryList", "traits": { - "smithy.api#documentation": "

Returns a list of summary details for all the environments in your account.

", + "smithy.api#documentation": "

Returns a list of summary details for all the runtime environments in your account.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token that's returned when the response doesn't contain all the\n environments.

" + "smithy.api#documentation": "

A pagination token that's returned when the response doesn't contain all the\n runtime environments.

" } } }, @@ -4864,7 +5147,7 @@ } }, "traits": { - "smithy.api#documentation": "

A subset of the attributes about a log group. In CloudWatch a log group is a group of log\n streams that share the same retention, monitoring, and access control settings.

" + "smithy.api#documentation": "

A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log\n streams that share the same retention, monitoring, and access control settings.

" } }, "com.amazonaws.m2#MaintenanceSchedule": { @@ -4908,7 +5191,7 @@ "schedule": { "target": "com.amazonaws.m2#MaintenanceSchedule", "traits": { - "smithy.api#documentation": "

The maintenance schedule for the engine version.

" + "smithy.api#documentation": "

The maintenance schedule for the runtime engine version.

" } }, "engineVersion": { @@ -5295,7 +5578,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the storage configuration for an environment.

" + "smithy.api#documentation": "

Defines the storage configuration for a runtime environment.

" } }, "com.amazonaws.m2#StorageConfigurationList": { @@ -5679,7 +5962,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Updates the configuration details for a specific environment.

", + "smithy.api#documentation": "

Updates the configuration details for a specific runtime environment.

", "smithy.api#http": { "method": "PATCH", "uri": "/environments/{environmentId}", @@ -5702,32 +5985,32 @@ "target": "com.amazonaws.m2#CapacityValue", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

The desired capacity for the environment to update.

" + "smithy.api#documentation": "

The desired capacity for the runtime environment to update.

" } }, "instanceType": { "target": "com.amazonaws.m2#String20", "traits": { - "smithy.api#documentation": "

The instance type for the environment to update.

" + "smithy.api#documentation": "

The instance type for the runtime environment to update.

" } }, "engineVersion": { "target": "com.amazonaws.m2#EngineVersion", "traits": { - "smithy.api#documentation": "

The version of the runtime engine for the environment.

" + "smithy.api#documentation": "

The version of the runtime engine for the runtime environment.

" } }, "preferredMaintenanceWindow": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Configures a desired maintenance window for the environment. If you do not provide a\n value, a random system-generated value will be assigned.

" + "smithy.api#documentation": "

Configures the maintenance window you want for the runtime environment. If you do not provide a\n value, a random system-generated value will be assigned.

" } }, "applyDuringMaintenanceWindow": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to update the environment during the maintenance window. The default\n is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if\n applyDuringMaintenanceWindow is true. If any parameter other than\n engineVersion is provided in UpdateEnvironmentRequest, it will\n fail if applyDuringMaintenanceWindow is set to true.

" + "smithy.api#documentation": "

Indicates whether to update the runtime environment during the maintenance window. The default\n is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if\n applyDuringMaintenanceWindow is true. If any parameter other than\n engineVersion is provided in UpdateEnvironmentRequest, it will\n fail if applyDuringMaintenanceWindow is set to true.

" } } } diff --git a/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json b/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json index 75d2e4cbb70..acd323f43b0 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json +++ b/codegen/sdk-codegen/aws-models/marketplace-entitlement-service.2017-01-11.json @@ -519,7 +519,7 @@ } }, "com.amazonaws.marketplaceentitlementservice#EntitlementValue": { - "type": "union", + "type": "structure", "members": { "IntegerValue": { "target": "com.amazonaws.marketplaceentitlementservice#Integer", diff --git a/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json b/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json index 6ec84820b59..48975796079 100644 --- a/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json +++ b/codegen/sdk-codegen/aws-models/medialive.2017-10-14.json @@ -956,6 +956,22 @@ "smithy.api#documentation": "Audio Description Language Code Control" } }, + "com.amazonaws.medialive#AudioDolbyEDecode": { + "type": "structure", + "members": { + "ProgramSelection": { + "target": "com.amazonaws.medialive#DolbyEProgramSelection", + "traits": { + "smithy.api#documentation": "Applies only to Dolby E. Enter the program ID (according to the metadata in the audio) of the Dolby E program to extract from the specified track. One program extracted per audio selector. To select multiple programs, create multiple selectors with the same Track and different Program numbers. “All channels” means to ignore the program IDs and include all the channels in this selector; useful if metadata is known to be incorrect.", + "smithy.api#jsonName": "programSelection", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Audio Dolby EDecode" + } + }, "com.amazonaws.medialive#AudioHlsRenditionSelection": { "type": "structure", "members": { @@ -1298,6 +1314,13 @@ "smithy.api#jsonName": "tracks", "smithy.api#required": {} } + }, + "DolbyEDecode": { + "target": "com.amazonaws.medialive#AudioDolbyEDecode", + "traits": { + "smithy.api#documentation": "Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337", + "smithy.api#jsonName": "dolbyEDecode" + } } }, "traits": { @@ -6750,11 +6773,73 @@ "smithy.api#documentation": "The status of software on the input device." } }, + "com.amazonaws.medialive#DolbyEProgramSelection": { + "type": "enum", + "members": { + "ALL_CHANNELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_CHANNELS" + } + }, + "PROGRAM_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_1" + } + }, + "PROGRAM_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_2" + } + }, + "PROGRAM_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_3" + } + }, + "PROGRAM_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_4" + } + }, + "PROGRAM_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_5" + } + }, + "PROGRAM_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_6" + } + }, + "PROGRAM_7": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_7" + } + }, + "PROGRAM_8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_8" + } + } + }, + "traits": { + "smithy.api#documentation": "Dolby EProgram Selection" + } + }, "com.amazonaws.medialive#DolbyVision81Settings": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Dolby Vision Profile 8.1 Settings" + "smithy.api#documentation": "Dolby Vision81 Settings" } }, "com.amazonaws.medialive#DvbNitSettings": { @@ -8252,7 +8337,7 @@ "PasswordParam": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Password if credentials are required to access the POIS endpoint. This is a reference to an AWS parameter store name from which the password can be retrieved. AWS Parameter store format: \"ssm://\"", + "smithy.api#documentation": "Documentation update needed", "smithy.api#jsonName": "passwordParam" } }, @@ -8267,7 +8352,7 @@ "Username": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Username if credentials are required to access the POIS endpoint. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: \"ssm://\"", + "smithy.api#documentation": "Documentation update needed", "smithy.api#jsonName": "username" } }, @@ -8280,7 +8365,7 @@ } }, "traits": { - "smithy.api#documentation": "Settings for the Esam" + "smithy.api#documentation": "Esam" } }, "com.amazonaws.medialive#FailoverCondition": { @@ -8743,6 +8828,13 @@ "smithy.api#documentation": "Unit for the frame capture interval.", "smithy.api#jsonName": "captureIntervalUnits" } + }, + "TimecodeBurninSettings": { + "target": "com.amazonaws.medialive#TimecodeBurninSettings", + "traits": { + "smithy.api#documentation": "Timecode burn-in settings", + "smithy.api#jsonName": "timecodeBurninSettings" + } } }, "traits": { @@ -9723,6 +9815,13 @@ "smithy.api#documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config", "smithy.api#jsonName": "timecodeInsertion" } + }, + "TimecodeBurninSettings": { + "target": "com.amazonaws.medialive#TimecodeBurninSettings", + "traits": { + "smithy.api#documentation": "Timecode burn-in settings", + "smithy.api#jsonName": "timecodeBurninSettings" + } } }, "traits": { @@ -10434,6 +10533,13 @@ "smithy.api#documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config", "smithy.api#jsonName": "timecodeInsertion" } + }, + "TimecodeBurninSettings": { + "target": "com.amazonaws.medialive#TimecodeBurninSettings", + "traits": { + "smithy.api#documentation": "Timecode burn-in settings", + "smithy.api#jsonName": "timecodeBurninSettings" + } } }, "traits": { @@ -11021,7 +11127,7 @@ "target": "com.amazonaws.medialive#__integerMin0", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.", + "smithy.api#documentation": "Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.", "smithy.api#jsonName": "minSegmentLength" } }, @@ -11072,7 +11178,7 @@ "target": "com.amazonaws.medialive#__integerMin1", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.", + "smithy.api#documentation": "Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer.", "smithy.api#jsonName": "segmentLength" } }, @@ -12215,6 +12321,14 @@ "smithy.api#documentation": "The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video.", "smithy.api#jsonName": "maxBitrate" } + }, + "LatencyMs": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms).", + "smithy.api#jsonName": "latencyMs" + } } }, "traits": { @@ -12329,6 +12443,14 @@ "smithy.api#documentation": "The width of the video source, in pixels.", "smithy.api#jsonName": "width" } + }, + "LatencyMs": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.", + "smithy.api#jsonName": "latencyMs" + } } }, "traits": { @@ -12595,6 +12717,12 @@ "traits": { "smithy.api#enumValue": "HD" } + }, + "UHD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UHD" + } } }, "traits": { @@ -12663,6 +12791,14 @@ "smithy.api#documentation": "The width of the video source, in pixels.", "smithy.api#jsonName": "width" } + }, + "LatencyMs": { + "target": "com.amazonaws.medialive#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The Link device's buffer size (latency) in milliseconds (ms). You can specify this value.", + "smithy.api#jsonName": "latencyMs" + } } }, "traits": { @@ -15959,15 +16095,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -16228,9 +16355,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -16241,9 +16368,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -16252,9 +16379,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -16265,9 +16392,57 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://medialive-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://medialive.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -16278,9 +16453,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -16290,9 +16465,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -16302,9 +16477,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -16775,6 +16950,13 @@ "smithy.api#documentation": "Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \\\"MediaLive Features - Timecode configuration\\\" in the MediaLive User Guide.\nDISABLED: do not include timecodes.\nGOP_TIMECODE: Include timecode metadata in the GOP header.", "smithy.api#jsonName": "timecodeInsertion" } + }, + "TimecodeBurninSettings": { + "target": "com.amazonaws.medialive#TimecodeBurninSettings", + "traits": { + "smithy.api#documentation": "Timecode burn-in settings", + "smithy.api#jsonName": "timecodeBurninSettings" + } } }, "traits": { @@ -19909,7 +20091,7 @@ } }, "traits": { - "smithy.api#documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file." + "smithy.api#documentation": "Whether the SCTE-35 input should be the active input or a fixed input." } }, "com.amazonaws.medialive#Scte35InputScheduleActionSettings": { @@ -19932,7 +20114,7 @@ } }, "traits": { - "smithy.api#documentation": "Settings for the \"scte35 input\" action" + "smithy.api#documentation": "Scte35Input Schedule Action Settings" } }, "com.amazonaws.medialive#Scte35NoRegionalBlackoutFlag": { @@ -21568,6 +21750,131 @@ "smithy.api#documentation": "Temporal Filter Strength" } }, + "com.amazonaws.medialive#TimecodeBurninFontSize": { + "type": "enum", + "members": { + "EXTRA_SMALL_10": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTRA_SMALL_10" + } + }, + "LARGE_48": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE_48" + } + }, + "MEDIUM_32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM_32" + } + }, + "SMALL_16": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL_16" + } + } + }, + "traits": { + "smithy.api#documentation": "Timecode Burnin Font Size" + } + }, + "com.amazonaws.medialive#TimecodeBurninPosition": { + "type": "enum", + "members": { + "BOTTOM_CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM_CENTER" + } + }, + "BOTTOM_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM_LEFT" + } + }, + "BOTTOM_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM_RIGHT" + } + }, + "MIDDLE_CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIDDLE_CENTER" + } + }, + "MIDDLE_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIDDLE_LEFT" + } + }, + "MIDDLE_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIDDLE_RIGHT" + } + }, + "TOP_CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_CENTER" + } + }, + "TOP_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_LEFT" + } + }, + "TOP_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_RIGHT" + } + } + }, + "traits": { + "smithy.api#documentation": "Timecode Burnin Position" + } + }, + "com.amazonaws.medialive#TimecodeBurninSettings": { + "type": "structure", + "members": { + "FontSize": { + "target": "com.amazonaws.medialive#TimecodeBurninFontSize", + "traits": { + "smithy.api#documentation": "Choose a timecode burn-in font size", + "smithy.api#jsonName": "fontSize", + "smithy.api#required": {} + } + }, + "Position": { + "target": "com.amazonaws.medialive#TimecodeBurninPosition", + "traits": { + "smithy.api#documentation": "Choose a timecode burn-in output position", + "smithy.api#jsonName": "position", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.medialive#__stringMax255", + "traits": { + "smithy.api#documentation": "Create a timecode burn-in prefix (optional)", + "smithy.api#jsonName": "prefix" + } + } + }, + "traits": { + "smithy.api#documentation": "Timecode Burnin Settings" + } + }, "com.amazonaws.medialive#TimecodeConfig": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/mediapackage-vod.2018-11-07.json b/codegen/sdk-codegen/aws-models/mediapackage-vod.2018-11-07.json index 8102d770880..a4f52da0f88 100644 --- a/codegen/sdk-codegen/aws-models/mediapackage-vod.2018-11-07.json +++ b/codegen/sdk-codegen/aws-models/mediapackage-vod.2018-11-07.json @@ -771,7 +771,7 @@ "ScteMarkersSource": { "target": "com.amazonaws.mediapackagevod#ScteMarkersSource", "traits": { - "smithy.api#documentation": "The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content.", + "smithy.api#documentation": "The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content. The MANIFEST value is compatible with source HLS playlists using the SCTE-35 Enhanced syntax (#EXT-OATCLS-SCTE35 tags). SCTE-35 Elemental and SCTE-35 Daterange syntaxes are not supported with this option.", "smithy.api#jsonName": "scteMarkersSource" } }, @@ -1284,6 +1284,14 @@ "com.amazonaws.mediapackagevod#DescribePackagingGroupResponse": { "type": "structure", "members": { + "ApproximateAssetCount": { + "target": "com.amazonaws.mediapackagevod#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The approximate asset count of the PackagingGroup.", + "smithy.api#jsonName": "approximateAssetCount" + } + }, "Arn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -3348,6 +3356,14 @@ "com.amazonaws.mediapackagevod#PackagingGroup": { "type": "structure", "members": { + "ApproximateAssetCount": { + "target": "com.amazonaws.mediapackagevod#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The approximate asset count of the PackagingGroup.", + "smithy.api#jsonName": "approximateAssetCount" + } + }, "Arn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { @@ -3839,6 +3855,14 @@ "com.amazonaws.mediapackagevod#UpdatePackagingGroupResponse": { "type": "structure", "members": { + "ApproximateAssetCount": { + "target": "com.amazonaws.mediapackagevod#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The approximate asset count of the PackagingGroup.", + "smithy.api#jsonName": "approximateAssetCount" + } + }, "Arn": { "target": "com.amazonaws.mediapackagevod#__string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json b/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json index b2b3388a8f9..525cfe6cbf3 100644 --- a/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json +++ b/codegen/sdk-codegen/aws-models/mediatailor.2018-04-23.json @@ -6170,4 +6170,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/mgn.2020-02-26.json b/codegen/sdk-codegen/aws-models/mgn.2020-02-26.json index b762d751a9c..23c2e1c8440 100644 --- a/codegen/sdk-codegen/aws-models/mgn.2020-02-26.json +++ b/codegen/sdk-codegen/aws-models/mgn.2020-02-26.json @@ -9099,4 +9099,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/migration-hub-refactor-spaces.2021-10-26.json b/codegen/sdk-codegen/aws-models/migration-hub-refactor-spaces.2021-10-26.json index 65f3a786968..d2a5659152e 100644 --- a/codegen/sdk-codegen/aws-models/migration-hub-refactor-spaces.2021-10-26.json +++ b/codegen/sdk-codegen/aws-models/migration-hub-refactor-spaces.2021-10-26.json @@ -752,7 +752,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 created, the default route defaults to an active state so state is not a required\n input. However, like all other state values the state of the default route can be updated\n after creation, but only when all other routes are also inactive. Conversely, no route can be\n active without the default route also being active.

\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 either the route is updated from\n inactive to active, or when it is created with an active state. If the health check fails, the\n route transitions the route state to FAILED, an error code of\n SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, 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 Lambda endpoints, a check is performed to determine that a Lambda function with the\n specified ARN exists. If it does not exist, the health check fails. For public URLs, a\n connection is opened to the public endpoint. If the URL is not reachable, the health check\n fails.

\n

For private URLS, a target group is created on the Elastic Load Balancing and the target\n group health check is run. The HealthCheckProtocol, HealthCheckPort,\n and 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 also publicly resolvable.

", + "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 created, the default route defaults to an active state so state is not a required\n input. However, like all other state values the state of the default route can be updated\n after creation, but only when all other routes are also inactive. Conversely, no route can be\n active without the default route also being active.

\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 either the route is updated from\n inactive to active, or when it is created with an active state. If the health check fails, the\n route transitions the route state to FAILED, an error code of\n SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, 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 Lambda endpoints, a check is performed to determine that a Lambda function with the\n specified ARN exists. If it does not exist, the health check fails. For public URLs, a\n connection is opened to the public endpoint. If the URL is not reachable, the health check\n fails.

\n

Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in\n CreateServiceRequest$UrlEndpoint when you create a service. The DNS names\n resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60\n seconds. This periodic DNS resolution ensures that the route configuration remains up-to-date.

\n

For private URLS, a target group is created on the Elastic Load Balancing and the target\n group health check is run. The HealthCheckProtocol, HealthCheckPort,\n and 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 also publicly resolvable.

", "smithy.api#http": { "method": "POST", "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes", @@ -796,7 +796,7 @@ "DefaultRoute": { "target": "com.amazonaws.migrationhubrefactorspaces#DefaultRouteInput", "traits": { - "smithy.api#documentation": "

\n Configuration for the default route type.\n

" + "smithy.api#documentation": "

Configuration for the default route type.

" } }, "UriPathRoute": { @@ -985,7 +985,7 @@ "UrlEndpoint": { "target": "com.amazonaws.migrationhubrefactorspaces#UrlEndpointInput", "traits": { - "smithy.api#documentation": "

The configuration for the URL endpoint type.

" + "smithy.api#documentation": "

The configuration for the URL endpoint type. When creating a route to a service, Refactor Spaces\n automatically resolves the address in the UrlEndpointInput object URL when the\n Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60\n seconds.

" } }, "LambdaEndpoint": { @@ -1121,7 +1121,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n The configuration for the default route type.\n

" + "smithy.api#documentation": "

The configuration for the default route type.

" } }, "com.amazonaws.migrationhubrefactorspaces#DeleteApplication": { @@ -2732,7 +2732,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:\n(\\$LATEST|[a-zA-Z0-9-_]+))?$" + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" } }, "com.amazonaws.migrationhubrefactorspaces#LambdaEndpointConfig": { @@ -2755,7 +2755,7 @@ "Arn": { "target": "com.amazonaws.migrationhubrefactorspaces#LambdaArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda endpoint.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function or alias.

", "smithy.api#required": {} } } @@ -3544,7 +3544,7 @@ "x-amzn-errormessage" ] }, - "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

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#documentation": "Amazon Web Services Migration Hub Refactor Spaces\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

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", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3865,9 +3865,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -3877,9 +3877,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseFIPS": true, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -3889,9 +3889,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, "Endpoint": "https://example.com" } } @@ -4601,7 +4601,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Updates an Amazon Web Services Migration Hub Refactor Spaces route.\n

", + "smithy.api#documentation": "

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

", "smithy.api#http": { "method": "PATCH", "uri": "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes/{RouteIdentifier}", @@ -4615,7 +4615,7 @@ "EnvironmentIdentifier": { "target": "com.amazonaws.migrationhubrefactorspaces#EnvironmentId", "traits": { - "smithy.api#documentation": "

\n The ID of the environment in which the route is being updated.\n

", + "smithy.api#documentation": "

The ID of the environment in which the route is being updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4623,7 +4623,7 @@ "ApplicationIdentifier": { "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", "traits": { - "smithy.api#documentation": "

\n The ID of the application within which the route is being updated.\n

", + "smithy.api#documentation": "

The ID of the application within which the route is being updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4631,7 +4631,7 @@ "RouteIdentifier": { "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the route to update.\n

", + "smithy.api#documentation": "

The unique identifier of the route to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4651,37 +4651,37 @@ "RouteId": { "target": "com.amazonaws.migrationhubrefactorspaces#RouteId", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the route.\n

" + "smithy.api#documentation": "

The unique identifier of the route.

" } }, "Arn": { "target": "com.amazonaws.migrationhubrefactorspaces#ResourceArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the route. The format for this ARN is \narn:aws:refactor-spaces:region:account-id:resource-type/resource-id\n . For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the route. The format for this ARN is \narn:aws:refactor-spaces:region:account-id:resource-type/resource-id\n . For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference.

" } }, "ServiceId": { "target": "com.amazonaws.migrationhubrefactorspaces#ServiceId", "traits": { - "smithy.api#documentation": "

\n The ID of service in which the route was created. Traffic that matches this route is forwarded to this service.\n

" + "smithy.api#documentation": "

The ID of service in which the route was created. Traffic that matches this route is\n forwarded to this service.

" } }, "ApplicationId": { "target": "com.amazonaws.migrationhubrefactorspaces#ApplicationId", "traits": { - "smithy.api#documentation": "

\n The ID of the application in which the route is being updated.\n

" + "smithy.api#documentation": "

The ID of the application in which the route is being updated.

" } }, "State": { "target": "com.amazonaws.migrationhubrefactorspaces#RouteState", "traits": { - "smithy.api#documentation": "

\n The current state of the route.\n

" + "smithy.api#documentation": "

The current state of the route.

" } }, "LastUpdatedTime": { "target": "com.amazonaws.migrationhubrefactorspaces#Timestamp", "traits": { - "smithy.api#documentation": "

\n A timestamp that indicates when the route was last updated.\n

" + "smithy.api#documentation": "

A timestamp that indicates when the route was last updated.

" } } } diff --git a/codegen/sdk-codegen/aws-models/migrationhubstrategy.2020-02-19.json b/codegen/sdk-codegen/aws-models/migrationhubstrategy.2020-02-19.json index de49c72674e..70b81d86dbf 100644 --- a/codegen/sdk-codegen/aws-models/migrationhubstrategy.2020-02-19.json +++ b/codegen/sdk-codegen/aws-models/migrationhubstrategy.2020-02-19.json @@ -17,6 +17,9 @@ { "target": "com.amazonaws.migrationhubstrategy#GetImportFileTask" }, + { + "target": "com.amazonaws.migrationhubstrategy#GetLatestAssessmentId" + }, { "target": "com.amazonaws.migrationhubstrategy#GetPortfolioPreferences" }, @@ -69,23 +72,21 @@ "traits": { "aws.api#service": { "sdkId": "MigrationHubStrategy", - "arnNamespace": "awsmigrationhubstrategyrecommendation", - "cloudFormationName": "AWSMigrationHubStrategyRecommendation", - "cloudTrailEventSource": "migrationhub-strategy.amazonaws.com", - "endpointPrefix": "migrationhub-strategy" + "endpointPrefix": "migrationhub-strategy", + "cloudTrailEventSource": "migrationhub-strategy.amazonaws.com" }, "aws.auth#sigv4": { "name": "migrationhub-strategy" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Migration Hub Strategy Recommendations\n\n

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the AWS SDKs to access\n an API that is tailored to the programming language or platform that you're using. For more\n information, see AWS SDKs.

", + "smithy.api#documentation": "Migration Hub Strategy Recommendations\n\n

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Migration Hub Strategy Recommendations (Strategy Recommendations). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the AWS SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see AWS SDKs.

", "smithy.api#title": "Migration Hub Strategy Recommendations", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -134,15 +135,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -405,9 +397,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -418,9 +410,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -431,9 +423,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -444,9 +436,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -457,9 +449,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -470,9 +462,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -483,9 +475,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -496,9 +488,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -509,9 +501,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -522,9 +514,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -535,9 +527,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -548,9 +540,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -561,9 +553,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -574,9 +566,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -587,9 +579,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -600,9 +592,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -613,9 +605,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -626,9 +618,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -639,9 +631,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -652,9 +644,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -665,9 +657,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -678,9 +670,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -691,9 +683,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -704,9 +696,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -717,9 +709,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -730,9 +722,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -743,9 +735,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -756,9 +748,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -769,9 +761,9 @@ } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -781,9 +773,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -793,9 +785,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -825,16 +817,16 @@ "traits": { "smithy.api#enum": [ { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" }, { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" }, { - "value": "SUCCESS", - "name": "SUCCESS" + "name": "SUCCESS", + "value": "SUCCESS" } ] } @@ -845,18 +837,18 @@ "severity": { "target": "com.amazonaws.migrationhubstrategy#Severity", "traits": { - "smithy.api#documentation": "

\n Contains the severity of anti-patterns.\n

" + "smithy.api#documentation": "

Contains the severity of anti-patterns.

" } }, "count": { "target": "com.amazonaws.migrationhubstrategy#Integer", "traits": { - "smithy.api#documentation": "

\n Contains the count of anti-patterns.\n

" + "smithy.api#documentation": "

Contains the count of anti-patterns.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the summary of anti-patterns and their severity.\n

" + "smithy.api#documentation": "

Contains the summary of anti-patterns and their severity.

" } }, "com.amazonaws.migrationhubstrategy#AppType": { @@ -886,6 +878,111 @@ { "value": "Other", "name": "other" + }, + { + "value": "Tomcat", + "name": "tomcat" + }, + { + "value": "JBoss", + "name": "jboss" + }, + { + "value": "Spring", + "name": "spring" + }, + { + "value": "Mongo DB", + "name": "mongodb" + }, + { + "value": "DB2", + "name": "db2" + }, + { + "value": "Maria DB", + "name": "mariadb" + }, + { + "value": "MySQL", + "name": "mysql" + }, + { + "value": "Sybase", + "name": "sybase" + }, + { + "value": "PostgreSQLServer", + "name": "postgresqlserver" + }, + { + "value": "Cassandra", + "name": "cassandra" + }, + { + "value": "IBM WebSphere", + "name": "websphere" + }, + { + "value": "Oracle WebLogic", + "name": "weblogic" + }, + { + "value": "Visual Basic", + "name": "visualbasic" + }, + { + "value": "Unknown", + "name": "unknown" + }, + { + "value": "DotnetCore", + "name": "dotnetcore" + }, + { + "value": "Dotnet", + "name": "dotnet" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#AppUnitError": { + "type": "structure", + "members": { + "appUnitErrorCategory": { + "target": "com.amazonaws.migrationhubstrategy#AppUnitErrorCategory", + "traits": { + "smithy.api#documentation": "

The category of the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error in the analysis of the application unit.

" + } + }, + "com.amazonaws.migrationhubstrategy#AppUnitErrorCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CREDENTIAL_ERROR", + "value": "CREDENTIAL_ERROR" + }, + { + "name": "CONNECTIVITY_ERROR", + "value": "CONNECTIVITY_ERROR" + }, + { + "name": "PERMISSION_ERROR", + "value": "PERMISSION_ERROR" + }, + { + "name": "UNSUPPORTED_ERROR", + "value": "UNSUPPORTED_ERROR" + }, + { + "name": "OTHER_ERROR", + "value": "OTHER_ERROR" } ] } @@ -917,6 +1014,14 @@ { "value": "DESTINATION", "name": "DESTINATION" + }, + { + "value": "ANALYSIS_STATUS", + "name": "ANALYSIS_STATUS" + }, + { + "value": "ERROR_CATEGORY", + "name": "ERROR_CATEGORY" } ] } @@ -1037,6 +1142,24 @@ "traits": { "smithy.api#documentation": "

Set to true if the application component is running on multiple servers.

" } + }, + "runtimeStatus": { + "target": "com.amazonaws.migrationhubstrategy#RuntimeAnalysisStatus", + "traits": { + "smithy.api#documentation": "

The status of the application unit.

" + } + }, + "runtimeStatusMessage": { + "target": "com.amazonaws.migrationhubstrategy#StatusMessage", + "traits": { + "smithy.api#documentation": "

The status message for the application unit.

" + } + }, + "appUnitError": { + "target": "com.amazonaws.migrationhubstrategy#AppUnitError", + "traits": { + "smithy.api#documentation": "

The error in the analysis of the source code or database.

" + } } }, "traits": { @@ -1058,6 +1181,26 @@ "smithy.api#pattern": "[0-9a-zA-Z-]+" } }, + "com.amazonaws.migrationhubstrategy#ApplicationComponentStatusSummary": { + "type": "structure", + "members": { + "srcCodeOrDbAnalysisStatus": { + "target": "com.amazonaws.migrationhubstrategy#SrcCodeOrDbAnalysisStatus", + "traits": { + "smithy.api#documentation": "

The status of database analysis.

" + } + }, + "count": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "

The number of application components successfully analyzed, partially successful or failed\n analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of the analysis status of the application component.

" + } + }, "com.amazonaws.migrationhubstrategy#ApplicationComponentStrategies": { "type": "list", "member": { @@ -1096,18 +1239,37 @@ "appType": { "target": "com.amazonaws.migrationhubstrategy#AppType", "traits": { - "smithy.api#documentation": "

\n Contains the name of application types.\n

" + "smithy.api#documentation": "

Contains the name of application types.

" } }, "count": { "target": "com.amazonaws.migrationhubstrategy#Integer", "traits": { - "smithy.api#documentation": "

\n Contains the count of application type.\n

" + "smithy.api#documentation": "

Contains the count of application type.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains the summary of application components.\n

" + "smithy.api#documentation": "

Contains the summary of application components.

" + } + }, + "com.amazonaws.migrationhubstrategy#ApplicationMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ALL", + "value": "ALL" + }, + { + "name": "KNOWN", + "value": "KNOWN" + }, + { + "name": "UNKNOWN", + "value": "UNKNOWN" + } + ] } }, "com.amazonaws.migrationhubstrategy#ApplicationPreferences": { @@ -1116,12 +1278,12 @@ "managementPreference": { "target": "com.amazonaws.migrationhubstrategy#ManagementPreference", "traits": { - "smithy.api#documentation": "

\n Application preferences that you specify to prefer managed environment.\n

" + "smithy.api#documentation": "

Application preferences that you specify to prefer managed environment.

" } } }, "traits": { - "smithy.api#documentation": "

\n Application preferences that you specify.\n

" + "smithy.api#documentation": "

Application preferences that you specify.

" } }, "com.amazonaws.migrationhubstrategy#AssessmentStatus": { @@ -1147,66 +1309,135 @@ ] } }, + "com.amazonaws.migrationhubstrategy#AssessmentStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, "com.amazonaws.migrationhubstrategy#AssessmentSummary": { "type": "structure", "members": { "listServerStrategySummary": { "target": "com.amazonaws.migrationhubstrategy#ListStrategySummary", "traits": { - "smithy.api#documentation": "

\n List of ServerStrategySummary.\n

" + "smithy.api#documentation": "

List of ServerStrategySummary.

" } }, "listApplicationComponentStrategySummary": { "target": "com.amazonaws.migrationhubstrategy#ListStrategySummary", "traits": { - "smithy.api#documentation": "

\n List of ApplicationComponentStrategySummary.\n

" + "smithy.api#documentation": "

List of ApplicationComponentStrategySummary.

" } }, "listAntipatternSeveritySummary": { "target": "com.amazonaws.migrationhubstrategy#ListAntipatternSeveritySummary", "traits": { - "smithy.api#documentation": "

\n List of AntipatternSeveritySummary.\n

" + "smithy.api#documentation": "

List of AntipatternSeveritySummary.

" } }, "listApplicationComponentSummary": { "target": "com.amazonaws.migrationhubstrategy#ListApplicationComponentSummary", "traits": { - "smithy.api#documentation": "

\n List of ApplicationComponentSummary.\n

" + "smithy.api#documentation": "

List of ApplicationComponentSummary.

" } }, "listServerSummary": { "target": "com.amazonaws.migrationhubstrategy#ListServerSummary", "traits": { - "smithy.api#documentation": "

\n List of ServerSummary.\n

" + "smithy.api#documentation": "

List of ServerSummary.

" } }, "antipatternReportS3Object": { "target": "com.amazonaws.migrationhubstrategy#S3Object", "traits": { - "smithy.api#documentation": "

\n The Amazon S3 object containing the anti-pattern report.\n

" + "smithy.api#documentation": "

The Amazon S3 object containing the anti-pattern report.

" } }, "antipatternReportStatus": { "target": "com.amazonaws.migrationhubstrategy#AntipatternReportStatus", "traits": { - "smithy.api#documentation": "

\n The status of the anti-pattern report.\n

" + "smithy.api#documentation": "

The status of the anti-pattern report.

" } }, "antipatternReportStatusMessage": { "target": "com.amazonaws.migrationhubstrategy#StatusMessage", "traits": { - "smithy.api#documentation": "

\n The status message of the anti-pattern report.\n

" + "smithy.api#documentation": "

The status message of the anti-pattern report.

" } }, "lastAnalyzedTimestamp": { "target": "com.amazonaws.migrationhubstrategy#TimeStamp", "traits": { - "smithy.api#documentation": "

\n The time the assessment was performed.\n

" + "smithy.api#documentation": "

The time the assessment was performed.

" + } + }, + "listApplicationComponentStatusSummary": { + "target": "com.amazonaws.migrationhubstrategy#ListApplicationComponentStatusSummary", + "traits": { + "smithy.api#documentation": "

List of status summaries of the analyzed application components.

" + } + }, + "listServerStatusSummary": { + "target": "com.amazonaws.migrationhubstrategy#ListServerStatusSummary", + "traits": { + "smithy.api#documentation": "

List of status summaries of the analyzed servers.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the summary of the assessment results.

" + } + }, + "com.amazonaws.migrationhubstrategy#AssessmentTarget": { + "type": "structure", + "members": { + "condition": { + "target": "com.amazonaws.migrationhubstrategy#Condition", + "traits": { + "smithy.api#documentation": "

Condition of an assessment.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "

Name of an assessment.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.migrationhubstrategy#AssessmentTargetValues", + "traits": { + "smithy.api#documentation": "

Values of an assessment.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n Contains the summary of the assessment results.\n

" + "smithy.api#documentation": "

Defines the criteria of assessment.

" + } + }, + "com.amazonaws.migrationhubstrategy#AssessmentTargetValues": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#String" + } + }, + "com.amazonaws.migrationhubstrategy#AssessmentTargets": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#AssessmentTarget" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } } }, "com.amazonaws.migrationhubstrategy#AssociatedApplication": { @@ -1215,18 +1446,18 @@ "name": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n Name of the application as defined in Application Discovery Service.\n

" + "smithy.api#documentation": "

Name of the application as defined in Application Discovery Service.

" } }, "id": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n ID of the application as defined in Application Discovery Service.\n

" + "smithy.api#documentation": "

ID of the application as defined in Application Discovery Service.

" } } }, "traits": { - "smithy.api#documentation": "

\n Object containing details about applications as defined in Application Discovery Service.\n

" + "smithy.api#documentation": "

Object containing details about applications as defined in Application Discovery Service.

" } }, "com.amazonaws.migrationhubstrategy#AssociatedApplications": { @@ -1251,19 +1482,38 @@ "smithy.api#pattern": "[0-9a-z-:]+" } }, + "com.amazonaws.migrationhubstrategy#AuthType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NTLM", + "name": "NTLM" + }, + { + "value": "SSH", + "name": "SSH" + }, + { + "value": "CERT", + "name": "CERT" + } + ] + } + }, "com.amazonaws.migrationhubstrategy#AwsManagedResources": { "type": "structure", "members": { "targetDestination": { "target": "com.amazonaws.migrationhubstrategy#AwsManagedTargetDestinations", "traits": { - "smithy.api#documentation": "

\n The choice of application destination that you specify.\n

", + "smithy.api#documentation": "

The choice of application destination that you specify.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n Object containing the choice of application destination that you specify.\n

" + "smithy.api#documentation": "

Object containing the choice of application destination that you specify.

" } }, "com.amazonaws.migrationhubstrategy#AwsManagedTargetDestination": { @@ -1306,30 +1556,30 @@ "speedOfMigration": { "target": "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger", "traits": { - "smithy.api#documentation": "

\n Business goal to achieve migration at a fast pace.\n

" + "smithy.api#documentation": "

Business goal to achieve migration at a fast pace.

" } }, "reduceOperationalOverheadWithManagedServices": { "target": "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger", "traits": { - "smithy.api#documentation": "

\n Business goal to reduce the operational overhead on the team by moving into managed services.\n

" + "smithy.api#documentation": "

Business goal to reduce the operational overhead on the team by moving into managed\n services.

" } }, "modernizeInfrastructureWithCloudNativeTechnologies": { "target": "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger", "traits": { - "smithy.api#documentation": "

\n Business goal to modernize infrastructure by moving to cloud native technologies.\n

" + "smithy.api#documentation": "

Business goal to modernize infrastructure by moving to cloud native technologies.

" } }, "licenseCostReduction": { "target": "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger", "traits": { - "smithy.api#documentation": "

\n Business goal to reduce license costs.\n

" + "smithy.api#documentation": "

Business goal to reduce license costs.

" } } }, "traits": { - "smithy.api#documentation": "

\n Business goals that you specify.\n

" + "smithy.api#documentation": "

Business goals that you specify.

" } }, "com.amazonaws.migrationhubstrategy#BusinessGoalsInteger": { @@ -1347,48 +1597,54 @@ "collectorId": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n The ID of the collector.\n

" + "smithy.api#documentation": "

The ID of the collector.

" } }, "ipAddress": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n IP address of the server that is hosting the collector.\n

" + "smithy.api#documentation": "

IP address of the server that is hosting the collector.

" } }, "hostName": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n Hostname of the server that is hosting the collector.\n

" + "smithy.api#documentation": "

Hostname of the server that is hosting the collector.

" } }, "collectorHealth": { "target": "com.amazonaws.migrationhubstrategy#CollectorHealth", "traits": { - "smithy.api#documentation": "

\n Indicates the health of a collector.\n

" + "smithy.api#documentation": "

Indicates the health of a collector.

" } }, "collectorVersion": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n Current version of the collector that is running in the environment that you specify.\n

" + "smithy.api#documentation": "

Current version of the collector that is running in the environment that you specify.\n

" } }, "registeredTimeStamp": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n Time when the collector registered with the service.\n

" + "smithy.api#documentation": "

Time when the collector registered with the service.

" } }, "lastActivityTimeStamp": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n Time when the collector last pinged the service.\n

" + "smithy.api#documentation": "

Time when the collector last pinged the service.

" + } + }, + "configurationSummary": { + "target": "com.amazonaws.migrationhubstrategy#ConfigurationSummary", + "traits": { + "smithy.api#documentation": "

Summary of the collector configuration.

" } } }, "traits": { - "smithy.api#documentation": "

\n Process data collector that runs in the environment that you specify.\n

" + "smithy.api#documentation": "

Process data collector that runs in the environment that you specify.

" } }, "com.amazonaws.migrationhubstrategy#CollectorHealth": { @@ -1412,6 +1668,67 @@ "target": "com.amazonaws.migrationhubstrategy#Collector" } }, + "com.amazonaws.migrationhubstrategy#Condition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "NOT_EQUALS", + "name": "NOT_EQUALS" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "NOT_CONTAINS", + "name": "NOT_CONTAINS" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#ConfigurationSummary": { + "type": "structure", + "members": { + "vcenterBasedRemoteInfoList": { + "target": "com.amazonaws.migrationhubstrategy#VcenterBasedRemoteInfoList", + "traits": { + "smithy.api#documentation": "

The list of vCenter configurations.

" + } + }, + "ipAddressBasedRemoteInfoList": { + "target": "com.amazonaws.migrationhubstrategy#IPAddressBasedRemoteInfoList", + "traits": { + "smithy.api#documentation": "

IP address based configurations.

" + } + }, + "versionControlInfoList": { + "target": "com.amazonaws.migrationhubstrategy#VersionControlInfoList", + "traits": { + "smithy.api#documentation": "

The list of the version control configurations.

" + } + }, + "pipelineInfoList": { + "target": "com.amazonaws.migrationhubstrategy#PipelineInfoList", + "traits": { + "smithy.api#documentation": "

The list of pipeline info configurations.

" + } + }, + "remoteSourceCodeAnalysisServerInfo": { + "target": "com.amazonaws.migrationhubstrategy#RemoteSourceCodeAnalysisServerInfo", + "traits": { + "smithy.api#documentation": "

Info about the remote server source code configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of the collector configuration.

" + } + }, "com.amazonaws.migrationhubstrategy#ConflictException": { "type": "structure", "members": { @@ -1423,7 +1740,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Exception to indicate that there is an ongoing task when a new task is created. \n Return when once the existing tasks are complete.\n

", + "smithy.api#documentation": "

Exception to indicate that there is an ongoing task when a new task is created. Return\n when once the existing tasks are complete.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1472,6 +1789,12 @@ "traits": { "smithy.api#documentation": "

The time the assessment completes.

" } + }, + "statusMessage": { + "target": "com.amazonaws.migrationhubstrategy#AssessmentStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message of the assessment.

" + } } }, "traits": { @@ -1499,12 +1822,12 @@ "secretName": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n AWS Secrets Manager key that holds the credentials that you use to connect to a database.\n

" + "smithy.api#documentation": "

AWS Secrets Manager key that holds the credentials that you use to connect to a database.\n

" } } }, "traits": { - "smithy.api#documentation": "

\n Configuration information used for assessing databases.\n

" + "smithy.api#documentation": "

Configuration information used for assessing databases.

" } }, "com.amazonaws.migrationhubstrategy#DatabaseManagementPreference": { @@ -1544,12 +1867,12 @@ "noPreference": { "target": "com.amazonaws.migrationhubstrategy#NoDatabaseMigrationPreference", "traits": { - "smithy.api#documentation": "

\n Indicated that you do not prefer heterogeneous or homogeneous.\n

" + "smithy.api#documentation": "

Indicated that you do not prefer heterogeneous or homogeneous.

" } } }, "traits": { - "smithy.api#documentation": "

\n Preferences for migrating a database to AWS.\n

" + "smithy.api#documentation": "

Preferences for migrating a database to AWS.

" } }, "com.amazonaws.migrationhubstrategy#DatabasePreferences": { @@ -1564,12 +1887,25 @@ "databaseMigrationPreference": { "target": "com.amazonaws.migrationhubstrategy#DatabaseMigrationPreference", "traits": { - "smithy.api#documentation": "

\n Specifies your preferred migration path.\n

" + "smithy.api#documentation": "

Specifies your preferred migration path.

" } } }, "traits": { - "smithy.api#documentation": "

\n Preferences on managing your databases on AWS.\n

" + "smithy.api#documentation": "

Preferences on managing your databases on AWS.

" + } + }, + "com.amazonaws.migrationhubstrategy#DependencyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.migrationhubstrategy#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Dependency encountered an error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 } }, "com.amazonaws.migrationhubstrategy#GetApplicationComponentDetails": { @@ -1665,9 +2001,9 @@ "traits": { "smithy.api#documentation": "

Retrieves a list of all the recommended strategies and tools for an application component\n running on a server.

", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/get-applicationcomponent-strategies/{applicationComponentId}", - "code": 200 + "uri": "/get-applicationcomponent-strategies/{applicationComponentId}" }, "smithy.api#readonly": {} } @@ -1755,6 +2091,12 @@ "traits": { "smithy.api#documentation": "

Detailed information about the assessment.

" } + }, + "assessmentTargets": { + "target": "com.amazonaws.migrationhubstrategy#AssessmentTargets", + "traits": { + "smithy.api#documentation": "

List of criteria for assessment.

" + } } } }, @@ -1799,7 +2141,7 @@ "id": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

The ID of the import file task. This ID is returned in the response of\n StartImportFileTask.

", + "smithy.api#documentation": "

The ID of the import file task. This ID is returned in the response of StartImportFileTask.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1863,16 +2205,63 @@ "smithy.api#documentation": "

The number of records successfully imported.

" } }, - "numberOfRecordsFailed": { - "target": "com.amazonaws.migrationhubstrategy#Integer", - "traits": { - "smithy.api#documentation": "

The number of records that failed to be imported.

" - } + "numberOfRecordsFailed": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "

The number of records that failed to be imported.

" + } + }, + "importName": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "

The name of the import task given in StartImportFileTask.

" + } + } + } + }, + "com.amazonaws.migrationhubstrategy#GetLatestAssessmentId": { + "type": "operation", + "input": { + "target": "com.amazonaws.migrationhubstrategy#GetLatestAssessmentIdRequest" + }, + "output": { + "target": "com.amazonaws.migrationhubstrategy#GetLatestAssessmentIdResponse" + }, + "errors": [ + { + "target": "com.amazonaws.migrationhubstrategy#AccessDeniedException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#DependencyException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#InternalServerException" + }, + { + "target": "com.amazonaws.migrationhubstrategy#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve the latest ID of a specific assessment task.

", + "smithy.api#http": { + "method": "GET", + "uri": "/get-latest-assessment-id", + "code": 200 }, - "importName": { - "target": "com.amazonaws.migrationhubstrategy#String", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.migrationhubstrategy#GetLatestAssessmentIdRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.migrationhubstrategy#GetLatestAssessmentIdResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.migrationhubstrategy#AsyncTaskId", "traits": { - "smithy.api#documentation": "

The name of the import task given in StartImportFileTask.

" + "smithy.api#documentation": "

The latest ID for the specific assessment task.

" } } } @@ -1933,6 +2322,12 @@ "traits": { "smithy.api#documentation": "

The transformation preferences for database applications.

" } + }, + "applicationMode": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationMode", + "traits": { + "smithy.api#documentation": "

The classification for application component types.

" + } } } }, @@ -2021,7 +2416,7 @@ "id": { "target": "com.amazonaws.migrationhubstrategy#RecommendationTaskId", "traits": { - "smithy.api#documentation": "

The recommendation report generation task id returned by \n StartRecommendationReportGeneration.

", + "smithy.api#documentation": "

The recommendation report generation task id returned by StartRecommendationReportGeneration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2080,8 +2475,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "associatedApplications", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "associatedApplications" }, "smithy.api#readonly": {} } @@ -2164,9 +2559,9 @@ "traits": { "smithy.api#documentation": "

Retrieves recommended strategies and tools for the specified server.

", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/get-server-strategies/{serverId}", - "code": 200 + "uri": "/get-server-strategies/{serverId}" }, "smithy.api#readonly": {} } @@ -2201,18 +2596,18 @@ "name": { "target": "com.amazonaws.migrationhubstrategy#GroupName", "traits": { - "smithy.api#documentation": "

\n The key of the specific import group.\n

" + "smithy.api#documentation": "

The key of the specific import group.

" } }, "value": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n The value of the specific import group.\n

" + "smithy.api#documentation": "

The value of the specific import group.

" } } }, "traits": { - "smithy.api#documentation": "

\n The object containing information about distinct imports or groups for Strategy Recommendations.\n

" + "smithy.api#documentation": "

The object containing information about distinct imports or groups for Strategy Recommendations.

" } }, "com.amazonaws.migrationhubstrategy#GroupIds": { @@ -2238,13 +2633,13 @@ "targetDatabaseEngine": { "target": "com.amazonaws.migrationhubstrategy#HeterogeneousTargetDatabaseEngines", "traits": { - "smithy.api#documentation": "

\n The target database engine for heterogeneous database migration preference.\n

", + "smithy.api#documentation": "

The target database engine for heterogeneous database migration preference.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n The object containing details about heterogeneous database preferences.\n

" + "smithy.api#documentation": "

The object containing details about heterogeneous database preferences.

" } }, "com.amazonaws.migrationhubstrategy#HeterogeneousTargetDatabaseEngine": { @@ -2312,12 +2707,12 @@ "targetDatabaseEngine": { "target": "com.amazonaws.migrationhubstrategy#HomogeneousTargetDatabaseEngines", "traits": { - "smithy.api#documentation": "

\n The target database engine for homogeneous database migration preferences.\n

" + "smithy.api#documentation": "

The target database engine for homogeneous database migration preferences.

" } } }, "traits": { - "smithy.api#documentation": "

\n The object containing details about homogeneous database preferences.\n

" + "smithy.api#documentation": "

The object containing details about homogeneous database preferences.

" } }, "com.amazonaws.migrationhubstrategy#HomogeneousTargetDatabaseEngine": { @@ -2353,6 +2748,38 @@ "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" } }, + "com.amazonaws.migrationhubstrategy#IPAddressBasedRemoteInfo": { + "type": "structure", + "members": { + "ipAddressConfigurationTimeStamp": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "

The time stamp of the configuration.

" + } + }, + "authType": { + "target": "com.amazonaws.migrationhubstrategy#AuthType", + "traits": { + "smithy.api#documentation": "

The type of authorization.

" + } + }, + "osType": { + "target": "com.amazonaws.migrationhubstrategy#OSType", + "traits": { + "smithy.api#documentation": "

The type of the operating system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

IP address based configurations.

" + } + }, + "com.amazonaws.migrationhubstrategy#IPAddressBasedRemoteInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#IPAddressBasedRemoteInfo" + } + }, "com.amazonaws.migrationhubstrategy#ImportFileTaskInformation": { "type": "structure", "members": { @@ -2395,7 +2822,7 @@ "statusReportS3Key": { "target": "com.amazonaws.migrationhubstrategy#importS3Key", "traits": { - "smithy.api#documentation": "

The Amazon S3 key name for status report of import task. The report contains details about\n whether each record imported successfully or why it did not.

" + "smithy.api#documentation": "

The Amazon S3 key name for status report of import task. The report contains details about\n whether each record imported successfully or why it did not.

" } }, "completionTime": { @@ -2471,12 +2898,12 @@ "traits": { "smithy.api#enum": [ { - "value": "excludeFromAssessment", - "name": "EXCLUDE_FROM_RECOMMENDATION" + "name": "EXCLUDE_FROM_RECOMMENDATION", + "value": "excludeFromAssessment" }, { - "value": "includeInAssessment", - "name": "INCLUDE_IN_RECOMMENDATION" + "name": "INCLUDE_IN_RECOMMENDATION", + "value": "includeInAssessment" } ] } @@ -2513,6 +2940,12 @@ "target": "com.amazonaws.migrationhubstrategy#AntipatternSeveritySummary" } }, + "com.amazonaws.migrationhubstrategy#ListApplicationComponentStatusSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationComponentStatusSummary" + } + }, "com.amazonaws.migrationhubstrategy#ListApplicationComponentSummary": { "type": "list", "member": { @@ -2551,8 +2984,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "applicationComponentInfos", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "applicationComponentInfos" } } }, @@ -2577,7 +3010,7 @@ "sort": { "target": "com.amazonaws.migrationhubstrategy#SortOrder", "traits": { - "smithy.api#documentation": "

Specifies whether to sort by ascending (ASC) or descending\n (DESC) order.

" + "smithy.api#documentation": "

Specifies whether to sort by ascending (ASC) or descending\n (DESC) order.

" } }, "groupIdFilter": { @@ -2649,8 +3082,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "Collectors", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "Collectors" }, "smithy.api#readonly": {} } @@ -2723,8 +3156,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "taskInfos", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "taskInfos" }, "smithy.api#readonly": {} } @@ -2771,6 +3204,12 @@ } } }, + "com.amazonaws.migrationhubstrategy#ListServerStatusSummary": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#ServerStatusSummary" + } + }, "com.amazonaws.migrationhubstrategy#ListServerSummary": { "type": "list", "member": { @@ -2809,8 +3248,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "serverInfos", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "serverInfos" } } }, @@ -2832,7 +3271,7 @@ "sort": { "target": "com.amazonaws.migrationhubstrategy#SortOrder", "traits": { - "smithy.api#documentation": "

Specifies whether to sort by ascending (ASC) or descending\n (DESC) order.

" + "smithy.api#documentation": "

Specifies whether to sort by ascending (ASC) or descending\n (DESC) order.

" } }, "groupIdFilter": { @@ -2904,24 +3343,24 @@ "awsManagedResources": { "target": "com.amazonaws.migrationhubstrategy#AwsManagedResources", "traits": { - "smithy.api#documentation": "

\n Indicates interest in solutions that are managed by AWS.\n

" + "smithy.api#documentation": "

Indicates interest in solutions that are managed by AWS.

" } }, "selfManageResources": { "target": "com.amazonaws.migrationhubstrategy#SelfManageResources", "traits": { - "smithy.api#documentation": "

\n Indicates interest in managing your own resources on AWS.\n

" + "smithy.api#documentation": "

Indicates interest in managing your own resources on AWS.

" } }, "noPreference": { "target": "com.amazonaws.migrationhubstrategy#NoManagementPreference", "traits": { - "smithy.api#documentation": "

\n No specific preference.\n

" + "smithy.api#documentation": "

No specific preference.

" } } }, "traits": { - "smithy.api#documentation": "

\n Preferences for migrating an application to AWS.\n

" + "smithy.api#documentation": "

Preferences for migrating an application to AWS.

" } }, "com.amazonaws.migrationhubstrategy#MaxResult": { @@ -2943,34 +3382,34 @@ "interfaceName": { "target": "com.amazonaws.migrationhubstrategy#InterfaceName", "traits": { - "smithy.api#documentation": "

\n Information about the name of the interface of the server for which the assessment was run.\n

", + "smithy.api#documentation": "

Information about the name of the interface of the server for which the assessment was\n run.

", "smithy.api#required": {} } }, "ipAddress": { "target": "com.amazonaws.migrationhubstrategy#IPAddress", "traits": { - "smithy.api#documentation": "

\n Information about the IP address of the server for which the assessment was run.\n

", + "smithy.api#documentation": "

Information about the IP address of the server for which the assessment was run.

", "smithy.api#required": {} } }, "macAddress": { "target": "com.amazonaws.migrationhubstrategy#MacAddress", "traits": { - "smithy.api#documentation": "

\n Information about the MAC address of the server for which the assessment was run.\n

", + "smithy.api#documentation": "

Information about the MAC address of the server for which the assessment was run.

", "smithy.api#required": {} } }, "netMask": { "target": "com.amazonaws.migrationhubstrategy#NetMask", "traits": { - "smithy.api#documentation": "

\n Information about the subnet mask of the server for which the assessment was run.\n

", + "smithy.api#documentation": "

Information about the subnet mask of the server for which the assessment was run.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n Information about the server's network for which the assessment was run.\n

" + "smithy.api#documentation": "

Information about the server's network for which the assessment was run.

" } }, "com.amazonaws.migrationhubstrategy#NetworkInfoList": { @@ -2995,7 +3434,7 @@ "targetDatabaseEngine": { "target": "com.amazonaws.migrationhubstrategy#TargetDatabaseEngines", "traits": { - "smithy.api#documentation": "

\n The target database engine for database migration preference that you specify.\n

", + "smithy.api#documentation": "

The target database engine for database migration preference that you specify.

", "smithy.api#required": {} } } @@ -3010,13 +3449,13 @@ "targetDestination": { "target": "com.amazonaws.migrationhubstrategy#NoPreferenceTargetDestinations", "traits": { - "smithy.api#documentation": "

\n The choice of application destination that you specify.\n

", + "smithy.api#documentation": "

The choice of application destination that you specify.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

\n Object containing the choice of application destination that you specify.\n

" + "smithy.api#documentation": "

Object containing the choice of application destination that you specify.

" } }, "com.amazonaws.migrationhubstrategy#NoPreferenceTargetDestination": { @@ -3068,18 +3507,18 @@ "type": { "target": "com.amazonaws.migrationhubstrategy#OSType", "traits": { - "smithy.api#documentation": "

\n Information about the type of operating system.\n

" + "smithy.api#documentation": "

Information about the type of operating system.

" } }, "version": { "target": "com.amazonaws.migrationhubstrategy#OSVersion", "traits": { - "smithy.api#documentation": "

\n Information about the version of operating system.\n

" + "smithy.api#documentation": "

Information about the version of operating system.

" } } }, "traits": { - "smithy.api#documentation": "

\n Information about the operating system.\n

" + "smithy.api#documentation": "

Information about the operating system.

" } }, "com.amazonaws.migrationhubstrategy#OSType": { @@ -3122,18 +3561,65 @@ ] } }, + "com.amazonaws.migrationhubstrategy#PipelineInfo": { + "type": "structure", + "members": { + "pipelineType": { + "target": "com.amazonaws.migrationhubstrategy#PipelineType", + "traits": { + "smithy.api#documentation": "

The type of pipeline.

" + } + }, + "pipelineConfigurationTimeStamp": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "

The time when the pipeline info was configured.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information of the pipeline.

" + } + }, + "com.amazonaws.migrationhubstrategy#PipelineInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#PipelineInfo" + } + }, + "com.amazonaws.migrationhubstrategy#PipelineType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AZURE_DEVOPS", + "name": "AZURE_DEVOPS" + } + ] + } + }, "com.amazonaws.migrationhubstrategy#PrioritizeBusinessGoals": { "type": "structure", "members": { "businessGoals": { "target": "com.amazonaws.migrationhubstrategy#BusinessGoals", "traits": { - "smithy.api#documentation": "

\n Rank of business goals based on priority.\n

" + "smithy.api#documentation": "

Rank of business goals based on priority.

" } } }, "traits": { - "smithy.api#documentation": "

\n Rank of business goals based on priority.\n

" + "smithy.api#documentation": "

Rank of business goals based on priority.

" + } + }, + "com.amazonaws.migrationhubstrategy#ProjectName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.migrationhubstrategy#PutPortfolioPreferences": { @@ -3190,6 +3676,12 @@ "traits": { "smithy.api#documentation": "

The transformation preferences for database applications.

" } + }, + "applicationMode": { + "target": "com.amazonaws.migrationhubstrategy#ApplicationMode", + "traits": { + "smithy.api#documentation": "

The classification for application component types.

" + } } } }, @@ -3203,42 +3695,42 @@ "status": { "target": "com.amazonaws.migrationhubstrategy#RecommendationReportStatus", "traits": { - "smithy.api#documentation": "

\n The status of the recommendation report generation task.\n

" + "smithy.api#documentation": "

The status of the recommendation report generation task.

" } }, "statusMessage": { "target": "com.amazonaws.migrationhubstrategy#RecommendationReportStatusMessage", "traits": { - "smithy.api#documentation": "

\n The status message for recommendation report generation.\n

" + "smithy.api#documentation": "

The status message for recommendation report generation.

" } }, "startTime": { "target": "com.amazonaws.migrationhubstrategy#RecommendationReportTimeStamp", "traits": { - "smithy.api#documentation": "

\n The time that the recommendation report generation task starts.\n

" + "smithy.api#documentation": "

The time that the recommendation report generation task starts.

" } }, "completionTime": { "target": "com.amazonaws.migrationhubstrategy#RecommendationReportTimeStamp", "traits": { - "smithy.api#documentation": "

\n The time that the recommendation report generation task completes.\n

" + "smithy.api#documentation": "

The time that the recommendation report generation task completes.

" } }, "s3Bucket": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n The S3 bucket where the report file is located.\n

" + "smithy.api#documentation": "

The S3 bucket where the report file is located.

" } }, "s3Keys": { "target": "com.amazonaws.migrationhubstrategy#S3Keys", "traits": { - "smithy.api#documentation": "

\n The Amazon S3 key name of the report file.\n

" + "smithy.api#documentation": "

The Amazon S3 key name of the report file.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains detailed information about a recommendation report.\n

" + "smithy.api#documentation": "

Contains detailed information about a recommendation report.

" } }, "com.amazonaws.migrationhubstrategy#RecommendationReportStatus": { @@ -3246,16 +3738,16 @@ "traits": { "smithy.api#enum": [ { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" }, { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" }, { - "value": "SUCCESS", - "name": "SUCCESS" + "name": "SUCCESS", + "value": "SUCCESS" } ] } @@ -3279,24 +3771,24 @@ "transformationTool": { "target": "com.amazonaws.migrationhubstrategy#TransformationTool", "traits": { - "smithy.api#documentation": "

\n The target destination for the recommendation set.\n

" + "smithy.api#documentation": "

The target destination for the recommendation set.

" } }, "targetDestination": { "target": "com.amazonaws.migrationhubstrategy#TargetDestination", "traits": { - "smithy.api#documentation": "

\n The recommended target destination.\n

" + "smithy.api#documentation": "

The recommended target destination.

" } }, "strategy": { "target": "com.amazonaws.migrationhubstrategy#Strategy", "traits": { - "smithy.api#documentation": "

\n The recommended strategy.\n

" + "smithy.api#documentation": "

The recommended strategy.

" } } }, "traits": { - "smithy.api#documentation": "

\n Contains a recommendation set.\n

" + "smithy.api#documentation": "

Contains a recommendation set.

" } }, "com.amazonaws.migrationhubstrategy#RecommendationTaskId": { @@ -3309,6 +3801,20 @@ "smithy.api#pattern": "[0-9a-z-:]+" } }, + "com.amazonaws.migrationhubstrategy#RemoteSourceCodeAnalysisServerInfo": { + "type": "structure", + "members": { + "remoteSourceCodeAnalysisServerConfigurationTimestamp": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "

The time when the remote source code server was configured.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the server configured for source code analysis.

" + } + }, "com.amazonaws.migrationhubstrategy#ResourceId": { "type": "string", "traits": { @@ -3359,32 +3865,55 @@ "traits": { "smithy.api#enum": [ { - "value": "dataCollectionTaskToBeScheduled", - "name": "DC_TO_BE_SCHEDULED" + "name": "DC_TO_BE_SCHEDULED", + "value": "dataCollectionTaskToBeScheduled" + }, + { + "name": "DC_REQ_SENT", + "value": "dataCollectionTaskScheduled" }, { - "value": "dataCollectionTaskScheduled", - "name": "DC_REQ_SENT" + "name": "DC_STARTED", + "value": "dataCollectionTaskStarted" }, { - "value": "dataCollectionTaskStarted", - "name": "DC_STARTED" + "name": "DC_STOPPED", + "value": "dataCollectionTaskStopped" }, { - "value": "dataCollectionTaskStopped", - "name": "DC_STOPPED" + "name": "DC_SUCCESS", + "value": "dataCollectionTaskSuccess" }, { - "value": "dataCollectionTaskSuccess", - "name": "DC_SUCCESS" + "name": "DC_FAILED", + "value": "dataCollectionTaskFailed" }, { - "value": "dataCollectionTaskFailed", - "name": "DC_FAILED" + "name": "DC_PARTIAL_SUCCESS", + "value": "dataCollectionTaskPartialSuccess" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#RuntimeAnalysisStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ANALYSIS_TO_BE_SCHEDULED", + "value": "ANALYSIS_TO_BE_SCHEDULED" }, { - "value": "dataCollectionTaskPartialSuccess", - "name": "DC_PARTIAL_SUCCESS" + "name": "ANALYSIS_STARTED", + "value": "ANALYSIS_STARTED" + }, + { + "name": "ANALYSIS_SUCCESS", + "value": "ANALYSIS_SUCCESS" + }, + { + "name": "ANALYSIS_FAILED", + "value": "ANALYSIS_FAILED" } ] } @@ -3519,6 +4048,14 @@ { "value": "SERVER_ID", "name": "SERVER_ID" + }, + { + "value": "ANALYSIS_STATUS", + "name": "ANALYSIS_STATUS" + }, + { + "value": "ERROR_CATEGORY", + "name": "ERROR_CATEGORY" } ] } @@ -3603,6 +4140,12 @@ "traits": { "smithy.api#documentation": "

The timestamp of when the server was assessed.

" } + }, + "serverError": { + "target": "com.amazonaws.migrationhubstrategy#ServerError", + "traits": { + "smithy.api#documentation": "

The error in server analysis.

" + } } }, "traits": { @@ -3615,6 +4158,47 @@ "target": "com.amazonaws.migrationhubstrategy#ServerDetail" } }, + "com.amazonaws.migrationhubstrategy#ServerError": { + "type": "structure", + "members": { + "serverErrorCategory": { + "target": "com.amazonaws.migrationhubstrategy#ServerErrorCategory", + "traits": { + "smithy.api#documentation": "

The error category of server analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The error in server analysis.

" + } + }, + "com.amazonaws.migrationhubstrategy#ServerErrorCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CONNECTIVITY_ERROR", + "value": "CONNECTIVITY_ERROR" + }, + { + "name": "CREDENTIAL_ERROR", + "value": "CREDENTIAL_ERROR" + }, + { + "name": "PERMISSION_ERROR", + "value": "PERMISSION_ERROR" + }, + { + "name": "ARCHITECTURE_ERROR", + "value": "ARCHITECTURE_ERROR" + }, + { + "name": "OTHER_ERROR", + "value": "OTHER_ERROR" + } + ] + } + }, "com.amazonaws.migrationhubstrategy#ServerId": { "type": "string", "traits": { @@ -3652,6 +4236,26 @@ ] } }, + "com.amazonaws.migrationhubstrategy#ServerStatusSummary": { + "type": "structure", + "members": { + "runTimeAssessmentStatus": { + "target": "com.amazonaws.migrationhubstrategy#RunTimeAssessmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the run time.

" + } + }, + "count": { + "target": "com.amazonaws.migrationhubstrategy#Integer", + "traits": { + "smithy.api#documentation": "

The number of servers successfully analyzed, partially successful or failed\n analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status summary of the server analysis.

" + } + }, "com.amazonaws.migrationhubstrategy#ServerStrategies": { "type": "list", "member": { @@ -3696,18 +4300,18 @@ "ServerOsType": { "target": "com.amazonaws.migrationhubstrategy#ServerOsType", "traits": { - "smithy.api#documentation": "

\n Type of operating system for the servers.\n

" + "smithy.api#documentation": "

Type of operating system for the servers.

" } }, "count": { "target": "com.amazonaws.migrationhubstrategy#Integer", "traits": { - "smithy.api#documentation": "

\n Number of servers.\n

" + "smithy.api#documentation": "

Number of servers.

" } } }, "traits": { - "smithy.api#documentation": "

\n Object containing details about the servers imported by Application Discovery Service\n

" + "smithy.api#documentation": "

Object containing details about the servers imported by Application Discovery Service

" } }, "com.amazonaws.migrationhubstrategy#ServiceLinkedRoleLockClientException": { @@ -3718,7 +4322,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Exception to indicate that the service-linked role (SLR) is locked.\n

", + "smithy.api#documentation": "

Exception to indicate that the service-linked role (SLR) is locked.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3779,24 +4383,30 @@ "versionControl": { "target": "com.amazonaws.migrationhubstrategy#VersionControl", "traits": { - "smithy.api#documentation": "

\n The type of repository to use for the source code.\n

" + "smithy.api#documentation": "

The type of repository to use for the source code.

" } }, "sourceVersion": { "target": "com.amazonaws.migrationhubstrategy#SourceVersion", "traits": { - "smithy.api#documentation": "

\n The branch of the source code.\n

" + "smithy.api#documentation": "

The branch of the source code.

" } }, "location": { "target": "com.amazonaws.migrationhubstrategy#Location", "traits": { - "smithy.api#documentation": "

\n The repository name for the source code.\n

" + "smithy.api#documentation": "

The repository name for the source code.

" + } + }, + "projectName": { + "target": "com.amazonaws.migrationhubstrategy#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project.

" } } }, "traits": { - "smithy.api#documentation": "

\n Object containing source code information that is linked to an application component.\n

" + "smithy.api#documentation": "

Object containing source code information that is linked to an application component.\n

" } }, "com.amazonaws.migrationhubstrategy#SourceCodeList": { @@ -3817,24 +4427,30 @@ "repository": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n The repository name for the source code.\n

" + "smithy.api#documentation": "

The repository name for the source code.

" } }, "branch": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n The branch of the source code.\n

" + "smithy.api#documentation": "

The branch of the source code.

" } }, "versionControlType": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n The type of repository to use for the source code.\n

" + "smithy.api#documentation": "

The type of repository to use for the source code.

" + } + }, + "projectName": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "

The name of the project.

" } } }, "traits": { - "smithy.api#documentation": "

\n Object containing source code information that is linked to an application component.\n

" + "smithy.api#documentation": "

Object containing source code information that is linked to an application component.\n

" } }, "com.amazonaws.migrationhubstrategy#SourceVersion": { @@ -3852,20 +4468,32 @@ "traits": { "smithy.api#enum": [ { - "value": "ANALYSIS_TO_BE_SCHEDULED", - "name": "ANALYSIS_TO_BE_SCHEDULED" + "name": "ANALYSIS_TO_BE_SCHEDULED", + "value": "ANALYSIS_TO_BE_SCHEDULED" + }, + { + "name": "ANALYSIS_STARTED", + "value": "ANALYSIS_STARTED" + }, + { + "name": "ANALYSIS_SUCCESS", + "value": "ANALYSIS_SUCCESS" + }, + { + "name": "ANALYSIS_FAILED", + "value": "ANALYSIS_FAILED" }, { - "value": "ANALYSIS_STARTED", - "name": "ANALYSIS_STARTED" + "name": "ANALYSIS_PARTIAL_SUCCESS", + "value": "ANALYSIS_PARTIAL_SUCCESS" }, { - "value": "ANALYSIS_SUCCESS", - "name": "ANALYSIS_SUCCESS" + "name": "UNCONFIGURED", + "value": "UNCONFIGURED" }, { - "value": "ANALYSIS_FAILED", - "name": "ANALYSIS_FAILED" + "name": "CONFIGURED", + "value": "CONFIGURED" } ] } @@ -3907,7 +4535,7 @@ "s3bucketForAnalysisData": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n The S3 bucket used by the collectors to send analysis data to the service.\n The bucket name must begin with migrationhub-strategy-.\n

", + "smithy.api#documentation": "

The S3 bucket used by the collectors to send analysis data to the service. The bucket\n name must begin with migrationhub-strategy-.

", "smithy.api#length": { "min": 0, "max": 63 @@ -3918,13 +4546,19 @@ "s3bucketForReportData": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n The S3 bucket where all the reports generated by the service are stored.\n The bucket name must begin with migrationhub-strategy-.\n

", + "smithy.api#documentation": "

The S3 bucket where all the reports generated by the service are stored. The bucket name\n must begin with migrationhub-strategy-.

", "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+" } + }, + "assessmentTargets": { + "target": "com.amazonaws.migrationhubstrategy#AssessmentTargets", + "traits": { + "smithy.api#documentation": "

List of criteria for assessment.

" + } } } }, @@ -3934,7 +4568,7 @@ "assessmentId": { "target": "com.amazonaws.migrationhubstrategy#AsyncTaskId", "traits": { - "smithy.api#documentation": "

\n The ID of the assessment.\n

" + "smithy.api#documentation": "

The ID of the assessment.

" } } } @@ -4078,7 +4712,7 @@ "outputFormat": { "target": "com.amazonaws.migrationhubstrategy#OutputFormat", "traits": { - "smithy.api#documentation": "

The output format for the recommendation report file. The default format is Microsoft Excel.

" + "smithy.api#documentation": "

The output format for the recommendation report file. The default format is Microsoft\n Excel.

" } }, "groupIdFilter": { @@ -4198,30 +4832,30 @@ "strategy": { "target": "com.amazonaws.migrationhubstrategy#Strategy", "traits": { - "smithy.api#documentation": "

\n Type of transformation. For example, Rehost, Replatform, and so on.\n

" + "smithy.api#documentation": "

Type of transformation. For example, Rehost, Replatform, and so on.

" } }, "toolName": { "target": "com.amazonaws.migrationhubstrategy#TransformationToolName", "traits": { - "smithy.api#documentation": "

\n The name of the tool that can be used to transform an application component using this strategy.\n

" + "smithy.api#documentation": "

The name of the tool that can be used to transform an application component using this\n strategy.

" } }, "targetDestination": { "target": "com.amazonaws.migrationhubstrategy#TargetDestination", "traits": { - "smithy.api#documentation": "

\n Destination information about where the application component can migrate to. For example, EC2, ECS, and so on.\n

" + "smithy.api#documentation": "

Destination information about where the application component can migrate to. For\n example, EC2, ECS, and so on.

" } }, "isPreferred": { "target": "com.amazonaws.migrationhubstrategy#Boolean", "traits": { - "smithy.api#documentation": "

\n Indicates if a specific strategy is preferred for the application component.\n

" + "smithy.api#documentation": "

Indicates if a specific strategy is preferred for the application component.

" } } }, "traits": { - "smithy.api#documentation": "

\n Information about all the available strategy options for migrating and modernizing an application component.\n

" + "smithy.api#documentation": "

Information about all the available strategy options for migrating and modernizing an\n application component.

" } }, "com.amazonaws.migrationhubstrategy#StrategyRecommendation": { @@ -4229,16 +4863,20 @@ "traits": { "smithy.api#enum": [ { - "value": "recommended", - "name": "RECOMMENDED" + "name": "RECOMMENDED", + "value": "recommended" + }, + { + "name": "VIABLE_OPTION", + "value": "viableOption" }, { - "value": "viableOption", - "name": "VIABLE_OPTION" + "name": "NOT_RECOMMENDED", + "value": "notRecommended" }, { - "value": "notRecommended", - "name": "NOT_RECOMMENDED" + "name": "POTENTIAL", + "value": "potential" } ] } @@ -4249,18 +4887,18 @@ "strategy": { "target": "com.amazonaws.migrationhubstrategy#Strategy", "traits": { - "smithy.api#documentation": "

\n The name of recommended strategy.\n

" + "smithy.api#documentation": "

The name of recommended strategy.

" } }, "count": { "target": "com.amazonaws.migrationhubstrategy#Integer", "traits": { - "smithy.api#documentation": "

\n The count of recommendations per strategy.\n

" + "smithy.api#documentation": "

The count of recommendations per strategy.

" } } }, "traits": { - "smithy.api#documentation": "

\n Object containing the summary of the strategy recommendations.\n

" + "smithy.api#documentation": "

Object containing the summary of the strategy recommendations.

" } }, "com.amazonaws.migrationhubstrategy#String": { @@ -4279,30 +4917,30 @@ "osInfo": { "target": "com.amazonaws.migrationhubstrategy#OSInfo", "traits": { - "smithy.api#documentation": "

\n Operating system corresponding to a server.\n

" + "smithy.api#documentation": "

Operating system corresponding to a server.

" } }, "fileSystemType": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n File system type for the server.\n

" + "smithy.api#documentation": "

File system type for the server.

" } }, "networkInfoList": { "target": "com.amazonaws.migrationhubstrategy#NetworkInfoList", "traits": { - "smithy.api#documentation": "

\n Networking information related to a server.\n

" + "smithy.api#documentation": "

Networking information related to a server.

" } }, "cpuArchitecture": { "target": "com.amazonaws.migrationhubstrategy#String", "traits": { - "smithy.api#documentation": "

\n CPU architecture type for the server.\n

" + "smithy.api#documentation": "

CPU architecture type for the server.

" } } }, "traits": { - "smithy.api#documentation": "

\n Information about the server that hosts application components.\n

" + "smithy.api#documentation": "

Information about the server that hosts application components.

" } }, "com.amazonaws.migrationhubstrategy#TargetDatabaseEngine": { @@ -4419,6 +5057,10 @@ { "value": "Amazon Relational Database Service", "name": "AMAZON_RDS" + }, + { + "value": "Babelfish for Aurora PostgreSQL", + "name": "BABELFISH_AURORA_POSTGRESQL" } ] } @@ -4465,24 +5107,24 @@ "name": { "target": "com.amazonaws.migrationhubstrategy#TransformationToolName", "traits": { - "smithy.api#documentation": "

\n Name of the tool. \n

" + "smithy.api#documentation": "

Name of the tool.

" } }, "description": { "target": "com.amazonaws.migrationhubstrategy#TranformationToolDescription", "traits": { - "smithy.api#documentation": "

\n Description of the tool.\n

" + "smithy.api#documentation": "

Description of the tool.

" } }, "tranformationToolInstallationLink": { "target": "com.amazonaws.migrationhubstrategy#TranformationToolInstallationLink", "traits": { - "smithy.api#documentation": "

\n URL for installing the tool.\n

" + "smithy.api#documentation": "

URL for installing the tool.

" } } }, "traits": { - "smithy.api#documentation": "

\n Information of the transformation tool that can be used to migrate and modernize the application.\n

" + "smithy.api#documentation": "

Information of the transformation tool that can be used to migrate and modernize the\n application.

" } }, "com.amazonaws.migrationhubstrategy#TransformationToolName": { @@ -4557,9 +5199,9 @@ "traits": { "smithy.api#documentation": "

Updates the configuration of an application component.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/update-applicationcomponent-config/", - "code": 200 + "uri": "/update-applicationcomponent-config/" } } }, @@ -4596,6 +5238,18 @@ "traits": { "smithy.api#documentation": "

Database credentials.

" } + }, + "configureOnly": { + "target": "com.amazonaws.migrationhubstrategy#Boolean", + "traits": { + "smithy.api#documentation": "

Update the configuration request of an application component. If it is set to true, the\n source code and/or database credentials are updated. If it is set to false, the source code\n and/or database credentials are updated and an analysis is initiated.

" + } + }, + "appType": { + "target": "com.amazonaws.migrationhubstrategy#AppType", + "traits": { + "smithy.api#documentation": "

The type of known component.

" + } } } }, @@ -4628,9 +5282,9 @@ "traits": { "smithy.api#documentation": "

Updates the configuration of the specified server.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/update-server-config/", - "code": 200 + "uri": "/update-server-config/" } } }, @@ -4669,6 +5323,32 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.migrationhubstrategy#VcenterBasedRemoteInfo": { + "type": "structure", + "members": { + "vcenterConfigurationTimeStamp": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "

The time when the remote server based on vCenter was last configured.

" + } + }, + "osType": { + "target": "com.amazonaws.migrationhubstrategy#OSType", + "traits": { + "smithy.api#documentation": "

The type of the operating system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the server in vCenter.

" + } + }, + "com.amazonaws.migrationhubstrategy#VcenterBasedRemoteInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#VcenterBasedRemoteInfo" + } + }, "com.amazonaws.migrationhubstrategy#VersionControl": { "type": "string", "traits": { @@ -4680,6 +5360,55 @@ { "value": "GITHUB_ENTERPRISE", "name": "GITHUB_ENTERPRISE" + }, + { + "value": "AZURE_DEVOPS_GIT", + "name": "AZURE_DEVOPS_GIT" + } + ] + } + }, + "com.amazonaws.migrationhubstrategy#VersionControlInfo": { + "type": "structure", + "members": { + "versionControlType": { + "target": "com.amazonaws.migrationhubstrategy#VersionControlType", + "traits": { + "smithy.api#documentation": "

The type of version control.

" + } + }, + "versionControlConfigurationTimeStamp": { + "target": "com.amazonaws.migrationhubstrategy#String", + "traits": { + "smithy.api#documentation": "

The time when the version control system was last configured.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the version control configuration.

" + } + }, + "com.amazonaws.migrationhubstrategy#VersionControlInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.migrationhubstrategy#VersionControlInfo" + } + }, + "com.amazonaws.migrationhubstrategy#VersionControlType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GITHUB", + "name": "GITHUB" + }, + { + "value": "GITHUB_ENTERPRISE", + "name": "GITHUB_ENTERPRISE" + }, + { + "value": "AZURE_DEVOPS_GIT", + "name": "AZURE_DEVOPS_GIT" } ] } diff --git a/codegen/sdk-codegen/aws-models/networkmanager.2019-07-05.json b/codegen/sdk-codegen/aws-models/networkmanager.2019-07-05.json index 753fa33a364..8d5363c2412 100644 --- a/codegen/sdk-codegen/aws-models/networkmanager.2019-07-05.json +++ b/codegen/sdk-codegen/aws-models/networkmanager.2019-07-05.json @@ -619,69 +619,91 @@ } }, "com.amazonaws.networkmanager#AttachmentState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REJECTED", - "name": "REJECTED" - }, - { - "value": "PENDING_ATTACHMENT_ACCEPTANCE", - "name": "PENDING_ATTACHMENT_ACCEPTANCE" - }, - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "PENDING_NETWORK_UPDATE", - "name": "PENDING_NETWORK_UPDATE" - }, - { - "value": "PENDING_TAG_ACCEPTANCE", - "name": "PENDING_TAG_ACCEPTANCE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "PENDING_ATTACHMENT_ACCEPTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ATTACHMENT_ACCEPTANCE" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "PENDING_NETWORK_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_NETWORK_UPDATE" + } + }, + "PENDING_TAG_ACCEPTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_TAG_ACCEPTANCE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + } } }, "com.amazonaws.networkmanager#AttachmentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONNECT", - "name": "CONNECT" - }, - { - "value": "SITE_TO_SITE_VPN", - "name": "SITE_TO_SITE_VPN" - }, - { - "value": "VPC", - "name": "VPC" - }, - { - "value": "TRANSIT_GATEWAY_ROUTE_TABLE", - "name": "TRANSIT_GATEWAY_ROUTE_TABLE" + "type": "enum", + "members": { + "CONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECT" + } + }, + "SITE_TO_SITE_VPN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SITE_TO_SITE_VPN" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" } - ] + }, + "TRANSIT_GATEWAY_ROUTE_TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ROUTE_TABLE" + } + } } }, "com.amazonaws.networkmanager#Bandwidth": { @@ -725,119 +747,155 @@ } }, "com.amazonaws.networkmanager#ChangeAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ADD", - "name": "ADD" - }, - { - "value": "MODIFY", - "name": "MODIFY" - }, - { - "value": "REMOVE", - "name": "REMOVE" + "type": "enum", + "members": { + "ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD" + } + }, + "MODIFY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFY" } - ] + }, + "REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE" + } + } } }, "com.amazonaws.networkmanager#ChangeSetState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_GENERATION", - "name": "PENDING_GENERATION" - }, - { - "value": "FAILED_GENERATION", - "name": "FAILED_GENERATION" - }, - { - "value": "READY_TO_EXECUTE", - "name": "READY_TO_EXECUTE" - }, - { - "value": "EXECUTING", - "name": "EXECUTING" - }, - { - "value": "EXECUTION_SUCCEEDED", - "name": "EXECUTION_SUCCEEDED" - }, - { - "value": "OUT_OF_DATE", - "name": "OUT_OF_DATE" + "type": "enum", + "members": { + "PENDING_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_GENERATION" + } + }, + "FAILED_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_GENERATION" + } + }, + "READY_TO_EXECUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY_TO_EXECUTE" + } + }, + "EXECUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTING" } - ] + }, + "EXECUTION_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION_SUCCEEDED" + } + }, + "OUT_OF_DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUT_OF_DATE" + } + } } }, "com.amazonaws.networkmanager#ChangeStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NOT_STARTED", - "name": "NOT_STARTED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "COMPLETE", - "name": "COMPLETE" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STARTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.networkmanager#ChangeType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CORE_NETWORK_SEGMENT", - "name": "CORE_NETWORK_SEGMENT" - }, - { - "value": "CORE_NETWORK_EDGE", - "name": "CORE_NETWORK_EDGE" - }, - { - "value": "ATTACHMENT_MAPPING", - "name": "ATTACHMENT_MAPPING" - }, - { - "value": "ATTACHMENT_ROUTE_PROPAGATION", - "name": "ATTACHMENT_ROUTE_PROPAGATION" - }, - { - "value": "ATTACHMENT_ROUTE_STATIC", - "name": "ATTACHMENT_ROUTE_STATIC" - }, - { - "value": "CORE_NETWORK_CONFIGURATION", - "name": "CORE_NETWORK_CONFIGURATION" - }, - { - "value": "SEGMENTS_CONFIGURATION", - "name": "SEGMENTS_CONFIGURATION" - }, - { - "value": "SEGMENT_ACTIONS_CONFIGURATION", - "name": "SEGMENT_ACTIONS_CONFIGURATION" - }, - { - "value": "ATTACHMENT_POLICIES_CONFIGURATION", - "name": "ATTACHMENT_POLICIES_CONFIGURATION" + "type": "enum", + "members": { + "CORE_NETWORK_SEGMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORE_NETWORK_SEGMENT" + } + }, + "CORE_NETWORK_EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORE_NETWORK_EDGE" + } + }, + "ATTACHMENT_MAPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_MAPPING" + } + }, + "ATTACHMENT_ROUTE_PROPAGATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_ROUTE_PROPAGATION" + } + }, + "ATTACHMENT_ROUTE_STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_ROUTE_STATIC" + } + }, + "CORE_NETWORK_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORE_NETWORK_CONFIGURATION" + } + }, + "SEGMENTS_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEGMENTS_CONFIGURATION" + } + }, + "SEGMENT_ACTIONS_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEGMENT_ACTIONS_CONFIGURATION" } - ] + }, + "ATTACHMENT_POLICIES_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_POLICIES_CONFIGURATION" + } + } } }, "com.amazonaws.networkmanager#ClientToken": { @@ -1021,26 +1079,32 @@ } }, "com.amazonaws.networkmanager#ConnectPeerAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } } }, "com.amazonaws.networkmanager#ConnectPeerBgpConfiguration": { @@ -1136,26 +1200,32 @@ } }, "com.amazonaws.networkmanager#ConnectPeerState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } } }, "com.amazonaws.networkmanager#ConnectPeerSummary": { @@ -1347,56 +1417,66 @@ } }, "com.amazonaws.networkmanager#ConnectionState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#ConnectionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UP", - "name": "UP" - }, - { - "value": "DOWN", - "name": "DOWN" + "type": "enum", + "members": { + "UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UP" } - ] + }, + "DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOWN" + } + } } }, "com.amazonaws.networkmanager#ConnectionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BGP", - "name": "BGP" - }, - { - "value": "IPSEC", - "name": "IPSEC" + "type": "enum", + "members": { + "BGP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BGP" } - ] + }, + "IPSEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPSEC" + } + } } }, "com.amazonaws.networkmanager#ConstrainedString": { @@ -1768,18 +1848,20 @@ } }, "com.amazonaws.networkmanager#CoreNetworkPolicyAlias": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LIVE", - "name": "LIVE" - }, - { - "value": "LATEST", - "name": "LATEST" + "type": "enum", + "members": { + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + }, + "LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST" } - ] + } } }, "com.amazonaws.networkmanager#CoreNetworkPolicyDocument": { @@ -1957,26 +2039,32 @@ } }, "com.amazonaws.networkmanager#CoreNetworkState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" } - ] + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } } }, "com.amazonaws.networkmanager#CoreNetworkSummary": { @@ -3176,26 +3264,32 @@ } }, "com.amazonaws.networkmanager#CustomerGatewayAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" } - ] + } } }, "com.amazonaws.networkmanager#DateTime": { @@ -4179,26 +4273,32 @@ } }, "com.amazonaws.networkmanager#DeviceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#DisassociateConnectPeer": { @@ -6944,28 +7044,34 @@ "member": { "target": "com.amazonaws.networkmanager#GlobalNetwork" } - }, - "com.amazonaws.networkmanager#GlobalNetworkState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + }, + "com.amazonaws.networkmanager#GlobalNetworkState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" } - ] + } } }, "com.amazonaws.networkmanager#IPAddress": { @@ -7127,26 +7233,32 @@ } }, "com.amazonaws.networkmanager#LinkAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" } - ] + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } } }, "com.amazonaws.networkmanager#LinkId": { @@ -7172,26 +7284,32 @@ } }, "com.amazonaws.networkmanager#LinkState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#ListAttachments": { @@ -8266,8 +8384,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-west-2" + "signingRegion": "us-west-2", + "signingName": "networkmanager" } ] }, @@ -8326,8 +8444,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-west-2" + "signingRegion": "us-west-2", + "signingName": "networkmanager" } ] }, @@ -8386,8 +8504,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-west-2" + "signingRegion": "us-west-2", + "signingName": "networkmanager" } ] }, @@ -8412,8 +8530,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-west-2" + "signingRegion": "us-west-2", + "signingName": "networkmanager" } ] }, @@ -8509,8 +8627,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-gov-west-1" + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" } ] }, @@ -8569,8 +8687,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-gov-west-1" + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" } ] }, @@ -8629,8 +8747,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-gov-west-1" + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" } ] }, @@ -8655,8 +8773,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-gov-west-1" + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" } ] }, @@ -8874,8 +8992,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-west-2" + "signingRegion": "us-west-2", + "signingName": "networkmanager" } ] }, @@ -8901,8 +9019,8 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "networkmanager", - "signingRegion": "us-gov-west-1" + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" } ] }, @@ -8934,9 +9052,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", + "signingRegion": "us-west-2", "signingName": "networkmanager", - "signingRegion": "us-west-2" + "name": "sigv4" } ] }, @@ -8944,9 +9062,9 @@ } }, "params": { + "UseFIPS": false, "Region": "aws-global", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -8956,9 +9074,9 @@ "properties": { "authSchemes": [ { - "name": "sigv4", + "signingRegion": "us-gov-west-1", "signingName": "networkmanager", - "signingRegion": "us-gov-west-1" + "name": "sigv4" } ] }, @@ -8966,9 +9084,9 @@ } }, "params": { + "UseFIPS": false, "Region": "aws-us-gov-global", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -8979,9 +9097,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -8991,9 +9109,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseFIPS": true, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -9003,9 +9121,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, "Endpoint": "https://example.com" } } @@ -9515,37 +9633,43 @@ } }, "com.amazonaws.networkmanager#PeeringState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + } } }, "com.amazonaws.networkmanager#PeeringType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSIT_GATEWAY", - "name": "TRANSIT_GATEWAY" + "type": "enum", + "members": { + "TRANSIT_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY" } - ] + } } }, "com.amazonaws.networkmanager#ProposedSegmentChange": { @@ -10130,69 +10254,91 @@ } }, "com.amazonaws.networkmanager#RouteAnalysisCompletionReasonCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND", - "name": "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND" - }, - { - "value": "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY", - "name": "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY" - }, - { - "value": "CYCLIC_PATH_DETECTED", - "name": "CYCLIC_PATH_DETECTED" - }, - { - "value": "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND", - "name": "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND" - }, - { - "value": "ROUTE_NOT_FOUND", - "name": "ROUTE_NOT_FOUND" - }, - { - "value": "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND", - "name": "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND" - }, - { - "value": "INACTIVE_ROUTE_FOR_DESTINATION_FOUND", - "name": "INACTIVE_ROUTE_FOR_DESTINATION_FOUND" - }, - { - "value": "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH", - "name": "TRANSIT_GATEWAY_ATTACHMENT" - }, - { - "value": "MAX_HOPS_EXCEEDED", - "name": "MAX_HOPS_EXCEEDED" - }, - { - "value": "POSSIBLE_MIDDLEBOX", - "name": "POSSIBLE_MIDDLEBOX" - }, - { - "value": "NO_DESTINATION_ARN_PROVIDED", - "name": "NO_DESTINATION_ARN_PROVIDED" + "type": "enum", + "members": { + "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND" + } + }, + "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY" + } + }, + "CYCLIC_PATH_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CYCLIC_PATH_DETECTED" + } + }, + "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND" + } + }, + "ROUTE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUTE_NOT_FOUND" + } + }, + "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND" + } + }, + "INACTIVE_ROUTE_FOR_DESTINATION_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE_ROUTE_FOR_DESTINATION_FOUND" } - ] + }, + "TRANSIT_GATEWAY_ATTACHMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH" + } + }, + "MAX_HOPS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_HOPS_EXCEEDED" + } + }, + "POSSIBLE_MIDDLEBOX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSSIBLE_MIDDLEBOX" + } + }, + "NO_DESTINATION_ARN_PROVIDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_DESTINATION_ARN_PROVIDED" + } + } } }, "com.amazonaws.networkmanager#RouteAnalysisCompletionResultCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONNECTED", - "name": "CONNECTED" - }, - { - "value": "NOT_CONNECTED", - "name": "NOT_CONNECTED" + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED" + } + }, + "NOT_CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONNECTED" } - ] + } } }, "com.amazonaws.networkmanager#RouteAnalysisEndpointOptions": { @@ -10262,37 +10408,43 @@ } }, "com.amazonaws.networkmanager#RouteAnalysisStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RUNNING", - "name": "running" - }, - { - "value": "COMPLETED", - "name": "completed" - }, - { - "value": "FAILED", - "name": "failed" + "type": "enum", + "members": { + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.networkmanager#RouteState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "BLACKHOLE", - "name": "BLACKHOLE" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" } - ] + }, + "BLACKHOLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLACKHOLE" + } + } } }, "com.amazonaws.networkmanager#RouteStateList": { @@ -10322,33 +10474,37 @@ } }, "com.amazonaws.networkmanager#RouteTableType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSIT_GATEWAY_ROUTE_TABLE", - "name": "TRANSIT_GATEWAY_ROUTE_TABLE" - }, - { - "value": "CORE_NETWORK_SEGMENT", - "name": "CORE_NETWORK_SEGMENT" + "type": "enum", + "members": { + "TRANSIT_GATEWAY_ROUTE_TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ROUTE_TABLE" + } + }, + "CORE_NETWORK_SEGMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORE_NETWORK_SEGMENT" } - ] + } } }, "com.amazonaws.networkmanager#RouteType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROPAGATED", - "name": "PROPAGATED" - }, - { - "value": "STATIC", - "name": "STATIC" + "type": "enum", + "members": { + "PROPAGATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROPAGATED" + } + }, + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" } - ] + } } }, "com.amazonaws.networkmanager#RouteTypeList": { @@ -10508,26 +10664,32 @@ } }, "com.amazonaws.networkmanager#SiteState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" } - ] + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#SiteToSiteVpnAttachment": { @@ -10579,7 +10741,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables for the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

", + "smithy.api#documentation": "

Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

", "smithy.api#http": { "method": "POST", "uri": "/organizations/service-access", @@ -10973,26 +11135,32 @@ } }, "com.amazonaws.networkmanager#TransitGatewayConnectPeerAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } } }, "com.amazonaws.networkmanager#TransitGatewayPeering": { @@ -11064,30 +11232,38 @@ } }, "com.amazonaws.networkmanager#TransitGatewayRegistrationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" - }, - { - "value": "FAILED", - "name": "failed" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.networkmanager#TransitGatewayRegistrationStateReason": { @@ -11144,14 +11320,14 @@ } }, "com.amazonaws.networkmanager#TunnelProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GRE", - "name": "GRE" + "type": "enum", + "members": { + "GRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRE" } - ] + } } }, "com.amazonaws.networkmanager#UntagResource": { @@ -11946,26 +12122,32 @@ } }, "com.amazonaws.networkmanager#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UnknownOperation", - "name": "UNKNOWN_OPERATION" - }, - { - "value": "CannotParse", - "name": "CANNOT_PARSE" - }, - { - "value": "FieldValidationFailed", - "name": "FIELD_VALIDATION_FAILED" - }, - { - "value": "Other", - "name": "OTHER" + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FieldValidationFailed" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Other" } - ] + } } }, "com.amazonaws.networkmanager#VpcArn": { @@ -12013,6 +12195,13 @@ "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether IPv6 is supported.

" } + }, + "ApplianceModeSupport": { + "target": "com.amazonaws.networkmanager#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/nimble.2020-08-01.json b/codegen/sdk-codegen/aws-models/nimble.2020-08-01.json index 27f6191f8c4..3e5f6e91b6a 100644 --- a/codegen/sdk-codegen/aws-models/nimble.2020-08-01.json +++ b/codegen/sdk-codegen/aws-models/nimble.2020-08-01.json @@ -48,7 +48,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -109,7 +109,7 @@ } }, "traits": { - "smithy.api#documentation": "

You are not authorized to perform this operation. Check your IAM policies, and ensure\n that you are using the correct access keys.

", + "smithy.api#documentation": "

You are not authorized to perform this operation. Check your IAM\n policies, and ensure that you are using the correct access keys.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -180,7 +180,7 @@ "directoryId": { "target": "com.amazonaws.nimble#DirectoryId", "traits": { - "smithy.api#documentation": "

The directory ID of the Directory Service for Microsoft Active Directory to access\n using this studio component.

" + "smithy.api#documentation": "

The directory ID of the Directory Service for Microsoft Active Directory to access using this studio\n component.

" } }, "organizationalUnitDistinguishedName": { @@ -191,7 +191,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for a Microsoft Active Directory (Microsoft AD) studio\n resource.

" + "smithy.api#documentation": "

The configuration for a Directory Service for Microsoft Active Directory studio resource.

" } }, "com.amazonaws.nimble#ActiveDirectoryDnsIpAddress": { @@ -219,6 +219,23 @@ } } }, + "com.amazonaws.nimble#AutomaticTerminationMode": { + "type": "enum", + "members": { + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + }, + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + } + } + }, "com.amazonaws.nimble#ClientToken": { "type": "string", "traits": { @@ -337,7 +354,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -397,7 +414,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } } }, @@ -483,7 +500,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -521,7 +538,7 @@ "target": "com.amazonaws.nimble#Tags", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } } }, @@ -592,7 +609,7 @@ "nimble:GetLaunchProfile", "nimble:ListEulaAcceptances" ], - "smithy.api#documentation": "

Creates a streaming session in a studio.

\n

After invoking this operation, you must poll GetStreamingSession until the streaming\n session is in state READY.

", + "smithy.api#documentation": "

Creates a streaming session in a studio.

\n

After invoking this operation, you must poll GetStreamingSession until the streaming\n session is in the READY state.

", "smithy.api#http": { "method": "POST", "uri": "/2020-08-01/studios/{studioId}/streaming-sessions", @@ -606,7 +623,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -620,7 +637,8 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The launch profile ID.

" + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", + "smithy.api#required": {} } }, "ownedBy": { @@ -646,7 +664,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } } }, @@ -709,7 +727,7 @@ "aws.iam#conditionKeys": [ "nimble:requesterPrincipalId" ], - "smithy.api#documentation": "

Creates a streaming session stream for a streaming session.

\n

After invoking this API, invoke GetStreamingSessionStream with the returned streamId\n to poll the resource until it is in state READY.

", + "smithy.api#documentation": "

Creates a streaming session stream for a streaming session.

\n

After invoking this API, invoke GetStreamingSessionStream with the returned streamId\n to poll the resource until it is in the READY state.

", "smithy.api#http": { "method": "POST", "uri": "/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/streams", @@ -724,7 +742,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -732,7 +750,7 @@ "expirationInSeconds": { "target": "com.amazonaws.nimble#StreamingSessionStreamExpirationInSeconds", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 120, "smithy.api#documentation": "

The expiration time in seconds.

" } }, @@ -817,7 +835,7 @@ "sso:CreateManagedApplicationInstance", "iam:PassRole" ], - "smithy.api#documentation": "

Create a new Studio.

\n

When creating a Studio, two IAM roles must be provided: the admin role and the user\n Role. These roles are assumed by your users when they log in to the Nimble Studio\n portal.

\n

The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for\n the portal to function properly.

\n

The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached\n for the portal to function properly.

\n

You may optionally specify a KMS key in the StudioEncryptionConfiguration.

\n

In Nimble Studio, resource names, descriptions, initialization scripts, and other\n data you provide are always encrypted at rest using an KMS key. By default, this key is\n owned by Amazon Web Services and managed on your behalf. You may provide your own KMS\n key when calling CreateStudio to encrypt this data using a key you own and\n manage.

\n

When providing an KMS key during studio creation, Nimble Studio creates KMS\n grants in your account to provide your studio user and admin roles access to these KMS\n keys.

\n

If you delete this grant, the studio will no longer be accessible to your portal\n users.

\n

If you delete the studio KMS key, your studio will no longer be accessible.

", + "smithy.api#documentation": "

Create a new studio.

\n

When creating a studio, two IAM roles must be provided: the admin role\n and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.

\n

The user role must have the AmazonNimbleStudio-StudioUser managed policy\n attached for the portal to function properly.

\n

The admin role must have the AmazonNimbleStudio-StudioAdmin managed\n policy attached for the portal to function properly.

\n

You may optionally specify a KMS key in the\n StudioEncryptionConfiguration.

\n

In Nimble Studio, resource names, descriptions, initialization scripts, and other\n data you provide are always encrypted at rest using an KMS key. By default, this key is\n owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key\n when calling CreateStudio to encrypt this data using a key you own and\n manage.

\n

When providing an KMS key during studio creation, Nimble Studio creates KMS\n grants in your account to provide your studio user and admin roles access to these KMS\n keys.

\n

If you delete this grant, the studio will no longer be accessible to your portal\n users.

\n

If you delete the studio KMS key, your studio will no longer be accessible.

", "smithy.api#http": { "method": "POST", "uri": "/2020-08-01/studios", @@ -883,7 +901,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -945,7 +963,7 @@ "target": "com.amazonaws.nimble#Tags", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } }, "type": { @@ -959,14 +977,14 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.

" + "smithy.api#documentation": "

An IAM role attached to Studio Component when the system initialization\n script runs which give the studio component access to Amazon Web Services resources when\n the system initialization script runs.

" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.

" + "smithy.api#documentation": "

An IAM role attached to a Studio Component that gives the studio\n component access to Amazon Web Services resources at anytime while the instance is\n running.

" } } }, @@ -999,7 +1017,7 @@ "adminRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role that Studio Admins will assume when logging in to the Nimble Studio\n portal.

", + "smithy.api#documentation": "

The IAM role that studio admins will assume when logging in to the\n Nimble Studio portal.

", "smithy.api#required": {} } }, @@ -1007,7 +1025,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1037,14 +1055,14 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } }, "userRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.

", + "smithy.api#documentation": "

The IAM role that studio users will assume when logging in to the\n Nimble Studio portal.

", "smithy.api#required": {} } } @@ -1157,7 +1175,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1165,7 +1183,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1205,7 +1223,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1213,7 +1231,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1300,7 +1318,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1379,7 +1397,7 @@ "aws.iam#requiredActions": [ "ec2:DeleteNetworkInterface" ], - "smithy.api#documentation": "

Deletes streaming session resource.

\n

After invoking this operation, use GetStreamingSession to poll the resource until it\n transitions to a DELETED state.

\n

A streaming session will count against your streaming session quota until it is marked\n DELETED.

", + "smithy.api#documentation": "

Deletes streaming session resource.

\n

After invoking this operation, use GetStreamingSession to poll the resource until it\n transitions to a DELETED state.

\n

A streaming session will count against your streaming session quota until it is marked\n DELETED.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}", @@ -1394,7 +1412,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1528,7 +1546,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1616,7 +1634,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1655,7 +1673,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1724,7 +1742,7 @@ "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was created.

" } }, "eulaId": { @@ -1742,7 +1760,7 @@ "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was updated.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was updated.

" } } }, @@ -1756,7 +1774,7 @@ "acceptedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the EULA was accepted.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the EULA was accepted.

" } }, "acceptedBy": { @@ -1905,7 +1923,7 @@ "target": "com.amazonaws.nimble#String" }, "traits": { - "smithy.api#documentation": "

ExceptionContext is a set of key-value pairs that provide you with more information\n about the error that occurred. For example, when the service returns a 404\n ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the\n value of resource that was not found.

\n

ExceptionContext enables scripts and other programmatic clients to provide for better\n error handling.

" + "smithy.api#documentation": "

ExceptionContext is a set of key-value pairs that provide you with more information\n about the error that occurred. For example, when the service returns a 404\n ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the\n value of resource that was not found.

\n

\n ExceptionContext allows scripts and other programmatic clients to provide\n better error handling.

" } }, "com.amazonaws.nimble#GetEula": { @@ -1941,7 +1959,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get a EULA", - "smithy.api#documentation": "

Get Eula.

", + "smithy.api#documentation": "

Get EULA.

", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/eulas/{eulaId}", @@ -2136,7 +2154,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2233,7 +2251,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2257,7 +2275,7 @@ "platform": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The platform where this Launch Profile will be used, either WINDOWS or LINUX.

", + "smithy.api#documentation": "

The platform where this Launch Profile will be used, either Windows or Linux.

", "smithy.api#httpQuery": "platform", "smithy.api#required": {} } @@ -2337,7 +2355,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2383,7 +2401,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2697,6 +2715,86 @@ } } }, + "com.amazonaws.nimble#GetStreamingSessionBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.nimble#GetStreamingSessionBackupRequest" + }, + "output": { + "target": "com.amazonaws.nimble#GetStreamingSessionBackupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.nimble#AccessDeniedException" + }, + { + "target": "com.amazonaws.nimble#ConflictException" + }, + { + "target": "com.amazonaws.nimble#InternalServerErrorException" + }, + { + "target": "com.amazonaws.nimble#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.nimble#ThrottlingException" + }, + { + "target": "com.amazonaws.nimble#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get a streaming session backup", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], + "smithy.api#documentation": "

Gets StreamingSessionBackup resource.

\n

Invoke this operation to poll for a streaming session backup while stopping a\n streaming session.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-08-01/studios/{studioId}/streaming-session-backups/{backupId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.nimble#GetStreamingSessionBackupRequest": { + "type": "structure", + "members": { + "backupId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The ID of the backup.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "studioId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The studio ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.nimble#GetStreamingSessionBackupResponse": { + "type": "structure", + "members": { + "streamingSessionBackup": { + "target": "com.amazonaws.nimble#StreamingSessionBackup", + "traits": { + "smithy.api#documentation": "

Information about the streaming session backup.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.nimble#GetStreamingSessionRequest": { "type": "structure", "members": { @@ -2771,7 +2869,7 @@ "aws.iam#conditionKeys": [ "nimble:requesterPrincipalId" ], - "smithy.api#documentation": "

Gets a StreamingSessionStream for a streaming session.

\n

Invoke this operation to poll the resource after invoking\n CreateStreamingSessionStream.

\n

After the StreamingSessionStream changes to the state READY, the url property will\n contain a stream to be used with the DCV streaming client.

", + "smithy.api#documentation": "

Gets a StreamingSessionStream for a streaming session.

\n

Invoke this operation to poll the resource after invoking\n CreateStreamingSessionStream.

\n

After the StreamingSessionStream changes to the READY state,\n the url property will contain a stream to be used with the DCV streaming client.

", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/streams/{streamId}", @@ -2888,7 +2986,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get a studio", - "smithy.api#documentation": "

Get a Studio resource.

", + "smithy.api#documentation": "

Get a studio resource.

", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios/{studioId}", @@ -3252,14 +3350,14 @@ "target": "com.amazonaws.nimble#String", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The ARN of the resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.

" } }, "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was created.

" } }, "createdBy": { @@ -3286,7 +3384,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#LaunchProfileId", "traits": { - "smithy.api#documentation": "

The launch profile ID.

" + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

" } }, "launchProfileProtocolVersions": { @@ -3342,14 +3440,14 @@ "target": "com.amazonaws.nimble#Tags", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } }, "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was updated.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was updated.

" } }, "updatedBy": { @@ -3368,7 +3466,7 @@ } }, "traits": { - "smithy.api#documentation": "

A launch profile controls your artist workforce’s access to studio components, like\n compute farms, shared file systems, managed file systems, and license server\n configurations, as well as instance types and Amazon Machine Images (AMIs).

\n\n

Studio administrators create launch profiles in the Nimble Studio console.\n Artists can use their launch profiles to launch an instance from the Nimble Studio\n portal. Each user’s launch profile defines how they can launch a streaming session. By\n default, studio admins can use all launch profiles.

" + "smithy.api#documentation": "

A launch profile controls your artist workforce’s access to studio components, like\n compute farms, shared file systems, managed file systems, and license server\n configurations, as well as instance types and Amazon Machine Images (AMIs).

\n

Studio administrators create launch profiles in the Nimble Studio console.\n Artists can use their launch profiles to launch an instance from the Nimble Studio\n portal. Each user’s launch profile defines how they can launch a streaming session. By\n default, studio admins can use all launch profiles.

" } }, "com.amazonaws.nimble#LaunchProfileDescription": { @@ -3398,7 +3496,7 @@ "activeDirectory": { "target": "com.amazonaws.nimble#LaunchProfileInitializationActiveDirectory", "traits": { - "smithy.api#documentation": "

A LaunchProfileInitializationActiveDirectory resource.

" + "smithy.api#documentation": "

A LaunchProfileInitializationActiveDirectory resource.

" } }, "ec2SecurityGroupIds": { @@ -3410,7 +3508,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#LaunchProfileId", "traits": { - "smithy.api#documentation": "

The launch profile ID.

" + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

" } }, "launchProfileProtocolVersion": { @@ -3434,7 +3532,7 @@ "platform": { "target": "com.amazonaws.nimble#LaunchProfilePlatform", "traits": { - "smithy.api#documentation": "

The platform of the launch platform, either WINDOWS or LINUX.

" + "smithy.api#documentation": "

The platform of the launch platform, either Windows or Linux.

" } }, "systemInitializationScripts": { @@ -3451,7 +3549,7 @@ } }, "traits": { - "smithy.api#documentation": "

A Launch Profile Initialization contains information required for a workstation or\n server to connect to a launch profile.

\n

This includes scripts, endpoints, security groups, subnets, and other\n configuration.

" + "smithy.api#documentation": "

A launch profile initialization contains information required for a workstation or\n server to connect to a launch profile.

\n

This includes scripts, endpoints, security groups, subnets, and other\n configuration.

" } }, "com.amazonaws.nimble#LaunchProfileInitializationActiveDirectory": { @@ -3466,7 +3564,7 @@ "directoryId": { "target": "com.amazonaws.nimble#DirectoryId", "traits": { - "smithy.api#documentation": "

The directory ID of the Directory Service for Microsoft Active Directory to access\n using this launch profile.

" + "smithy.api#documentation": "

The directory ID of the Directory Service for Microsoft Active Directory to access using this launch\n profile.

" } }, "directoryName": { @@ -3501,7 +3599,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Launch Profile Initialization Active Directory contains information required for\n the launch profile to connect to the Active Directory.

" + "smithy.api#documentation": "

The launch profile initialization Active Directory contains information required for\n the launch profile to connect to the Active Directory.

" } }, "com.amazonaws.nimble#LaunchProfileInitializationScript": { @@ -3528,18 +3626,18 @@ "secureInitializationRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.

" + "smithy.api#documentation": "

An IAM role attached to Studio Component when the system initialization\n script runs which give the studio component access to Amazon Web Services resources when\n the system initialization script runs.

" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "

An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.

" + "smithy.api#documentation": "

An IAM role attached to a Studio Component that gives the studio\n component access to Amazon Web Services resources at anytime while the instance is\n running.

" } } }, "traits": { - "smithy.api#documentation": "

The Launch Profile Initialization Script is used when start streaming session\n runs.

" + "smithy.api#documentation": "

The launch profile initialization script is used when start streaming session\n runs.

" } }, "com.amazonaws.nimble#LaunchProfileInitializationScriptList": { @@ -3583,7 +3681,7 @@ } }, "traits": { - "smithy.api#documentation": "

Launch profile membership enables your studio admins to delegate launch profile access\n to other studio users in the Nimble Studio portal without needing to write or\n maintain complex IAM policies. A launch profile member is a user association from your\n studio identity source who is granted permissions to a launch profile.

\n

A launch profile member (type USER) provides the following permissions to that launch\n profile:

\n
    \n
  • \n

    GetLaunchProfile

    \n
    • \n
  • \n

    GetLaunchProfileInitialization

    \n
    • \n
  • \n

    GetLaunchProfileMembers

    \n
    • \n
  • \n

    GetLaunchProfileMember

    \n
    • \n
  • \n

    CreateStreamingSession

    \n
    • \n
  • \n

    GetLaunchProfileDetails

    \n
    • \n
" + "smithy.api#documentation": "

Studio admins can use launch profile membership to delegate launch profile access to\n studio users in the Nimble Studio portal without writing or maintaining complex\n IAM policies. A launch profile member is a user association from your\n studio identity source who is granted permissions to a launch profile.

\n

A launch profile member (type USER) provides the following permissions to that launch\n profile:

\n
    \n
  • \n

    GetLaunchProfile

    \n
    • \n
  • \n

    GetLaunchProfileInitialization

    \n
    • \n
  • \n

    GetLaunchProfileMembers

    \n
    • \n
  • \n

    GetLaunchProfileMember

    \n
    • \n
  • \n

    CreateStreamingSession

    \n
    • \n
  • \n

    GetLaunchProfileDetails

    \n
    • \n
" } }, "com.amazonaws.nimble#LaunchProfileMembershipList": { @@ -3609,29 +3707,31 @@ } }, "com.amazonaws.nimble#LaunchProfilePersona": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "USER", - "name": "USER" + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" } - ] + } } }, "com.amazonaws.nimble#LaunchProfilePlatform": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LINUX", - "name": "LINUX" - }, - { - "value": "WINDOWS", - "name": "WINDOWS" + "type": "enum", + "members": { + "LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX" } - ] + }, + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" + } + } } }, "com.amazonaws.nimble#LaunchProfileProtocolVersion": { @@ -3734,42 +3834,56 @@ } }, "com.amazonaws.nimble#LaunchProfileState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - ] + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } } }, "com.amazonaws.nimble#LaunchProfileStateList": { @@ -3779,70 +3893,98 @@ } }, "com.amazonaws.nimble#LaunchProfileStatusCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LAUNCH_PROFILE_CREATED", - "name": "LAUNCH_PROFILE_CREATED" - }, - { - "value": "LAUNCH_PROFILE_UPDATED", - "name": "LAUNCH_PROFILE_UPDATED" - }, - { - "value": "LAUNCH_PROFILE_DELETED", - "name": "LAUNCH_PROFILE_DELETED" - }, - { - "value": "LAUNCH_PROFILE_CREATE_IN_PROGRESS", - "name": "LAUNCH_PROFILE_CREATE_IN_PROGRESS" - }, - { - "value": "LAUNCH_PROFILE_UPDATE_IN_PROGRESS", - "name": "LAUNCH_PROFILE_UPDATE_IN_PROGRESS" - }, - { - "value": "LAUNCH_PROFILE_DELETE_IN_PROGRESS", - "name": "LAUNCH_PROFILE_DELETE_IN_PROGRESS" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "STREAMING_IMAGE_NOT_FOUND", - "name": "STREAMING_IMAGE_NOT_FOUND" - }, - { - "value": "STREAMING_IMAGE_NOT_READY", - "name": "STREAMING_IMAGE_NOT_READY" - }, - { - "value": "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED", - "name": "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED" - }, - { - "value": "ENCRYPTION_KEY_ACCESS_DENIED", - "name": "ENCRYPTION_KEY_ACCESS_DENIED" - }, - { - "value": "ENCRYPTION_KEY_NOT_FOUND", - "name": "ENCRYPTION_KEY_NOT_FOUND" - }, - { - "value": "INVALID_SUBNETS_PROVIDED", - "name": "INVALID_SUBNETS_PROVIDED" - }, - { - "value": "INVALID_INSTANCE_TYPES_PROVIDED", - "name": "INVALID_INSTANCE_TYPES_PROVIDED" - }, - { - "value": "INVALID_SUBNETS_COMBINATION", - "name": "INVALID_SUBNETS_COMBINATION" + "type": "enum", + "members": { + "LAUNCH_PROFILE_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAUNCH_PROFILE_CREATED" } - ] + }, + "LAUNCH_PROFILE_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAUNCH_PROFILE_UPDATED" + } + }, + "LAUNCH_PROFILE_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAUNCH_PROFILE_DELETED" + } + }, + "LAUNCH_PROFILE_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAUNCH_PROFILE_CREATE_IN_PROGRESS" + } + }, + "LAUNCH_PROFILE_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAUNCH_PROFILE_UPDATE_IN_PROGRESS" + } + }, + "LAUNCH_PROFILE_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAUNCH_PROFILE_DELETE_IN_PROGRESS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "STREAMING_IMAGE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_NOT_FOUND" + } + }, + "STREAMING_IMAGE_NOT_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_NOT_READY" + } + }, + "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED" + } + }, + "ENCRYPTION_KEY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_ACCESS_DENIED" + } + }, + "ENCRYPTION_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_NOT_FOUND" + } + }, + "INVALID_SUBNETS_PROVIDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SUBNETS_PROVIDED" + } + }, + "INVALID_INSTANCE_TYPES_PROVIDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_INSTANCE_TYPES_PROVIDED" + } + }, + "INVALID_SUBNETS_COMBINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SUBNETS_COMBINATION" + } + } } }, "com.amazonaws.nimble#LaunchProfileStudioComponentIdList": { @@ -3858,99 +4000,129 @@ } }, "com.amazonaws.nimble#LaunchProfileValidationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VALIDATION_NOT_STARTED", - "name": "VALIDATION_NOT_STARTED" - }, - { - "value": "VALIDATION_IN_PROGRESS", - "name": "VALIDATION_IN_PROGRESS" - }, - { - "value": "VALIDATION_SUCCESS", - "name": "VALIDATION_SUCCESS" - }, - { - "value": "VALIDATION_FAILED", - "name": "VALIDATION_FAILED" - }, - { - "value": "VALIDATION_FAILED_INTERNAL_SERVER_ERROR", - "name": "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" + "type": "enum", + "members": { + "VALIDATION_NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_NOT_STARTED" } - ] + }, + "VALIDATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_IN_PROGRESS" + } + }, + "VALIDATION_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_SUCCESS" + } + }, + "VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED" + } + }, + "VALIDATION_FAILED_INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" + } + } } }, "com.amazonaws.nimble#LaunchProfileValidationStatusCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VALIDATION_NOT_STARTED", - "name": "VALIDATION_NOT_STARTED" - }, - { - "value": "VALIDATION_IN_PROGRESS", - "name": "VALIDATION_IN_PROGRESS" - }, - { - "value": "VALIDATION_SUCCESS", - "name": "VALIDATION_SUCCESS" - }, - { - "value": "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION", - "name": "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION" - }, - { - "value": "VALIDATION_FAILED_SUBNET_NOT_FOUND", - "name": "VALIDATION_FAILED_SUBNET_NOT_FOUND" - }, - { - "value": "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION", - "name": "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION" - }, - { - "value": "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY", - "name": "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY" - }, - { - "value": "VALIDATION_FAILED_UNAUTHORIZED", - "name": "VALIDATION_FAILED_UNAUTHORIZED" - }, - { - "value": "VALIDATION_FAILED_INTERNAL_SERVER_ERROR", - "name": "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" + "type": "enum", + "members": { + "VALIDATION_NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_NOT_STARTED" } - ] + }, + "VALIDATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_IN_PROGRESS" + } + }, + "VALIDATION_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_SUCCESS" + } + }, + "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION" + } + }, + "VALIDATION_FAILED_SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED_SUBNET_NOT_FOUND" + } + }, + "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION" + } + }, + "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY" + } + }, + "VALIDATION_FAILED_UNAUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED_UNAUTHORIZED" + } + }, + "VALIDATION_FAILED_INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_FAILED_INTERNAL_SERVER_ERROR" + } + } } }, "com.amazonaws.nimble#LaunchProfileValidationStatusMessage": { "type": "string" }, "com.amazonaws.nimble#LaunchProfileValidationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT", - "name": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT" - }, - { - "value": "VALIDATE_SUBNET_ASSOCIATION", - "name": "VALIDATE_SUBNET_ASSOCIATION" - }, - { - "value": "VALIDATE_NETWORK_ACL_ASSOCIATION", - "name": "VALIDATE_NETWORK_ACL_ASSOCIATION" - }, - { - "value": "VALIDATE_SECURITY_GROUP_ASSOCIATION", - "name": "VALIDATE_SECURITY_GROUP_ASSOCIATION" + "type": "enum", + "members": { + "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT" } - ] + }, + "VALIDATE_SUBNET_ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATE_SUBNET_ASSOCIATION" + } + }, + "VALIDATE_NETWORK_ACL_ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATE_NETWORK_ACL_ASSOCIATION" + } + }, + "VALIDATE_SECURITY_GROUP_ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATE_SECURITY_GROUP_ASSOCIATION" + } + } } }, "com.amazonaws.nimble#LaunchPurpose": { @@ -4022,7 +4194,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list EULA acceptances", - "smithy.api#documentation": "

List Eula Acceptances.

", + "smithy.api#documentation": "

List EULA acceptances.

", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios/{studioId}/eula-acceptances", @@ -4049,7 +4221,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4119,7 +4291,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list EULAs", - "smithy.api#documentation": "

List Eulas.

", + "smithy.api#documentation": "

List EULAs.

", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/eulas", @@ -4146,7 +4318,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } } @@ -4229,7 +4401,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4237,7 +4409,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#documentation": "

The max number of results to return in the response.

", "smithy.api#httpQuery": "maxResults" } @@ -4245,7 +4417,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4340,7 +4512,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#documentation": "

The max number of results to return in the response.

", "smithy.api#httpQuery": "maxResults" } @@ -4348,7 +4520,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4452,7 +4624,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4496,6 +4668,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.nimble#ListStreamingSessionBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.nimble#ListStreamingSessionBackupsRequest" + }, + "output": { + "target": "com.amazonaws.nimble#ListStreamingSessionBackupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.nimble#AccessDeniedException" + }, + { + "target": "com.amazonaws.nimble#ConflictException" + }, + { + "target": "com.amazonaws.nimble#InternalServerErrorException" + }, + { + "target": "com.amazonaws.nimble#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.nimble#ThrottlingException" + }, + { + "target": "com.amazonaws.nimble#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list streaming session backups", + "aws.iam#conditionKeys": [ + "nimble:ownedBy", + "nimble:requesterPrincipalId" + ], + "smithy.api#documentation": "

Lists the backups of a streaming session in a studio.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-08-01/studios/{studioId}/streaming-session-backups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "streamingSessionBackups" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.nimble#ListStreamingSessionBackupsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "ownedBy": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The user ID of the user that owns the streaming session.

", + "smithy.api#httpQuery": "ownedBy" + } + }, + "studioId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The studio ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.nimble#ListStreamingSessionBackupsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "streamingSessionBackups": { + "target": "com.amazonaws.nimble#StreamingSessionBackupList", + "traits": { + "smithy.api#documentation": "

Information about the streaming session backups.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.nimble#ListStreamingSessions": { "type": "operation", "input": { @@ -4561,7 +4831,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4645,7 +4915,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list studio components", - "smithy.api#documentation": "

Lists the StudioComponents in a studio.

", + "smithy.api#documentation": "

Lists the StudioComponents in a studio.

", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios/{studioId}/studio-components", @@ -4666,7 +4936,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#documentation": "

The max number of results to return in the response.

", "smithy.api#httpQuery": "maxResults" } @@ -4674,7 +4944,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4779,7 +5049,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#documentation": "

The max number of results to return in the response.

", "smithy.api#httpQuery": "maxResults" } @@ -4787,7 +5057,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4857,7 +5127,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list studios", - "smithy.api#documentation": "

List studios in your Amazon Web Services account in the requested Amazon Web Services\n Region.

", + "smithy.api#documentation": "

List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.

", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios", @@ -4877,7 +5147,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

", + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", "smithy.api#httpQuery": "nextToken" } } @@ -5003,7 +5273,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } } }, @@ -5014,7 +5284,7 @@ "com.amazonaws.nimble#MaxResults": { "type": "integer", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#range": { "min": 1, "max": 100 @@ -5139,7 +5409,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5154,7 +5424,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5236,7 +5506,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5350,7 +5620,7 @@ } }, "traits": { - "smithy.api#documentation": "

A parameter for a studio component script, in the form of a key:value pair.

" + "smithy.api#documentation": "

A parameter for a studio component script, in the form of a key-value pair.

" } }, "com.amazonaws.nimble#ScriptParameterValue": { @@ -5395,11 +5665,45 @@ } }, "traits": { - "smithy.api#documentation": "

Your current quota does not allow you to perform the request action. You can request\n increases for some quotas, and other quotas cannot be increased.

\n

Please use AWS Service Quotas to request an increase.

", + "smithy.api#documentation": "

Your current quota does not allow you to perform the request action. You can request\n increases for some quotas, and other quotas cannot be increased.

\n

Please use Amazon Web Services Service Quotas to request an increase.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, + "com.amazonaws.nimble#SessionBackupMode": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + } + } + }, + "com.amazonaws.nimble#SessionPersistenceMode": { + "type": "enum", + "members": { + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + }, + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + } + } + }, "com.amazonaws.nimble#SharedFileSystemConfiguration": { "type": "structure", "members": { @@ -5478,7 +5782,7 @@ "nimble:GetLaunchProfile", "nimble:GetLaunchProfileMember" ], - "smithy.api#documentation": "

Transitions sessions from the STOPPED state into the READY state. The\n START_IN_PROGRESS state is the intermediate state between the STOPPED and READY\n states.

", + "smithy.api#documentation": "

Transitions sessions from the STOPPED state into the READY\n state. The START_IN_PROGRESS state is the intermediate state between the\n STOPPED and READY states.

", "smithy.api#http": { "method": "POST", "uri": "/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/start", @@ -5493,7 +5797,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5501,7 +5805,7 @@ "sessionId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The streaming session ID for the StartStreamingSessionRequest.

", + "smithy.api#documentation": "

The streaming session ID for the StartStreamingSessionRequest.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5513,6 +5817,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "backupId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The ID of the backup.

" + } } }, "traits": { @@ -5567,7 +5877,7 @@ "sso:CreateManagedApplicationInstance", "sso:GetManagedApplicationInstance" ], - "smithy.api#documentation": "

Repairs the IAM Identity Center configuration for a given studio.

\n

If the studio has a valid IAM Identity Center configuration currently associated with\n it, this operation will fail with a validation error.

\n

If the studio does not have a valid IAM Identity Center configuration currently\n associated with it, then a new IAM Identity Center application is created for the studio\n and the studio is changed to the READY state.

\n

After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

", + "smithy.api#documentation": "

Repairs the IAM Identity Center configuration for a given studio.

\n

If the studio has a valid IAM Identity Center configuration currently associated with\n it, this operation will fail with a validation error.

\n

If the studio does not have a valid IAM Identity Center configuration currently\n associated with it, then a new IAM Identity Center application is created for the studio\n and the studio is changed to the READY state.

\n

After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-08-01/studios/{studioId}/sso-configuration", @@ -5582,7 +5892,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5654,7 +5964,7 @@ "aws.iam#requiredActions": [ "nimble:GetLaunchProfile" ], - "smithy.api#documentation": "

Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS\n state is the intermediate state between the READY and STOPPED states.

", + "smithy.api#documentation": "

Transitions sessions from the READY state into the STOPPED\n state. The STOP_IN_PROGRESS state is the intermediate state between the\n READY and STOPPED states.

", "smithy.api#http": { "method": "POST", "uri": "/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/stop", @@ -5669,7 +5979,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5677,7 +5987,7 @@ "sessionId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The streaming session ID for the StopStreamingSessionRequest.

", + "smithy.api#documentation": "

The streaming session ID for the StopStreamingSessionRequest.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5689,6 +5999,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "volumeRetentionMode": { + "target": "com.amazonaws.nimble#VolumeRetentionMode", + "traits": { + "smithy.api#documentation": "

Adds additional instructions to a streaming session stop action to either retain the\n EBS volumes or delete the EBS volumes.

" + } } }, "traits": { @@ -5712,7 +6028,7 @@ "clipboardMode": { "target": "com.amazonaws.nimble#StreamingClipboardMode", "traits": { - "smithy.api#documentation": "

Enable or disable the use of the system clipboard to copy and paste between the\n streaming session and streaming client.

", + "smithy.api#documentation": "

Allows or deactivates the use of the system clipboard to copy and paste between the\n streaming session and streaming client.

", "smithy.api#required": {} } }, @@ -5726,7 +6042,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 690, "smithy.api#documentation": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

" } }, @@ -5741,13 +6057,37 @@ "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

\n

If the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).

" + "smithy.api#documentation": "

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is\n 5760.

\n

This field is allowed only when sessionPersistenceMode is\n ACTIVATED and automaticTerminationMode is\n ACTIVATED.

\n

If the value is set to 0, your sessions can’t be STOPPED. If you then\n call StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes\n value, the session will automatically be terminated (instead of\n STOPPED).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state.\n If the time that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).

" } }, "sessionStorage": { "target": "com.amazonaws.nimble#StreamConfigurationSessionStorage", "traits": { - "smithy.api#documentation": "

(Optional) The upload storage for a streaming session.

" + "smithy.api#documentation": "

The upload storage for a streaming session.

" + } + }, + "sessionBackup": { + "target": "com.amazonaws.nimble#StreamConfigurationSessionBackup", + "traits": { + "smithy.api#documentation": "

Information about the streaming session backup.

" + } + }, + "sessionPersistenceMode": { + "target": "com.amazonaws.nimble#SessionPersistenceMode", + "traits": { + "smithy.api#documentation": "

Determine if a streaming session created from this launch profile can configure\n persistent storage. This means that volumeConfiguration and\n automaticTerminationMode are configured.

" + } + }, + "volumeConfiguration": { + "target": "com.amazonaws.nimble#VolumeConfiguration", + "traits": { + "smithy.api#documentation": "

Custom volume configuration for the root volumes that are attached to streaming\n sessions.

\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.

" + } + }, + "automaticTerminationMode": { + "target": "com.amazonaws.nimble#AutomaticTerminationMode", + "traits": { + "smithy.api#documentation": "

Indicates if a streaming session created from this launch profile should be terminated\n automatically or retained without termination after being in a STOPPED\n state.

\n
    \n
  • \n

    When ACTIVATED, the streaming session is scheduled for\n termination after being in the STOPPED state for the time specified\n in maxStoppedSessionLengthInMinutes.

    \n
    • \n
  • \n

    When DEACTIVATED, the streaming session can remain in the\n STOPPED state indefinitely.

    \n
    • \n
\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED. When allowed, the default value for this parameter is\n DEACTIVATED.

" } } }, @@ -5761,7 +6101,7 @@ "clipboardMode": { "target": "com.amazonaws.nimble#StreamingClipboardMode", "traits": { - "smithy.api#documentation": "

Enable or disable the use of the system clipboard to copy and paste between the\n streaming session and streaming client.

", + "smithy.api#documentation": "

Allows or deactivates the use of the system clipboard to copy and paste between the\n streaming session and streaming client.

", "smithy.api#required": {} } }, @@ -5775,7 +6115,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 690, "smithy.api#documentation": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

" } }, @@ -5790,13 +6130,37 @@ "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

\n

If the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).

" + "smithy.api#documentation": "

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is\n 5760.

\n

This field is allowed only when sessionPersistenceMode is\n ACTIVATED and automaticTerminationMode is\n ACTIVATED.

\n

If the value is set to 0, your sessions can’t be STOPPED. If you then\n call StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes\n value, the session will automatically be terminated (instead of\n STOPPED).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state.\n If the time that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).

" } }, "sessionStorage": { "target": "com.amazonaws.nimble#StreamConfigurationSessionStorage", "traits": { - "smithy.api#documentation": "

(Optional) The upload storage for a streaming workstation that is created using this\n launch profile.

" + "smithy.api#documentation": "

The upload storage for a streaming workstation that is created using this launch\n profile.

" + } + }, + "sessionBackup": { + "target": "com.amazonaws.nimble#StreamConfigurationSessionBackup", + "traits": { + "smithy.api#documentation": "

Configures how streaming sessions are backed up when launched from this launch\n profile.

" + } + }, + "sessionPersistenceMode": { + "target": "com.amazonaws.nimble#SessionPersistenceMode", + "traits": { + "smithy.api#documentation": "

Determine if a streaming session created from this launch profile can configure\n persistent storage. This means that volumeConfiguration and\n automaticTerminationMode are configured.

" + } + }, + "volumeConfiguration": { + "target": "com.amazonaws.nimble#VolumeConfiguration", + "traits": { + "smithy.api#documentation": "

Custom volume configuration for the root volumes that are attached to streaming\n sessions.

\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.

" + } + }, + "automaticTerminationMode": { + "target": "com.amazonaws.nimble#AutomaticTerminationMode", + "traits": { + "smithy.api#documentation": "

Indicates if a streaming session created from this launch profile should be terminated\n automatically or retained without termination after being in a STOPPED\n state.

\n
    \n
  • \n

    When ACTIVATED, the streaming session is scheduled for\n termination after being in the STOPPED state for the time specified\n in maxStoppedSessionLengthInMinutes.

    \n
    • \n
  • \n

    When DEACTIVATED, the streaming session can remain in the\n STOPPED state indefinitely.

    \n
    • \n
\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED. When allowed, the default value for this parameter is\n DEACTIVATED.

" } } }, @@ -5804,10 +6168,20 @@ "smithy.api#documentation": "

Configuration for streaming workstations created using this launch profile.

" } }, - "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes": { + "com.amazonaws.nimble#StreamConfigurationMaxBackupsToRetain": { "type": "integer", "traits": { "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes": { + "type": "integer", + "traits": { + "smithy.api#default": 690, "smithy.api#range": { "min": 1, "max": 43200 @@ -5824,6 +6198,27 @@ } } }, + "com.amazonaws.nimble#StreamConfigurationSessionBackup": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.nimble#SessionBackupMode", + "traits": { + "smithy.api#documentation": "

Specifies how artists sessions are backed up.

\n

Configures backups for streaming sessions launched with this launch profile. The\n default value is DEACTIVATED, which means that backups are deactivated. To\n allow backups, set this value to AUTOMATIC.

" + } + }, + "maxBackupsToRetain": { + "target": "com.amazonaws.nimble#StreamConfigurationMaxBackupsToRetain", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of backups that each streaming session created from this launch\n profile can have.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures how streaming sessions are backed up when launched from this launch\n profile.

" + } + }, "com.amazonaws.nimble#StreamConfigurationSessionStorage": { "type": "structure", "members": { @@ -5846,18 +6241,20 @@ } }, "com.amazonaws.nimble#StreamingClipboardMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" } - ] + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } } }, "com.amazonaws.nimble#StreamingImage": { @@ -5867,7 +6264,7 @@ "target": "com.amazonaws.nimble#String", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The ARN of the resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.

" } }, "description": { @@ -5909,14 +6306,14 @@ "target": "com.amazonaws.nimble#StreamingImageOwner", "traits": { "aws.cloudformation#cfnMutability": "read", - "smithy.api#documentation": "

The owner of the streaming image, either the studioId that contains the streaming\n image, or 'amazon' for images that are provided by Amazon Nimble Studio.

" + "smithy.api#documentation": "

The owner of the streaming image, either the studioId that contains the\n streaming image, or amazon for images that are provided by Amazon Nimble Studio.

" } }, "platform": { "target": "com.amazonaws.nimble#StreamingImagePlatform", "traits": { "aws.cloudformation#cfnMutability": "read", - "smithy.api#documentation": "

The platform of the streaming image, either WINDOWS or LINUX.

" + "smithy.api#documentation": "

The platform of the streaming image, either Windows or Linux.

" } }, "state": { @@ -5950,12 +6347,12 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } } }, "traits": { - "smithy.api#documentation": "

Represents a streaming image resource.

\n

Streaming images are used by studio users to select which operating system and\n software they want to use in a Nimble Studio streaming session.

\n

Amazon provides a number of streaming images that include popular 3rd-party\n software.

\n

You can create your own streaming images using an Amazon Elastic Compute Cloud (Amazon\n EC2) machine image that you create for this purpose. You can also include software that\n your users require.

" + "smithy.api#documentation": "

Represents a streaming image resource.

\n

Streaming images are used by studio users to select which operating system and\n software they want to use in a Nimble Studio streaming session.

\n

Amazon provides a number of streaming images that include popular 3rd-party\n software.

\n

You can create your own streaming images using an Amazon EC2 machine image\n that you create for this purpose. You can also include software that your users\n require.

" } }, "com.amazonaws.nimble#StreamingImageDescription": { @@ -6000,14 +6397,14 @@ } }, "com.amazonaws.nimble#StreamingImageEncryptionConfigurationKeyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CUSTOMER_MANAGED_KEY", - "name": "CUSTOMER_MANAGED_KEY" + "type": "enum", + "members": { + "CUSTOMER_MANAGED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" } - ] + } } }, "com.amazonaws.nimble#StreamingImageId": { @@ -6053,13 +6450,13 @@ "com.amazonaws.nimble#StreamingImageOwner": { "type": "string", "traits": { - "smithy.api#documentation": "

StreamingImageOwner is the owner of a particular streaming image.

\n

This string is either the studioId that contains the streaming image, or the word\n 'AMAZON' for images provided by Nimble Studio.

" + "smithy.api#documentation": "

StreamingImageOwner is the owner of a particular streaming image.

\n

This string is either the studioId that contains the streaming image, or the word\n AMAZON for images provided by Nimble Studio.

" } }, "com.amazonaws.nimble#StreamingImagePlatform": { "type": "string", "traits": { - "smithy.api#documentation": "

The platform of this Streaming Image, either WINDOWS or LINUX.

", + "smithy.api#documentation": "

The platform of this streaming image, either Windows or Linux.

", "smithy.api#pattern": "^[a-zA-Z]*$" } }, @@ -6112,140 +6509,189 @@ } }, "com.amazonaws.nimble#StreamingImageState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - ] + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } } }, "com.amazonaws.nimble#StreamingImageStatusCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The status code.

", - "smithy.api#enum": [ - { - "value": "STREAMING_IMAGE_CREATE_IN_PROGRESS", - "name": "STREAMING_IMAGE_CREATE_IN_PROGRESS" - }, - { - "value": "STREAMING_IMAGE_READY", - "name": "STREAMING_IMAGE_READY" - }, - { - "value": "STREAMING_IMAGE_DELETE_IN_PROGRESS", - "name": "STREAMING_IMAGE_DELETE_IN_PROGRESS" - }, - { - "value": "STREAMING_IMAGE_DELETED", - "name": "STREAMING_IMAGE_DELETED" - }, - { - "value": "STREAMING_IMAGE_UPDATE_IN_PROGRESS", - "name": "STREAMING_IMAGE_UPDATE_IN_PROGRESS" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "ACCESS_DENIED", - "name": "ACCESS_DENIED" + "type": "enum", + "members": { + "STREAMING_IMAGE_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_CREATE_IN_PROGRESS" } - ] + }, + "STREAMING_IMAGE_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_READY" + } + }, + "STREAMING_IMAGE_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_DELETE_IN_PROGRESS" + } + }, + "STREAMING_IMAGE_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_DELETED" + } + }, + "STREAMING_IMAGE_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_UPDATE_IN_PROGRESS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status code.

" } }, "com.amazonaws.nimble#StreamingInstanceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "g4dn.xlarge", - "name": "g4dn_xlarge" - }, - { - "value": "g4dn.2xlarge", - "name": "g4dn_2xlarge" - }, - { - "value": "g4dn.4xlarge", - "name": "g4dn_4xlarge" - }, - { - "value": "g4dn.8xlarge", - "name": "g4dn_8xlarge" - }, - { - "value": "g4dn.12xlarge", - "name": "g4dn_12xlarge" - }, - { - "value": "g4dn.16xlarge", - "name": "g4dn_16xlarge" - }, - { - "value": "g3.4xlarge", - "name": "g3_4xlarge" - }, - { - "value": "g3s.xlarge", - "name": "g3s_xlarge" - }, - { - "value": "g5.xlarge", - "name": "g5_xlarge" - }, - { - "value": "g5.2xlarge", - "name": "g5_2xlarge" - }, - { - "value": "g5.4xlarge", - "name": "g5_4xlarge" - }, - { - "value": "g5.8xlarge", - "name": "g5_8xlarge" - }, - { - "value": "g5.16xlarge", - "name": "g5_16xlarge" + "type": "enum", + "members": { + "g4dn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.xlarge" } - ], - "smithy.api#suppress": [ - "EnumTrait" - ] + }, + "g4dn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.2xlarge" + } + }, + "g4dn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.4xlarge" + } + }, + "g4dn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.8xlarge" + } + }, + "g4dn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.12xlarge" + } + }, + "g4dn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.16xlarge" + } + }, + "g3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3.4xlarge" + } + }, + "g3s_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3s.xlarge" + } + }, + "g5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.xlarge" + } + }, + "g5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.2xlarge" + } + }, + "g5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.4xlarge" + } + }, + "g5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.8xlarge" + } + }, + "g5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.16xlarge" + } + } } }, "com.amazonaws.nimble#StreamingInstanceTypeList": { @@ -6267,13 +6713,13 @@ "arn": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The ARN of the resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.

" } }, "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was created.

" } }, "createdBy": { @@ -6333,7 +6779,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } }, "terminateAt": { @@ -6345,7 +6791,7 @@ "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was updated.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was updated.

" } }, "updatedBy": { @@ -6357,7 +6803,7 @@ "stoppedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The time the session entered STOP_IN_PROGRESS state.

" + "smithy.api#documentation": "

The time the session entered STOP_IN_PROGRESS state.

" } }, "stoppedBy": { @@ -6369,7 +6815,7 @@ "startedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The time the session entered START_IN_PROGRESS state.

" + "smithy.api#documentation": "

The time the session entered START_IN_PROGRESS state.

" } }, "startedBy": { @@ -6383,12 +6829,151 @@ "traits": { "smithy.api#documentation": "

The time the streaming session will automatically be stopped if the user doesn’t stop\n the session themselves.

" } + }, + "startedFromBackupId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The backup ID used to restore a streaming session.

" + } + }, + "backupMode": { + "target": "com.amazonaws.nimble#SessionBackupMode", + "traits": { + "smithy.api#documentation": "

Shows the current backup setting of the session.

" + } + }, + "maxBackupsToRetain": { + "target": "com.amazonaws.nimble#StreamConfigurationMaxBackupsToRetain", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of backups of a streaming session that you can have. When the\n maximum number of backups is reached, the oldest backup is deleted.

" + } + }, + "volumeRetentionMode": { + "target": "com.amazonaws.nimble#VolumeRetentionMode", + "traits": { + "smithy.api#documentation": "

Determine if an EBS volume created from this streaming session will be backed\n up.

" + } + }, + "sessionPersistenceMode": { + "target": "com.amazonaws.nimble#SessionPersistenceMode", + "traits": { + "smithy.api#documentation": "

Determine if a streaming session created from this launch profile can configure\n persistent storage. This means that volumeConfiguration and\n automaticTerminationMode are configured.

" + } + }, + "volumeConfiguration": { + "target": "com.amazonaws.nimble#VolumeConfiguration", + "traits": { + "smithy.api#documentation": "

Custom volume configuration for the root volumes that are attached to streaming\n sessions.

\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.

" + } + }, + "automaticTerminationMode": { + "target": "com.amazonaws.nimble#AutomaticTerminationMode", + "traits": { + "smithy.api#documentation": "

Indicates if a streaming session created from this launch profile should be terminated\n automatically or retained without termination after being in a STOPPED\n state.

\n
    \n
  • \n

    When ACTIVATED, the streaming session is scheduled for\n termination after being in the STOPPED state for the time specified\n in maxStoppedSessionLengthInMinutes.

    \n
    • \n
  • \n

    When DEACTIVATED, the streaming session can remain in the\n STOPPED state indefinitely.

    \n
    • \n
\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED. When allowed, the default value for this parameter is\n DEACTIVATED.

" + } } }, "traits": { "smithy.api#documentation": "

A streaming session is a virtual workstation created using a particular launch\n profile.

" } }, + "com.amazonaws.nimble#StreamingSessionBackup": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.

" + } + }, + "createdAt": { + "target": "com.amazonaws.nimble#Timestamp", + "traits": { + "smithy.api#documentation": "

The ISO timestamp in for when the resource was created.

" + } + }, + "launchProfileId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The ID of the launch profile which allowed the backups for the streaming\n session.

" + } + }, + "ownedBy": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The user ID of the user that owns the streaming session.

" + } + }, + "sessionId": { + "target": "com.amazonaws.nimble#StreamingSessionId", + "traits": { + "smithy.api#documentation": "

The streaming session ID for the StreamingSessionBackup.

" + } + }, + "state": { + "target": "com.amazonaws.nimble#StreamingSessionState" + }, + "statusCode": { + "target": "com.amazonaws.nimble#StreamingSessionStatusCode", + "traits": { + "smithy.api#documentation": "

The status code.

" + } + }, + "statusMessage": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The status message for the streaming session backup.

" + } + }, + "backupId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "

The ID of the backup.

" + } + }, + "tags": { + "target": "com.amazonaws.nimble#Tags", + "traits": { + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the streaming session backup.

" + } + }, + "com.amazonaws.nimble#StreamingSessionBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.nimble#StreamingSessionBackup" + } + }, + "com.amazonaws.nimble#StreamingSessionBackupResource": { + "type": "resource", + "identifiers": { + "backupId": { + "target": "com.amazonaws.nimble#String" + } + }, + "read": { + "target": "com.amazonaws.nimble#GetStreamingSessionBackup" + }, + "list": { + "target": "com.amazonaws.nimble#ListStreamingSessionBackups" + }, + "traits": { + "aws.api#arn": { + "template": "streaming-session-backup/{backupId}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "nimble:ownedBy" + ], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Represents a streaming session backup originated from a studio user launched streaming session" + } + }, "com.amazonaws.nimble#StreamingSessionId": { "type": "string" }, @@ -6449,137 +7034,189 @@ } }, "com.amazonaws.nimble#StreamingSessionState": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The streaming session state.

", - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "STOP_IN_PROGRESS", - "name": "STOP_IN_PROGRESS" - }, - { - "value": "START_IN_PROGRESS", - "name": "START_IN_PROGRESS" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "STOP_FAILED", - "name": "STOP_FAILED" - }, - { - "value": "START_FAILED", - "name": "START_FAILED" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - ] + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "STOP_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_IN_PROGRESS" + } + }, + "START_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START_IN_PROGRESS" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "STOP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_FAILED" + } + }, + "START_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START_FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The streaming session state.

" } }, "com.amazonaws.nimble#StreamingSessionStatusCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STREAMING_SESSION_READY", - "name": "STREAMING_SESSION_READY" - }, - { - "value": "STREAMING_SESSION_DELETED", - "name": "STREAMING_SESSION_DELETED" - }, - { - "value": "STREAMING_SESSION_CREATE_IN_PROGRESS", - "name": "STREAMING_SESSION_CREATE_IN_PROGRESS" - }, - { - "value": "STREAMING_SESSION_DELETE_IN_PROGRESS", - "name": "STREAMING_SESSION_DELETE_IN_PROGRESS" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "INSUFFICIENT_CAPACITY", - "name": "INSUFFICIENT_CAPACITY" - }, - { - "value": "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", - "name": "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR" - }, - { - "value": "NETWORK_CONNECTION_ERROR", - "name": "NETWORK_CONNECTION_ERROR" - }, - { - "value": "INITIALIZATION_SCRIPT_ERROR", - "name": "INITIALIZATION_SCRIPT_ERROR" - }, - { - "value": "DECRYPT_STREAMING_IMAGE_ERROR", - "name": "DECRYPT_STREAMING_IMAGE_ERROR" - }, - { - "value": "NETWORK_INTERFACE_ERROR", - "name": "NETWORK_INTERFACE_ERROR" - }, - { - "value": "STREAMING_SESSION_STOPPED", - "name": "STREAMING_SESSION_STOPPED" - }, - { - "value": "STREAMING_SESSION_STARTED", - "name": "STREAMING_SESSION_STARTED" - }, - { - "value": "STREAMING_SESSION_STOP_IN_PROGRESS", - "name": "STREAMING_SESSION_STOP_IN_PROGRESS" - }, - { - "value": "STREAMING_SESSION_START_IN_PROGRESS", - "name": "STREAMING_SESSION_START_IN_PROGRESS" - }, - { - "value": "AMI_VALIDATION_ERROR", - "name": "AMI_VALIDATION_ERROR" + "type": "enum", + "members": { + "STREAMING_SESSION_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_READY" + } + }, + "STREAMING_SESSION_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_DELETED" + } + }, + "STREAMING_SESSION_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_CREATE_IN_PROGRESS" + } + }, + "STREAMING_SESSION_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_DELETE_IN_PROGRESS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "INSUFFICIENT_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_CAPACITY" + } + }, + "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR" + } + }, + "NETWORK_CONNECTION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_CONNECTION_ERROR" + } + }, + "INITIALIZATION_SCRIPT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZATION_SCRIPT_ERROR" + } + }, + "DECRYPT_STREAMING_IMAGE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECRYPT_STREAMING_IMAGE_ERROR" + } + }, + "NETWORK_INTERFACE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_INTERFACE_ERROR" + } + }, + "STREAMING_SESSION_STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_STOPPED" + } + }, + "STREAMING_SESSION_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_STARTED" } - ] + }, + "STREAMING_SESSION_STOP_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_STOP_IN_PROGRESS" + } + }, + "STREAMING_SESSION_START_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_START_IN_PROGRESS" + } + }, + "AMI_VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMI_VALIDATION_ERROR" + } + } } }, "com.amazonaws.nimble#StreamingSessionStorageMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UPLOAD", - "name": "UPLOAD" + "type": "enum", + "members": { + "UPLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPLOAD" } - ] + } } }, "com.amazonaws.nimble#StreamingSessionStorageModeList": { @@ -6641,7 +7278,7 @@ "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was created.

" } }, "createdBy": { @@ -6653,7 +7290,7 @@ "expiresAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource expires.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource expires.

" } }, "ownedBy": { @@ -6694,7 +7331,7 @@ "com.amazonaws.nimble#StreamingSessionStreamExpirationInSeconds": { "type": "integer", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 120, "smithy.api#range": { "min": 60, "max": 3600 @@ -6702,65 +7339,85 @@ } }, "com.amazonaws.nimble#StreamingSessionStreamState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "READY", - "name": "READY" - }, - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" } - ] + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } } }, "com.amazonaws.nimble#StreamingSessionStreamStatusCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STREAM_CREATE_IN_PROGRESS", - "name": "STREAM_CREATE_IN_PROGRESS" - }, - { - "value": "STREAM_READY", - "name": "STREAM_READY" - }, - { - "value": "STREAM_DELETE_IN_PROGRESS", - "name": "STREAM_DELETE_IN_PROGRESS" - }, - { - "value": "STREAM_DELETED", - "name": "STREAM_DELETED" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "NETWORK_CONNECTION_ERROR", - "name": "NETWORK_CONNECTION_ERROR" + "type": "enum", + "members": { + "STREAM_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM_CREATE_IN_PROGRESS" } - ] + }, + "STREAM_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM_READY" + } + }, + "STREAM_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM_DELETE_IN_PROGRESS" + } + }, + "STREAM_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM_DELETED" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "NETWORK_CONNECTION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_CONNECTION_ERROR" + } + } } }, "com.amazonaws.nimble#String": { @@ -6779,7 +7436,7 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

The IAM role that studio admins assume when logging in to the Nimble Studio\n portal.

" + "smithy.api#documentation": "

The IAM role that studio admins assume when logging in to the Nimble Studio portal.

" } }, "arn": { @@ -6793,7 +7450,7 @@ "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was created.

" } }, "displayName": { @@ -6813,7 +7470,7 @@ "target": "com.amazonaws.nimble#String", "traits": { "aws.cloudformation#cfnMutability": "read", - "smithy.api#documentation": "

The IAM Identity Center application client ID used to integrate with IAM Identity Center\n to enable IAM Identity Center users to log in to Nimble Studio portal.

" + "smithy.api#documentation": "

The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio\n portal.

" } }, "state": { @@ -6867,26 +7524,26 @@ "target": "com.amazonaws.nimble#Tags", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } }, "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was updated.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was updated.

" } }, "userRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

The IAM role that studio users assume when logging in to the Nimble Studio\n portal.

" + "smithy.api#documentation": "

The IAM role that studio users assume when logging in to the Nimble Studio portal.

" } } }, "traits": { - "smithy.api#documentation": "

Represents a studio resource.

\n

A studio is the core resource used with Nimble Studio. You must create a studio\n first, before any other resource type can be created. All other resources you create and\n manage in Nimble Studio are contained within a studio.

\n

When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the\n Nimble Studio portal via IAM Identity Center and your identity source.

\n

The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for\n the portal to function properly.

\n

The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached\n for the portal to function properly.

\n

Your studio roles must trust the identity.nimble.amazonaws.com service principal to\n function properly.

" + "smithy.api#documentation": "

Represents a studio resource.

\n

A studio is the core resource used with Nimble Studio. You must create a studio\n first, before any other resource type can be created. All other resources you create and\n manage in Nimble Studio are contained within a studio.

\n

When creating a studio, you must provides two IAM roles for use with\n the Nimble Studio portal. These roles are assumed by your users when they log in to\n the Nimble Studio portal via IAM Identity Center and your identity source.

\n

The user role must have the AmazonNimbleStudio-StudioUser managed policy\n attached for the portal to function properly.

\n

The admin role must have the AmazonNimbleStudio-StudioAdmin managed\n policy attached for the portal to function properly.

\n

Your studio roles must trust the identity.nimble.amazonaws.com service\n principal to function properly.

" } }, "com.amazonaws.nimble#StudioComponent": { @@ -6896,7 +7553,7 @@ "target": "com.amazonaws.nimble#String", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The ARN of the resource.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.

" } }, "configuration": { @@ -6910,7 +7567,7 @@ "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was created.

" } }, "createdBy": { @@ -6992,7 +7649,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } }, "type": { @@ -7006,7 +7663,7 @@ "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was updated.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was updated.

" } }, "updatedBy": { @@ -7020,14 +7677,14 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.

" + "smithy.api#documentation": "

An IAM role attached to Studio Component when the system initialization\n script runs which give the studio component access to Amazon Web Services resources when\n the system initialization script runs.

" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.

" + "smithy.api#documentation": "

An IAM role attached to a Studio Component that gives the studio\n component access to Amazon Web Services resources at anytime while the instance is\n running.

" } } }, @@ -7041,7 +7698,7 @@ "activeDirectoryConfiguration": { "target": "com.amazonaws.nimble#ActiveDirectoryConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for a Microsoft Active Directory (Microsoft AD) studio\n resource.

" + "smithy.api#documentation": "

The configuration for a Directory Service for Microsoft Active Directory studio resource.

" } }, "computeFarmConfiguration": { @@ -7099,7 +7756,7 @@ "platform": { "target": "com.amazonaws.nimble#LaunchProfilePlatform", "traits": { - "smithy.api#documentation": "

The platform of the initialization script, either WINDOWS or LINUX.

" + "smithy.api#documentation": "

The platform of the initialization script, either Windows or Linux.

" } }, "runContext": { @@ -7136,18 +7793,20 @@ } }, "com.amazonaws.nimble#StudioComponentInitializationScriptRunContext": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SYSTEM_INITIALIZATION", - "name": "SYSTEM_INITIALIZATION" - }, - { - "value": "USER_INITIALIZATION", - "name": "USER_INITIALIZATION" + "type": "enum", + "members": { + "SYSTEM_INITIALIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_INITIALIZATION" } - ] + }, + "USER_INITIALIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_INITIALIZATION" + } + } } }, "com.amazonaws.nimble#StudioComponentList": { @@ -7246,43 +7905,59 @@ } }, "com.amazonaws.nimble#StudioComponentState": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The current state of the studio component resource.

\n

While a studio component is being created, modified, or deleted, its state will equal\n \"CREATE_IN_PROGRESS\", \"UPDATE_IN_PROGRESS\", or \"DELETE_IN_PROGRESS\"

\n

These are called 'transition states'.

\n

No modifications may be made to the studio component while it is in a transition\n state.

\n

If creation of the resource fails, the state will change to `CREATE_FAILED`. The\n resource StatusCode and StatusMessage will provide more information of why creation\n failed. The resource in this state will automatically be deleted from your account after\n a period of time.

\n

If updating the resource fails, the state will change to `UPDATE_FAILED`. The resource\n StatusCode and StatusMessage will provide more information of why the update failed. The\n resource will be returned to the state it was in when the update request was\n invoked.

\n

If deleting the resource fails, the state will change to `DELETE_FAILED`. The resource\n StatusCode and StatusMessage will provide more information of why the update failed. The\n resource will be returned to the state it was in when the update request was invoked.\n After the resource is deleted successfully, it will change to the \"DELETED\" state. The\n resource will no longer count against service quotas and cannot be used or acted upon\n any futher. It will be removed from your account after a period of time.

", - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - ] + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The current state of the studio component resource.

\n

While a studio component is being created, modified, or deleted, its state will be\n CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, or\n DELETE_IN_PROGRESS.

\n

These are called transition states.

\n

No modifications may be made to the studio component while it is in a transition\n state.

\n

If creation of the resource fails, the state will change to\n CREATE_FAILED. The resource StatusCode and\n StatusMessage will provide more information of why creation failed. The\n resource in this state will automatically be deleted from your account after a period of\n time.

\n

If updating the resource fails, the state will change to UPDATE_FAILED.\n The resource StatusCode and StatusMessage will provide more\n information of why the update failed. The resource will be returned to the state it was\n in when the update request was invoked.

\n

If deleting the resource fails, the state will change to DELETE_FAILED.\n The resource StatusCode and StatusMessage will provide more\n information of why the update failed. The resource will be returned to the state it was\n in when the update request was invoked. After the resource is deleted successfully, it\n will change to the DELETED state. The resource will no longer count against\n service quotas and cannot be used or acted upon any futher. It will be removed from your\n account after a period of time.

" } }, "com.amazonaws.nimble#StudioComponentStateList": { @@ -7292,74 +7967,100 @@ } }, "com.amazonaws.nimble#StudioComponentStatusCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The current status of the studio component resource.

\n

When the resource is in the 'READY' state, the status code signals what the last\n mutation made to the resource was.

\n

When the resource is in a CREATE_FAILED/UPDATE_FAILED/DELETE_FAILED state, the status\n code signals what went wrong and why the mutation failed.

", - "smithy.api#enum": [ - { - "value": "ACTIVE_DIRECTORY_ALREADY_EXISTS", - "name": "ACTIVE_DIRECTORY_ALREADY_EXISTS" - }, - { - "value": "STUDIO_COMPONENT_CREATED", - "name": "STUDIO_COMPONENT_CREATED" - }, - { - "value": "STUDIO_COMPONENT_UPDATED", - "name": "STUDIO_COMPONENT_UPDATED" - }, - { - "value": "STUDIO_COMPONENT_DELETED", - "name": "STUDIO_COMPONENT_DELETED" - }, - { - "value": "ENCRYPTION_KEY_ACCESS_DENIED", - "name": "ENCRYPTION_KEY_ACCESS_DENIED" - }, - { - "value": "ENCRYPTION_KEY_NOT_FOUND", - "name": "ENCRYPTION_KEY_NOT_FOUND" - }, - { - "value": "STUDIO_COMPONENT_CREATE_IN_PROGRESS", - "name": "STUDIO_COMPONENT_CREATE_IN_PROGRESS" - }, - { - "value": "STUDIO_COMPONENT_UPDATE_IN_PROGRESS", - "name": "STUDIO_COMPONENT_UPDATE_IN_PROGRESS" - }, - { - "value": "STUDIO_COMPONENT_DELETE_IN_PROGRESS", - "name": "STUDIO_COMPONENT_DELETE_IN_PROGRESS" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" + "type": "enum", + "members": { + "ACTIVE_DIRECTORY_ALREADY_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY_ALREADY_EXISTS" } - ] + }, + "STUDIO_COMPONENT_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_CREATED" + } + }, + "STUDIO_COMPONENT_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_UPDATED" + } + }, + "STUDIO_COMPONENT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_DELETED" + } + }, + "ENCRYPTION_KEY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_ACCESS_DENIED" + } + }, + "ENCRYPTION_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_NOT_FOUND" + } + }, + "STUDIO_COMPONENT_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_CREATE_IN_PROGRESS" + } + }, + "STUDIO_COMPONENT_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_UPDATE_IN_PROGRESS" + } + }, + "STUDIO_COMPONENT_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_DELETE_IN_PROGRESS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + } + }, + "traits": { + "smithy.api#documentation": "

The current status of the studio component resource.

\n

When the resource is in the READY state, the status code signals what the\n last mutation made to the resource was.

\n

When the resource is in a CREATE_FAILED, UPDATE_FAILED, or\n DELETE_FAILED state, the status code signals what went wrong and why\n the mutation failed.

" } }, "com.amazonaws.nimble#StudioComponentSubtype": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWS_MANAGED_MICROSOFT_AD", - "name": "AWS_MANAGED_MICROSOFT_AD" - }, - { - "value": "AMAZON_FSX_FOR_WINDOWS", - "name": "AMAZON_FSX_FOR_WINDOWS" - }, - { - "value": "AMAZON_FSX_FOR_LUSTRE", - "name": "AMAZON_FSX_FOR_LUSTRE" - }, - { - "value": "CUSTOM", - "name": "CUSTOM" + "type": "enum", + "members": { + "AWS_MANAGED_MICROSOFT_AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_MANAGED_MICROSOFT_AD" } - ] + }, + "AMAZON_FSX_FOR_WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_FSX_FOR_WINDOWS" + } + }, + "AMAZON_FSX_FOR_LUSTRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_FSX_FOR_LUSTRE" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } } }, "com.amazonaws.nimble#StudioComponentSummary": { @@ -7368,7 +8069,7 @@ "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was created.

" } }, "createdBy": { @@ -7410,7 +8111,7 @@ "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the resource was updated.

" + "smithy.api#documentation": "

The ISO timestamp in seconds for when the resource was updated.

" } }, "updatedBy": { @@ -7431,30 +8132,38 @@ } }, "com.amazonaws.nimble#StudioComponentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE_DIRECTORY", - "name": "ACTIVE_DIRECTORY" - }, - { - "value": "SHARED_FILE_SYSTEM", - "name": "SHARED_FILE_SYSTEM" - }, - { - "value": "COMPUTE_FARM", - "name": "COMPUTE_FARM" - }, - { - "value": "LICENSE_SERVICE", - "name": "LICENSE_SERVICE" - }, - { - "value": "CUSTOM", - "name": "CUSTOM" + "type": "enum", + "members": { + "ACTIVE_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY" } - ] + }, + "SHARED_FILE_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_FILE_SYSTEM" + } + }, + "COMPUTE_FARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPUTE_FARM" + } + }, + "LICENSE_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_SERVICE" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } } }, "com.amazonaws.nimble#StudioComponentTypeList": { @@ -7505,19 +8214,23 @@ } }, "com.amazonaws.nimble#StudioEncryptionConfigurationKeyType": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The type of KMS key that is used to encrypt studio data.

", - "smithy.api#enum": [ - { - "value": "AWS_OWNED_KEY", - "name": "AWS_OWNED_KEY" - }, - { - "value": "CUSTOMER_MANAGED_KEY", - "name": "CUSTOMER_MANAGED_KEY" + "type": "enum", + "members": { + "AWS_OWNED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OWNED_KEY" } - ] + }, + "CUSTOMER_MANAGED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of KMS key that is used to encrypt studio data.

" } }, "com.amazonaws.nimble#StudioList": { @@ -7555,7 +8268,7 @@ } }, "traits": { - "smithy.api#documentation": "

A studio member is an association of a user from your studio identity source to\n elevated permissions that they are granted in the studio.

\n

When you add a user to your studio using the Nimble Studio console, they are\n given access to the studio's IAM Identity Center application and are given access to log in to the\n Nimble Studio portal. These users have the permissions provided by the studio's\n user IAM role and do not appear in the studio membership collection. Only studio admins\n appear in studio membership.

\n

When you add a user to studio membership with the persona ADMIN, upon logging in to\n the Nimble Studio portal, they are granted permissions specified by the Studio's\n Admin IAM role.

" + "smithy.api#documentation": "

A studio member is an association of a user from your studio identity source to\n elevated permissions that they are granted in the studio.

\n

When you add a user to your studio using the Nimble Studio console, they are\n given access to the studio's IAM Identity Center application and are given access to log\n in to the Nimble Studio portal. These users have the permissions provided by the\n studio's user IAM role and do not appear in the studio membership\n collection. Only studio admins appear in studio membership.

\n

When you add a user to studio membership with the ADMIN persona, upon logging in to\n the Nimble Studio portal, they are granted permissions specified by the Studio's\n Admin IAM role.

" } }, "com.amazonaws.nimble#StudioMembershipList": { @@ -7581,14 +8294,14 @@ } }, "com.amazonaws.nimble#StudioPersona": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ADMINISTRATOR", - "name": "ADMINISTRATOR" + "type": "enum", + "members": { + "ADMINISTRATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMINISTRATOR" } - ] + } } }, "com.amazonaws.nimble#StudioResource": { @@ -7657,122 +8370,178 @@ } }, "com.amazonaws.nimble#StudioState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - ] + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } } }, "com.amazonaws.nimble#StudioStatusCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The status code.

", - "smithy.api#enum": [ - { - "value": "STUDIO_CREATED", - "name": "STUDIO_CREATED" - }, - { - "value": "STUDIO_DELETED", - "name": "STUDIO_DELETED" - }, - { - "value": "STUDIO_UPDATED", - "name": "STUDIO_UPDATED" - }, - { - "value": "STUDIO_CREATE_IN_PROGRESS", - "name": "STUDIO_CREATE_IN_PROGRESS" - }, - { - "value": "STUDIO_UPDATE_IN_PROGRESS", - "name": "STUDIO_UPDATE_IN_PROGRESS" - }, - { - "value": "STUDIO_DELETE_IN_PROGRESS", - "name": "STUDIO_DELETE_IN_PROGRESS" - }, - { - "value": "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", - "name": "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED" - }, - { - "value": "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", - "name": "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED" - }, - { - "value": "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", - "name": "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED" - }, - { - "value": "AWS_SSO_NOT_ENABLED", - "name": "AWS_SSO_NOT_ENABLED" - }, - { - "value": "AWS_SSO_ACCESS_DENIED", - "name": "AWS_SSO_ACCESS_DENIED" - }, - { - "value": "ROLE_NOT_OWNED_BY_STUDIO_OWNER", - "name": "ROLE_NOT_OWNED_BY_STUDIO_OWNER" - }, - { - "value": "ROLE_COULD_NOT_BE_ASSUMED", - "name": "ROLE_COULD_NOT_BE_ASSUMED" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "ENCRYPTION_KEY_NOT_FOUND", - "name": "ENCRYPTION_KEY_NOT_FOUND" - }, - { - "value": "ENCRYPTION_KEY_ACCESS_DENIED", - "name": "ENCRYPTION_KEY_ACCESS_DENIED" - }, - { - "value": "AWS_SSO_CONFIGURATION_REPAIRED", - "name": "AWS_SSO_CONFIGURATION_REPAIRED" - }, - { - "value": "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", - "name": "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS" + "type": "enum", + "members": { + "STUDIO_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_CREATED" } - ] + }, + "STUDIO_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_DELETED" + } + }, + "STUDIO_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_UPDATED" + } + }, + "STUDIO_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_CREATE_IN_PROGRESS" + } + }, + "STUDIO_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_UPDATE_IN_PROGRESS" + } + }, + "STUDIO_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_DELETE_IN_PROGRESS" + } + }, + "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED" + } + }, + "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED" + } + }, + "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED" + } + }, + "AWS_SSO_NOT_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SSO_NOT_ENABLED" + } + }, + "AWS_SSO_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SSO_ACCESS_DENIED" + } + }, + "ROLE_NOT_OWNED_BY_STUDIO_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLE_NOT_OWNED_BY_STUDIO_OWNER" + } + }, + "ROLE_COULD_NOT_BE_ASSUMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLE_COULD_NOT_BE_ASSUMED" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "ENCRYPTION_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_NOT_FOUND" + } + }, + "ENCRYPTION_KEY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_ACCESS_DENIED" + } + }, + "AWS_SSO_CONFIGURATION_REPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SSO_CONFIGURATION_REPAIRED" + } + }, + "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS" + } + }, + "AWS_STS_REGION_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_STS_REGION_DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status code.

" } }, "com.amazonaws.nimble#TagResource": { @@ -7822,7 +8591,7 @@ "resourceArn": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource you want to add tags to.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource you want to add tags to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7830,7 +8599,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" + "smithy.api#documentation": "

A collection of labels, in the form of key-value pairs, that apply to this\n resource.

" } } }, @@ -8121,7 +8890,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8129,7 +8898,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8183,7 +8952,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8197,7 +8966,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "

The Launch Profile ID.

", + "smithy.api#documentation": "

The ID of the launch profile used to control access from the streaming session.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8302,7 +9071,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8449,7 +9218,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8522,14 +9291,14 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.

" + "smithy.api#documentation": "

An IAM role attached to Studio Component when the system initialization\n script runs which give the studio component access to Amazon Web Services resources when\n the system initialization script runs.

" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.

" + "smithy.api#documentation": "

An IAM role attached to a Studio Component that gives the studio\n component access to Amazon Web Services resources at anytime while the instance is\n running.

" } } }, @@ -8557,14 +9326,14 @@ "adminRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role that Studio Admins will assume when logging in to the Nimble Studio\n portal.

" + "smithy.api#documentation": "

The IAM role that Studio Admins will assume when logging in to the\n Nimble Studio portal.

" } }, "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.

", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8586,7 +9355,7 @@ "userRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.

" + "smithy.api#documentation": "

The IAM role that Studio Users will assume when logging in to the\n Nimble Studio portal.

" } } }, @@ -8679,6 +9448,82 @@ "target": "com.amazonaws.nimble#ValidationResult" } }, + "com.amazonaws.nimble#VolumeConfiguration": { + "type": "structure", + "members": { + "size": { + "target": "com.amazonaws.nimble#VolumeSizeInGiB", + "traits": { + "smithy.api#default": 500, + "smithy.api#documentation": "

The size of the root volume that is attached to the streaming session. The root volume\n size is measured in GiBs.

" + } + }, + "throughput": { + "target": "com.amazonaws.nimble#VolumeThroughputInMiBs", + "traits": { + "smithy.api#default": 125, + "smithy.api#documentation": "

The throughput to provision for the root volume that is attached to the streaming\n session. The throughput is measured in MiB/s.

" + } + }, + "iops": { + "target": "com.amazonaws.nimble#VolumeIops", + "traits": { + "smithy.api#default": 3000, + "smithy.api#documentation": "

The number of I/O operations per second for the root volume that is attached to\n streaming session.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Custom volume configuration for the root volumes that are attached to streaming\n sessions.

\n

This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.

" + } + }, + "com.amazonaws.nimble#VolumeIops": { + "type": "integer", + "traits": { + "smithy.api#default": 3000, + "smithy.api#range": { + "min": 3000, + "max": 16000 + } + } + }, + "com.amazonaws.nimble#VolumeRetentionMode": { + "type": "enum", + "members": { + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.nimble#VolumeSizeInGiB": { + "type": "integer", + "traits": { + "smithy.api#default": 500, + "smithy.api#range": { + "min": 100, + "max": 16000 + } + } + }, + "com.amazonaws.nimble#VolumeThroughputInMiBs": { + "type": "integer", + "traits": { + "smithy.api#default": 125, + "smithy.api#range": { + "min": 125, + "max": 1000 + } + } + }, "com.amazonaws.nimble#WindowsMountDrive": { "type": "string", "traits": { @@ -8712,6 +9557,9 @@ { "target": "com.amazonaws.nimble#StreamingImageResource" }, + { + "target": "com.amazonaws.nimble#StreamingSessionBackupResource" + }, { "target": "com.amazonaws.nimble#StreamingSessionResource" }, @@ -8803,7 +9651,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -8852,15 +9700,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -9123,8 +9962,8 @@ } }, "params": { - "Region": "ca-central-1", "UseDualStack": true, + "Region": "ca-central-1", "UseFIPS": true } }, @@ -9136,8 +9975,8 @@ } }, "params": { - "Region": "ca-central-1", "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": true } }, @@ -9149,8 +9988,8 @@ } }, "params": { - "Region": "ca-central-1", "UseDualStack": true, + "Region": "ca-central-1", "UseFIPS": false } }, @@ -9162,8 +10001,8 @@ } }, "params": { - "Region": "ca-central-1", "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false } }, @@ -9175,8 +10014,8 @@ } }, "params": { - "Region": "us-west-2", "UseDualStack": true, + "Region": "us-west-2", "UseFIPS": true } }, @@ -9188,8 +10027,8 @@ } }, "params": { - "Region": "us-west-2", "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": true } }, @@ -9201,8 +10040,8 @@ } }, "params": { - "Region": "us-west-2", "UseDualStack": true, + "Region": "us-west-2", "UseFIPS": false } }, @@ -9214,8 +10053,8 @@ } }, "params": { - "Region": "us-west-2", "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false } }, @@ -9227,8 +10066,8 @@ } }, "params": { - "Region": "eu-west-2", "UseDualStack": true, + "Region": "eu-west-2", "UseFIPS": true } }, @@ -9240,8 +10079,8 @@ } }, "params": { - "Region": "eu-west-2", "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": true } }, @@ -9253,8 +10092,8 @@ } }, "params": { - "Region": "eu-west-2", "UseDualStack": true, + "Region": "eu-west-2", "UseFIPS": false } }, @@ -9266,8 +10105,8 @@ } }, "params": { - "Region": "eu-west-2", "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false } }, @@ -9279,8 +10118,8 @@ } }, "params": { - "Region": "ap-northeast-1", "UseDualStack": true, + "Region": "ap-northeast-1", "UseFIPS": true } }, @@ -9292,8 +10131,8 @@ } }, "params": { - "Region": "ap-northeast-1", "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": true } }, @@ -9305,8 +10144,8 @@ } }, "params": { - "Region": "ap-northeast-1", "UseDualStack": true, + "Region": "ap-northeast-1", "UseFIPS": false } }, @@ -9318,8 +10157,8 @@ } }, "params": { - "Region": "ap-northeast-1", "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": false } }, @@ -9331,8 +10170,8 @@ } }, "params": { - "Region": "ap-southeast-2", "UseDualStack": true, + "Region": "ap-southeast-2", "UseFIPS": true } }, @@ -9344,8 +10183,8 @@ } }, "params": { - "Region": "ap-southeast-2", "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": true } }, @@ -9357,8 +10196,8 @@ } }, "params": { - "Region": "ap-southeast-2", "UseDualStack": true, + "Region": "ap-southeast-2", "UseFIPS": false } }, @@ -9370,8 +10209,8 @@ } }, "params": { - "Region": "ap-southeast-2", "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false } }, @@ -9383,8 +10222,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true } }, @@ -9396,8 +10235,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true } }, @@ -9409,8 +10248,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false } }, @@ -9422,8 +10261,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false } }, @@ -9435,8 +10274,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, "Endpoint": "https://example.com" } @@ -9447,8 +10286,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, "Endpoint": "https://example.com" } @@ -9459,8 +10298,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, "Endpoint": "https://example.com" } @@ -9471,4 +10310,4 @@ } } } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/oam.2022-06-10.json b/codegen/sdk-codegen/aws-models/oam.2022-06-10.json index 1d74e334612..73ae891bfca 100644 --- a/codegen/sdk-codegen/aws-models/oam.2022-06-10.json +++ b/codegen/sdk-codegen/aws-models/oam.2022-06-10.json @@ -2302,4 +2302,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/omics.2022-11-28.json b/codegen/sdk-codegen/aws-models/omics.2022-11-28.json index f82407c1e7e..88881302210 100644 --- a/codegen/sdk-codegen/aws-models/omics.2022-11-28.json +++ b/codegen/sdk-codegen/aws-models/omics.2022-11-28.json @@ -13474,4 +13474,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/opensearchserverless.2021-11-01.json b/codegen/sdk-codegen/aws-models/opensearchserverless.2021-11-01.json index a6fb9f8b3b8..03bf2403b31 100644 --- a/codegen/sdk-codegen/aws-models/opensearchserverless.2021-11-01.json +++ b/codegen/sdk-codegen/aws-models/opensearchserverless.2021-11-01.json @@ -4220,4 +4220,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/pipes.2015-10-07.json b/codegen/sdk-codegen/aws-models/pipes.2015-10-07.json index c1612768ed0..78b86115416 100644 --- a/codegen/sdk-codegen/aws-models/pipes.2015-10-07.json +++ b/codegen/sdk-codegen/aws-models/pipes.2015-10-07.json @@ -5095,4 +5095,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/privatenetworks.2021-12-03.json b/codegen/sdk-codegen/aws-models/privatenetworks.2021-12-03.json index 207113f9576..a74217e6f4e 100644 --- a/codegen/sdk-codegen/aws-models/privatenetworks.2021-12-03.json +++ b/codegen/sdk-codegen/aws-models/privatenetworks.2021-12-03.json @@ -3545,4 +3545,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/proton.2020-07-20.json b/codegen/sdk-codegen/aws-models/proton.2020-07-20.json index 13ec8cbe965..b1cc7cc6772 100644 --- a/codegen/sdk-codegen/aws-models/proton.2020-07-20.json +++ b/codegen/sdk-codegen/aws-models/proton.2020-07-20.json @@ -10949,4 +10949,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json index 89f305330e3..e771201aa6b 100644 --- a/codegen/sdk-codegen/aws-models/rds.2014-10-31.json +++ b/codegen/sdk-codegen/aws-models/rds.2014-10-31.json @@ -68,7 +68,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": { @@ -235,7 +235,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n \n

This command doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n \n

This command doesn't apply to RDS Custom.

" } }, "com.amazonaws.rds#AddRoleToDBInstanceMessage": { @@ -297,7 +297,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": {} } } @@ -323,6 +323,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, @@ -340,7 +343,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": { @@ -805,7 +808,7 @@ "name": "rds" }, "aws.protocols#awsQuery": {}, - "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#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 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/" @@ -1247,8 +1250,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": true } }, { @@ -1260,8 +1263,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": false } }, { @@ -1273,8 +1276,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": true } }, { @@ -1286,8 +1289,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-south-2" + "Region": "ap-south-2", + "UseDualStack": false } }, { @@ -1299,8 +1302,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -1312,8 +1315,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -1325,8 +1328,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -1338,8 +1341,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -1351,8 +1354,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -1364,8 +1367,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -1377,8 +1380,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -1390,8 +1393,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -1403,8 +1406,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": true } }, { @@ -1416,8 +1419,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": false } }, { @@ -1429,8 +1432,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": true } }, { @@ -1442,8 +1445,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-south-2" + "Region": "eu-south-2", + "UseDualStack": false } }, { @@ -1455,8 +1458,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -1468,8 +1471,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -1481,8 +1484,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -1494,8 +1497,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -1507,8 +1510,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -1520,8 +1523,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -1533,8 +1536,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -1546,8 +1549,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -1559,8 +1562,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -1572,8 +1575,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -1585,8 +1588,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -1598,8 +1601,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -1611,8 +1614,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -1624,8 +1627,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -1637,8 +1640,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -1650,8 +1653,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -1661,8 +1664,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-west-1" + "Region": "us-iso-west-1", + "UseDualStack": true } }, { @@ -1674,8 +1677,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-iso-west-1" + "Region": "us-iso-west-1", + "UseDualStack": false } }, { @@ -1685,8 +1688,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-west-1" + "Region": "us-iso-west-1", + "UseDualStack": true } }, { @@ -1698,8 +1701,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-iso-west-1" + "Region": "us-iso-west-1", + "UseDualStack": false } }, { @@ -1711,8 +1714,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": true } }, { @@ -1724,8 +1727,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": false } }, { @@ -1737,8 +1740,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": true } }, { @@ -1750,8 +1753,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-central-2" + "Region": "eu-central-2", + "UseDualStack": false } }, { @@ -1763,8 +1766,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -1776,8 +1779,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -1789,8 +1792,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -1802,8 +1805,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -1815,8 +1818,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -1828,8 +1831,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -1841,8 +1844,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -1854,8 +1857,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -1867,8 +1870,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -1880,8 +1883,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -1893,8 +1896,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -1906,8 +1909,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -1919,8 +1922,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1932,8 +1935,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1945,8 +1948,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -1958,8 +1961,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -1971,8 +1974,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -1984,8 +1987,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -1997,8 +2000,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -2010,8 +2013,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -2023,8 +2026,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -2036,8 +2039,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -2049,8 +2052,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -2062,8 +2065,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -2075,8 +2078,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -2088,8 +2091,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -2101,8 +2104,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -2114,8 +2117,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -2127,8 +2130,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -2140,8 +2143,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -2153,8 +2156,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -2166,8 +2169,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -2179,8 +2182,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -2192,8 +2195,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -2205,8 +2208,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -2218,8 +2221,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -2231,8 +2234,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -2244,8 +2247,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -2257,8 +2260,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -2270,8 +2273,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -2283,8 +2286,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -2296,8 +2299,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -2309,8 +2312,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -2322,8 +2325,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -2335,8 +2338,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -2348,8 +2351,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -2361,8 +2364,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -2374,8 +2377,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -2387,8 +2390,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -2400,8 +2403,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -2413,8 +2416,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -2426,8 +2429,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -2439,8 +2442,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -2452,8 +2455,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -2465,8 +2468,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -2478,8 +2481,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -2491,8 +2494,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -2504,8 +2507,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -2517,8 +2520,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -2530,8 +2533,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -2543,8 +2546,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -2556,8 +2559,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -2569,8 +2572,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -2582,8 +2585,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -2595,8 +2598,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -2608,8 +2611,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -2621,8 +2624,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -2634,8 +2637,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -2645,8 +2648,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -2658,8 +2661,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -2669,8 +2672,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -2682,8 +2685,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -2695,8 +2698,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -2708,8 +2711,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -2721,8 +2724,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -2734,8 +2737,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -2747,8 +2750,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": true } }, { @@ -2760,8 +2763,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": false } }, { @@ -2773,8 +2776,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": true } }, { @@ -2786,8 +2789,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-southeast-4" + "Region": "ap-southeast-4", + "UseDualStack": false } }, { @@ -2799,8 +2802,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -2812,8 +2815,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -2825,8 +2828,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -2838,8 +2841,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -2851,8 +2854,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -2864,8 +2867,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -2877,8 +2880,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -2890,8 +2893,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -2903,8 +2906,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -2916,8 +2919,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -2929,8 +2932,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -2942,8 +2945,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -2953,8 +2956,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -2966,8 +2969,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -2977,8 +2980,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -2990,8 +2993,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -3003,8 +3006,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -3015,8 +3018,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -3027,8 +3030,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -3090,14 +3093,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": {} } } @@ -3180,7 +3183,7 @@ "code": "AuthorizationNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.

\n

Or, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.

", + "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.

\n

Or, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3225,7 +3228,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

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

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\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

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

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { @@ -3303,7 +3306,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": { @@ -3347,7 +3350,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the available processor feature information for the DB instance class of a DB instance.

\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 available processor feature information for the DB instance class of a DB instance.

\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#AvailableProcessorFeatureList": { @@ -3386,7 +3389,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

This action applies only 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 applies only to Aurora MySQL DB clusters.

\n " } }, "com.amazonaws.rds#BacktrackDBClusterMessage": { @@ -3395,14 +3398,14 @@ "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": {} } }, "BacktrackTo": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n

\n \n

If the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.

\n \n

Constraints:

\n
    \n
  • \n

    Must contain a valid ISO 8601 timestamp.

    \n
    • \n
  • \n

    Can't contain a timestamp set in the future.

    \n
    • \n
\n

Example: 2017-07-08T18:00Z\n

", + "smithy.api#documentation": "

The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n

\n \n

If the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.

\n \n

Constraints:

\n
    \n
  • \n

    Must contain a valid ISO 8601 timestamp.

    \n
    • \n
  • \n

    Can't contain a timestamp set in the future.

    \n
    • \n
\n

Example: 2017-07-08T18:00Z\n

", "smithy.api#required": {} } }, @@ -3460,13 +3463,13 @@ "Source": { "target": "com.amazonaws.rds#DatabaseArn", "traits": { - "smithy.api#documentation": "

The source database for the blue/green deployment.

\n

Before switchover, the source database is the production database in the blue environment.

" + "smithy.api#documentation": "

The source database for the blue/green deployment.

\n

Before switchover, the source database is the production database in the blue environment.

" } }, "Target": { "target": "com.amazonaws.rds#DatabaseArn", "traits": { - "smithy.api#documentation": "

The target database for the blue/green deployment.

\n

Before switchover, the target database is the clone database in the green environment.

" + "smithy.api#documentation": "

The target database for the blue/green deployment.

\n

Before switchover, the target database is the clone database in the green environment.

" } }, "SwitchoverDetails": { @@ -3484,7 +3487,7 @@ "Status": { "target": "com.amazonaws.rds#BlueGreenDeploymentStatus", "traits": { - "smithy.api#documentation": "

The status of the blue/green deployment.

\n

Values:

\n
    \n
  • \n

    \n PROVISIONING - Resources are being created in the green environment.

    \n
    • \n
  • \n

    \n AVAILABLE - Resources are available in the green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the \n green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.

    \n
    • \n
  • \n

    \n INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.

    \n
    • \n
  • \n

    \n SWITCHOVER_FAILED - Switchover was attempted but failed.

    \n
    • \n
  • \n

    \n DELETING - The blue/green deployment is being deleted.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the blue/green deployment.

\n

Values:

\n
    \n
  • \n

    \n PROVISIONING - Resources are being created in the green environment.

    \n
    • \n
  • \n

    \n AVAILABLE - Resources are available in the green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the \n green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.

    \n
    • \n
  • \n

    \n INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.

    \n
    • \n
  • \n

    \n SWITCHOVER_FAILED - Switchover was attempted but failed.

    \n
    • \n
  • \n

    \n DELETING - The blue/green deployment is being deleted.

    \n
    • \n
" } }, "StatusDetails": { @@ -3510,7 +3513,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" } }, "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault": { @@ -3591,12 +3594,12 @@ "Status": { "target": "com.amazonaws.rds#BlueGreenDeploymentTaskStatus", "traits": { - "smithy.api#documentation": "

The status of the blue/green deployment task.

\n

Values:

\n
    \n
  • \n

    \n PENDING - The resources are being prepared for deployment.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The resource is being deployed.

    \n
    • \n
  • \n

    \n COMPLETED - The resource has been deployed.

    \n
    • \n
  • \n

    \n FAILED - Deployment of the resource failed.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the blue/green deployment task.

\n

Values:

\n
    \n
  • \n

    \n PENDING - The resources are being prepared for deployment.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The resource is being deployed.

    \n
    • \n
  • \n

    \n COMPLETED - The resource has been deployed.

    \n
    • \n
  • \n

    \n FAILED - Deployment of the resource failed.

    \n
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

Contains the details about a task for a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + "smithy.api#documentation": "

Contains the details about a task for a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" } }, "com.amazonaws.rds#BlueGreenDeploymentTaskList": { @@ -3784,6 +3787,35 @@ "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" } }, + "com.amazonaws.rds#ClientPasswordAuthType": { + "type": "enum", + "members": { + "MYSQL_NATIVE_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL_NATIVE_PASSWORD" + } + }, + "POSTGRES_SCRAM_SHA_256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRES_SCRAM_SHA_256" + } + }, + "POSTGRES_MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRES_MD5" + } + }, + "SQL_SERVER_AUTHENTICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SERVER_AUTHENTICATION" + } + } + } + }, "com.amazonaws.rds#CloudwatchLogsExportConfiguration": { "type": "structure", "members": { @@ -3801,7 +3833,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.

\n

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, 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 DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.

\n

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, 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 DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#ClusterPendingModifiedValues": { @@ -3863,31 +3895,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

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints: Must be 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

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints: Must be between 1 and 100.

" } }, "MaxIdleConnectionsPercent": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "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

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

" + "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

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

" } }, "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": "

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

" + "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

" } } }, @@ -3965,14 +3997,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

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": {} } }, @@ -4025,7 +4057,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

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n 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 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\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned 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.

" + "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,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n 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 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\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned 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": { @@ -4034,27 +4066,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

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

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.

" + "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": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region \n 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\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 run in the source Amazon Web Services Region.

\n " + "smithy.api#documentation": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region \n 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\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 run in the source Amazon Web Services Region.

\n " } }, "CopyTags": { @@ -4108,14 +4140,14 @@ "SourceDBParameterGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "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#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": {} } }, @@ -4171,7 +4203,7 @@ } ], "traits": { - "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\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the 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.

" + "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\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the 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": { @@ -4180,21 +4212,21 @@ "SourceDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "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 this parameter must be in the ARN format for the source Amazon Web Services Region.

\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#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 this parameter must be in the ARN format for the source Amazon Web Services Region.

\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

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#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

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.

" + "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": { @@ -4203,25 +4235,31 @@ "CopyTags": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

" + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.

" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\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\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.

    \n

    For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n 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\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 run in the source Amazon Web Services Region.

\n " + "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\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\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.

    \n

    For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n 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\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 run 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

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.

" + "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The external custom Availability Zone (CAZ) identifier for the target CAZ.

\n

Example: rds-caz-aiqhTgQv.

" + "smithy.api#documentation": "

The external custom Availability Zone (CAZ) identifier for the target CAZ.

\n

Example: rds-caz-aiqhTgQv.

" + } + }, + "CopyOptionGroup": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.

" } } }, @@ -4266,14 +4304,14 @@ "SourceOptionGroupIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "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#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": {} } }, @@ -4344,7 +4382,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a blue/green deployment.

\n

A blue/green deployment creates a staging environment that copies the production environment. \n In a blue/green deployment, the blue environment is the current production environment. \n The green environment is the staging environment. The staging environment stays in sync \n with the current production environment using logical replication.

\n

You can make changes to the databases in the green environment without affecting \n production workloads. For example, you can upgrade the major or minor DB engine version, change \n database parameters, or make schema changes in the staging environment. You can thoroughly test \n changes in the green environment. When ready, you can switch over the environments to promote the \n green environment to be the new production environment. The switchover typically takes under a minute.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + "smithy.api#documentation": "

Creates a blue/green deployment.

\n

A blue/green deployment creates a staging environment that copies the production environment. \n In a blue/green deployment, the blue environment is the current production environment. \n The green environment is the staging environment. The staging environment stays in sync \n with the current production environment using logical replication.

\n

You can make changes to the databases in the green environment without affecting \n production workloads. For example, you can upgrade the major or minor DB engine version, change \n database parameters, or make schema changes in the staging environment. You can thoroughly test \n changes in the green environment. When ready, you can switch over the environments to promote the \n green environment to be the new production environment. The switchover typically takes under a minute.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" } }, "com.amazonaws.rds#CreateBlueGreenDeploymentRequest": { @@ -4353,33 +4391,33 @@ "BlueGreenDeploymentName": { "target": "com.amazonaws.rds#BlueGreenDeploymentName", "traits": { - "smithy.api#documentation": "

The name of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

    Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

    \n
    • \n
", + "smithy.api#documentation": "

The name of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

    Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

    \n
    • \n
", "smithy.api#required": {} } }, "Source": { "target": "com.amazonaws.rds#DatabaseArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source production database.

\n

Specify the database that you want to clone. The blue/green deployment creates this database in \n the green environment. You can make updates to the database in the green environment, such as an engine \n version upgrade. When you are ready, you can switch the database in the green environment to be the \n production database.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source production database.

\n

Specify the database that you want to clone. The blue/green deployment creates this database in \n the green environment. You can make updates to the database in the green environment, such as an engine \n version upgrade. When you are ready, you can switch the database in the green environment to be the \n production database.

", "smithy.api#required": {} } }, "TargetEngineVersion": { "target": "com.amazonaws.rds#TargetEngineVersion", "traits": { - "smithy.api#documentation": "

The engine version of the database in the green environment.

\n

Specify the engine version to upgrade to in the green environment.

" + "smithy.api#documentation": "

The engine version of the database in the green environment.

\n

Specify the engine version to upgrade to in the green environment.

" } }, "TargetDBParameterGroupName": { "target": "com.amazonaws.rds#TargetDBParameterGroupName", "traits": { - "smithy.api#documentation": "

The DB parameter group associated with the DB instance in the green environment.

\n

To test parameter changes, specify a DB parameter group that is different from the one associated \n with the source DB instance.

" + "smithy.api#documentation": "

The DB parameter group associated with the DB instance in the green environment.

\n

To test parameter changes, specify a DB parameter group that is different from the one associated \n with the source DB instance.

" } }, "TargetDBClusterParameterGroupName": { "target": "com.amazonaws.rds#TargetDBClusterParameterGroupName", "traits": { - "smithy.api#documentation": "

The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

\n

To test parameter changes, specify a DB cluster parameter group that is different from the one associated \n with the source DB cluster.

" + "smithy.api#documentation": "

The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

\n

To test parameter changes, specify a DB cluster parameter group that is different from the one associated \n with the source DB cluster.

" } }, "Tags": { @@ -4418,7 +4456,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": { @@ -4454,7 +4492,7 @@ "KMSKeyId": { "target": "com.amazonaws.rds#KmsKeyIdOrArn", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.

\n

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.

\n

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

", + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.

\n

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.

\n

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

", "smithy.api#required": {} } }, @@ -4467,7 +4505,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": {} } }, @@ -4541,7 +4579,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.

\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#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.

\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": { @@ -4573,7 +4611,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action applies only to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action applies only to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#CreateDBClusterEndpointMessage": { @@ -4626,267 +4664,267 @@ "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

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": "

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

" + "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 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

" + "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

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

" + "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

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

" + "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

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": { "target": "com.amazonaws.rds#TagList", "traits": { - "smithy.api#documentation": "

Tags to assign to the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Tags to assign to the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "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": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n \n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned 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\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 run in the source Amazon Web Services Region.

\n \n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned 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\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 run 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

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 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

" + "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

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\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

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\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": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" } }, "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

" } }, "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "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

" + "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 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

" + "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 and Multi-AZ DB clusters

" + "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

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": { "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

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" } }, "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

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.m6gd.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

" + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.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": { "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

This setting is required to create a Multi-AZ DB cluster.

\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

This setting is required to create a Multi-AZ DB cluster.

\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

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

" + "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 \n Amazon RDS Provisioned IOPS storage \n 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

" + "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 \n Amazon RDS Provisioned IOPS storage \n 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": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for: Multi-AZ DB clusters only

" } }, "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for: Multi-AZ DB clusters only

" } }, "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

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": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" } }, "ServerlessV2ScalingConfiguration": { @@ -4895,7 +4933,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" } }, "DBSystemId": { @@ -4926,7 +4964,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

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 that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n 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.

" + "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 that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n 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": { @@ -4935,14 +4973,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": {} } }, @@ -5006,7 +5044,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

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#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": { @@ -5015,14 +5053,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": {} } }, @@ -5116,7 +5154,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB instance.

\n

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

\n

For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

\n

For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Creates a new DB instance.

\n

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

\n

For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

\n

For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#CreateDBInstanceMessage": { @@ -5125,20 +5163,20 @@ "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

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.\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.\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 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, gp3): 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, gp3): 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, gp3): 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, gp3): 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, gp3): 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, gp3):

    \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, gp3): 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, gp3): 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, gp3): 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, gp3): 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, gp3): 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, gp3):

    \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": { @@ -5151,128 +5189,128 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "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#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 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
" + "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 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.

" + "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

This setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.

" + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

This setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.

" } }, "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 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.

" + "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": "

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

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\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.

" + "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

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\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": { "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

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.

" + "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

    It must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    It 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

    It must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    It 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 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 for an RDS Custom for Oracle DB instance

    \n
    • \n
" } }, "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 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
" + "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

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

" + "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.

\n

\n Amazon Aurora\n

\n

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

" + "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.

\n

\n Amazon Aurora\n

\n

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

" } }, "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\n operation.

\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. A valid CEV name 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.

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\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. A valid CEV name 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

Valid values: license-included | bring-your-own-license | general-public-license\n

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + "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.

\n

\n Amazon Aurora\n

\n

Not applicable.

" } }, "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 \n Amazon RDS DB instance storage \n 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.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + "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 \n Amazon RDS DB instance storage \n 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.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" } }, "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.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + "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.

\n

\n Amazon Aurora\n

\n

Not applicable.

" } }, "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This parameter doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This parameter doesn't apply to RDS Custom.

" } }, "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": { @@ -5284,73 +5322,73 @@ "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

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" } }, "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.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + "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.

\n

\n Amazon Aurora\n

\n

Not applicable.

" } }, "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.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" + "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.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" } }, "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.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" + "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.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" } }, "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

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": { @@ -5362,79 +5400,79 @@ "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

For more information, 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.

\n

\n Amazon Aurora\n

\n

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

" + "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, 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.

\n

\n Amazon Aurora\n

\n

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

" } }, "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 RDS User Guide.

\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": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" } }, "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 \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.

" + "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": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" } }, "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 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.

" + "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": { "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.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + "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.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" } } }, @@ -5513,7 +5551,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

Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation 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 " + "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 operation. Call the CreateDBInstance\n operation 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": { @@ -5529,38 +5567,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

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

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

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": { @@ -5572,19 +5610,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 MySQL and Oracle DB instances. \n It 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 MySQL and Oracle DB instances. \n It 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": { @@ -5593,19 +5631,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

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 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

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\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: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, 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": { @@ -5617,67 +5655,67 @@ "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": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\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\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n 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 operation is called that contains\n this presigned URL.

    \n

    For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The 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 operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned 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 run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\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\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n 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 operation is called that contains\n this presigned URL.

    \n

    For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The 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 operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned 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 run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \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

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.

" + "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

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": { "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": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n \n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the new DB instance 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\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The list of logs that the new DB instance 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\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" } }, "DeletionProtection": { @@ -5689,43 +5727,49 @@ "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.

" } }, "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.

" } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

The open mode of the replica database: mounted or read-only.

\n \n

This parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.

" + "smithy.api#documentation": "

The open mode of the replica database: mounted or read-only.

\n \n

This parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.

" } }, "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.

" + "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.

" } }, "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.

" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } } } @@ -5763,7 +5807,7 @@ } ], "traits": { - "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 " + "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": { @@ -5772,14 +5816,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": {} } }, @@ -6016,7 +6060,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " + "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " } }, "com.amazonaws.rds#CreateDBSecurityGroupMessage": { @@ -6025,7 +6069,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": {} } }, @@ -6087,14 +6131,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": {} } }, @@ -6149,7 +6193,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": {} } }, @@ -6218,7 +6262,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation 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

For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

\n

For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation 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

For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

\n

For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#CreateEventSubscriptionMessage": { @@ -6227,7 +6271,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": {} } }, @@ -6241,19 +6285,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\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 You can also see this list by using the DescribeEventCategories operation.

" + "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": { @@ -6301,7 +6345,7 @@ } ], "traits": { - "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 applies only 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 applies only to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#CreateGlobalClusterMessage": { @@ -6376,7 +6420,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": { @@ -6385,14 +6429,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 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": {} } }, @@ -6634,7 +6678,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": { @@ -6737,7 +6781,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": { @@ -6797,19 +6841,19 @@ "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

" } }, "Capacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "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.

" + "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": { "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.

" + "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.

" } }, "ScalingConfigurationInfo": { @@ -6824,7 +6868,7 @@ "HttpEndpointEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "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.

" + "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": { @@ -6842,7 +6886,7 @@ "ActivityStreamKmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\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 identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" } }, "ActivityStreamKinesisStreamName": { @@ -6893,62 +6937,62 @@ "DBClusterInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The storage type associated with the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The storage type associated with the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "Iops": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "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": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates that minor version patches are applied automatically.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

A value that indicates that minor version patches are applied automatically.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "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

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "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.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "PerformanceInsightsEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

True if Performance Insights is enabled for the DB cluster, and otherwise false.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

True if Performance Insights is enabled for the DB cluster, and otherwise false.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "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

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "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

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "ServerlessV2ScalingConfiguration": { @@ -6957,7 +7001,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

" } }, "DBSystemId": { @@ -6968,7 +7012,7 @@ } }, "traits": { - "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

" + "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": { @@ -7024,7 +7068,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
" } } }, @@ -7178,7 +7222,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": { @@ -7414,7 +7458,7 @@ } }, "traits": { - "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.

" + "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": { @@ -7452,7 +7496,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 " } } }, @@ -7526,7 +7570,7 @@ "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": { @@ -7649,7 +7693,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": { @@ -7712,7 +7756,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": { @@ -7745,7 +7789,7 @@ } }, "traits": { - "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.

" + "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": { @@ -7771,18 +7815,18 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the manual DB cluster 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 ModifyDBClusterSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

The name of the manual DB cluster 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 ModifyDBClusterSnapshotAttribute\n API action.

" } }, "AttributeValues": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

The value(s) for the manual DB cluster 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 cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" + "smithy.api#documentation": "

The value(s) for the manual DB cluster 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 cluster snapshot. If a value of all is in the list, then the manual DB cluster 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 cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

Contains the name and values of a manual DB cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" } }, "com.amazonaws.rds#DBClusterSnapshotAttributeList": { @@ -7811,7 +7855,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" } }, "com.amazonaws.rds#DBClusterSnapshotList": { @@ -7952,7 +7996,7 @@ "SupportedFeatureNames": { "target": "com.amazonaws.rds#FeatureNameList", "traits": { - "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.

" + "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": { @@ -8085,7 +8129,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": { @@ -8103,13 +8147,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": { @@ -8221,13 +8265,13 @@ "ReadReplicaDBClusterIdentifiers": { "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

\n " + "smithy.api#documentation": "

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

\n " } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n \n

This attribute is only supported in RDS for Oracle.

\n " + "smithy.api#documentation": "

The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n \n

This attribute is only supported in RDS for Oracle.

\n " } }, "LicenseModel": { @@ -8270,7 +8314,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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": { @@ -8314,7 +8358,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "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.

" + "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": { @@ -8339,7 +8383,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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": { @@ -8382,7 +8426,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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
" + "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": { @@ -8394,19 +8438,19 @@ "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.

" + "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.

" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
" } }, "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n

" } }, "ProcessorFeatures": { @@ -8452,7 +8496,7 @@ "CustomerOwnedIpEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "AwsBackupRecoveryPointArn": { @@ -8506,7 +8550,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.

" + "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": { @@ -8518,7 +8562,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" } }, "ActivityStreamPolicyStatus": { @@ -8530,7 +8574,7 @@ "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" + "smithy.api#documentation": "

Specifies the storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" } }, "DBSystemId": { @@ -8541,7 +8585,7 @@ } }, "traits": { - "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.

" + "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": { @@ -8604,14 +8648,14 @@ "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": { "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" + "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" } }, "AvailabilityZone": { @@ -8690,7 +8734,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": { @@ -8891,7 +8935,7 @@ "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
" } } }, @@ -9047,7 +9091,7 @@ } }, "traits": { - "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.

" + "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": { @@ -9161,7 +9205,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": { @@ -9267,7 +9311,7 @@ "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "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": { @@ -9291,7 +9335,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": { @@ -9383,7 +9427,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": { @@ -9674,7 +9718,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": { @@ -9748,7 +9792,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": { @@ -9832,7 +9876,7 @@ } }, "traits": { - "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.

" + "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": { @@ -9869,7 +9913,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": { @@ -10112,7 +10156,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "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.

" + "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": { @@ -10158,7 +10202,7 @@ "SnapshotDatabaseTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

\n

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.

" + "smithy.api#documentation": "

The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

\n

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.

" } }, "SnapshotTarget": { @@ -10175,7 +10219,7 @@ } }, "traits": { - "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.

" + "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": { @@ -10201,18 +10245,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": { @@ -10241,7 +10285,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": { @@ -10332,12 +10376,12 @@ "SupportedNetworkTypes": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

The network type of the DB subnet group.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB subnet group.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } } }, "traits": { - "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.

" + "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": { @@ -10515,7 +10559,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + "smithy.api#documentation": "

Deletes a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" } }, "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest": { @@ -10524,7 +10568,7 @@ "BlueGreenDeploymentIdentifier": { "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", "traits": { - "smithy.api#documentation": "

The blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.

\n

Constraints:\n

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", + "smithy.api#documentation": "

The blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.

\n

Constraints:\n

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -10561,7 +10605,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": { @@ -10609,7 +10653,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

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#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": { @@ -10632,7 +10676,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": { @@ -10653,7 +10697,7 @@ "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": {} } }, @@ -10661,13 +10705,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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": "

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
" + "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
" } } }, @@ -10692,7 +10736,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

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#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": { @@ -10701,7 +10745,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": {} } } @@ -10735,7 +10779,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

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#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": { @@ -10744,7 +10788,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": {} } } @@ -10790,7 +10834,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

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.

" + "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": { @@ -10825,7 +10869,7 @@ "DBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" } } }, @@ -10847,7 +10891,7 @@ "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": {} } }, @@ -10855,13 +10899,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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": "

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
" + "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": { @@ -10909,7 +10953,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": {} } } @@ -11021,7 +11065,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a DB security group.

\n

The specified DB security group must not be associated with any DB instances.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " + "smithy.api#documentation": "

Deletes a DB security group.

\n

The specified DB security group must not be associated with any DB instances.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " } }, "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { @@ -11030,7 +11074,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": {} } } @@ -11056,7 +11100,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": { @@ -11065,7 +11109,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": {} } } @@ -11102,7 +11146,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": { @@ -11111,7 +11155,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": {} } } @@ -11180,7 +11224,7 @@ } ], "traits": { - "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 " + "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": { @@ -11229,7 +11273,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": {} } } @@ -11307,7 +11351,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": { @@ -11331,7 +11375,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about blue/green deployments.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

", + "smithy.api#documentation": "

Returns information about blue/green deployments.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11346,13 +11390,13 @@ "BlueGreenDeploymentIdentifier": { "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", "traits": { - "smithy.api#documentation": "

The blue/green deployment identifier. If this parameter is specified, information from only the \n specific blue/green deployment is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing blue/green deployment identifier.

    \n
    • \n
" + "smithy.api#documentation": "

The blue/green deployment identifier. If this parameter is specified, information from only the \n specific blue/green deployment is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing blue/green deployment identifier.

    \n
    • \n
" } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

A filter that specifies one or more blue/green deployments to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n blue-green-deployment-identifier - Accepts system-generated\n identifiers for blue/green deployments. The results list only includes\n information about the blue/green deployments with the specified\n identifiers.

    \n
    • \n
  • \n

    \n blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. \n The results list only includes information about the blue/green deployments with the \n specified names.

    \n
    • \n
  • \n

    \n source - Accepts source databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified source databases.

    \n
    • \n
  • \n

    \n target - Accepts target databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified target databases.

    \n
    • \n
" + "smithy.api#documentation": "

A filter that specifies one or more blue/green deployments to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n blue-green-deployment-identifier - Accepts system-generated\n identifiers for blue/green deployments. The results list only includes\n information about the blue/green deployments with the specified\n identifiers.

    \n
    • \n
  • \n

    \n blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. \n The results list only includes information about the blue/green deployments with the \n specified names.

    \n
    • \n
  • \n

    \n source - Accepts source databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified source databases.

    \n
    • \n
  • \n

    \n target - Accepts target databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified target databases.

    \n
    • \n
" } }, "Marker": { @@ -11364,7 +11408,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "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

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.

" } } } @@ -11415,7 +11459,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": { @@ -11427,7 +11471,7 @@ "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

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": { @@ -11458,7 +11502,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

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", @@ -11473,26 +11517,26 @@ "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

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": { @@ -11520,7 +11564,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", @@ -11553,7 +11597,7 @@ "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

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": { @@ -11578,7 +11622,7 @@ } ], "traits": { - "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#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", @@ -11593,7 +11637,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": { @@ -11605,7 +11649,7 @@ "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

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": { @@ -11633,7 +11677,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

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#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", @@ -11648,7 +11692,7 @@ "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": {} } }, @@ -11667,7 +11711,7 @@ "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

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": { @@ -11695,7 +11739,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\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 cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster 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 cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

" + "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\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 cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster 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 cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

" } }, "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage": { @@ -11735,7 +11779,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

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#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", @@ -11878,31 +11922,31 @@ "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

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

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

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": { @@ -11915,14 +11959,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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 cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" + "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 cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" + "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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" } } }, @@ -11944,7 +11988,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

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#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", @@ -12087,19 +12131,19 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n 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 or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n 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 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

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": { @@ -12144,31 +12188,31 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "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
" + "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 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
" + "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": "

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.

" + "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": { @@ -12187,13 +12231,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.

" + "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

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.

" + "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": { @@ -12218,7 +12262,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

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", @@ -12245,7 +12289,7 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "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.

" + "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": { @@ -12263,7 +12307,7 @@ "DBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" } } }, @@ -12285,7 +12329,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", @@ -12431,19 +12475,19 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n 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 or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n 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": "

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.

" + "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": { @@ -12471,7 +12515,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", @@ -12523,7 +12567,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": {} } }, @@ -12619,7 +12663,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": { @@ -12631,7 +12675,7 @@ "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 that\n 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.\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": { @@ -12674,14 +12718,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": { @@ -12693,7 +12737,7 @@ "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 that\n 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.\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": { @@ -12751,7 +12795,7 @@ "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.

" } } } @@ -12829,7 +12873,7 @@ "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.

" } } } @@ -12911,7 +12955,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "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 that the remaining\n 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.\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.

" } } } @@ -12996,7 +13040,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "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 that the remaining\n 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.\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.

" } } } @@ -13032,7 +13076,7 @@ } ], "traits": { - "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.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\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.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13059,7 +13103,7 @@ "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 that\n 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.\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": { @@ -13087,7 +13131,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": { @@ -13273,31 +13317,31 @@ "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 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 ID of the DB instance to retrieve the list of DB snapshots for. \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": "

A specific DB snapshot identifier to describe.\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
" + "smithy.api#documentation": "

A specific DB snapshot identifier to describe.\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": "

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.

" + "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": { @@ -13310,14 +13354,14 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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#default": false, - "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": { @@ -13345,7 +13389,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.

", + "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", @@ -13372,7 +13416,7 @@ "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 that\n 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.\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": { @@ -13395,7 +13439,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.

" + "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": { @@ -13417,7 +13461,7 @@ "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

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": { @@ -13463,7 +13507,7 @@ "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora5.6\n

    \n
    • \n
  • \n

    \n aurora-mysql5.7\n

    \n
    • \n
  • \n

    \n aurora-mysql8.0\n

    \n
    • \n
  • \n

    \n aurora-postgresql10\n

    \n
    • \n
  • \n

    \n aurora-postgresql11\n

    \n
    • \n
  • \n

    \n aurora-postgresql12\n

    \n
    • \n
  • \n

    \n aurora-postgresql13\n

    \n
    • \n
  • \n

    \n aurora-postgresql14\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-19\n

    \n
    • \n
  • \n

    \n mariadb10.2\n

    \n
    • \n
  • \n

    \n mariadb10.3\n

    \n
    • \n
  • \n

    \n mariadb10.4\n

    \n
    • \n
  • \n

    \n mariadb10.5\n

    \n
    • \n
  • \n

    \n mariadb10.6\n

    \n
    • \n
  • \n

    \n mysql5.7\n

    \n
    • \n
  • \n

    \n mysql8.0\n

    \n
    • \n
  • \n

    \n oracle-ee-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-21\n

    \n
    • \n
  • \n

    \n oracle-se2-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-21\n

    \n
    • \n
  • \n

    \n postgres10\n

    \n
    • \n
  • \n

    \n postgres11\n

    \n
    • \n
  • \n

    \n postgres12\n

    \n
    • \n
  • \n

    \n postgres13\n

    \n
    • \n
  • \n

    \n postgres14\n

    \n
    • \n
  • \n

    \n sqlserver-ee-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-15.0\n

    \n
    • \n
", + "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora5.6\n

    \n
    • \n
  • \n

    \n aurora-mysql5.7\n

    \n
    • \n
  • \n

    \n aurora-mysql8.0\n

    \n
    • \n
  • \n

    \n aurora-postgresql10\n

    \n
    • \n
  • \n

    \n aurora-postgresql11\n

    \n
    • \n
  • \n

    \n aurora-postgresql12\n

    \n
    • \n
  • \n

    \n aurora-postgresql13\n

    \n
    • \n
  • \n

    \n aurora-postgresql14\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-19\n

    \n
    • \n
  • \n

    \n mariadb10.2\n

    \n
    • \n
  • \n

    \n mariadb10.3\n

    \n
    • \n
  • \n

    \n mariadb10.4\n

    \n
    • \n
  • \n

    \n mariadb10.5\n

    \n
    • \n
  • \n

    \n mariadb10.6\n

    \n
    • \n
  • \n

    \n mysql5.7\n

    \n
    • \n
  • \n

    \n mysql8.0\n

    \n
    • \n
  • \n

    \n oracle-ee-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-21\n

    \n
    • \n
  • \n

    \n oracle-se2-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-21\n

    \n
    • \n
  • \n

    \n postgres10\n

    \n
    • \n
  • \n

    \n postgres11\n

    \n
    • \n
  • \n

    \n postgres12\n

    \n
    • \n
  • \n

    \n postgres13\n

    \n
    • \n
  • \n

    \n postgres14\n

    \n
    • \n
  • \n

    \n sqlserver-ee-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-15.0\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -13476,7 +13520,7 @@ "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

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": { @@ -13507,7 +13551,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 .

" + "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": { @@ -13516,7 +13560,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": { @@ -13544,7 +13588,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", @@ -13571,7 +13615,7 @@ "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 that\n 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.\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": { @@ -13594,7 +13638,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

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

\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

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13609,7 +13653,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": { @@ -13621,19 +13665,19 @@ "StartTime": { "target": "com.amazonaws.rds#TStamp", "traits": { - "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

" + "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": "

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": { @@ -13651,7 +13695,7 @@ "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 that\n 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.\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": { @@ -13706,7 +13750,7 @@ "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": { @@ -13718,7 +13762,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#MaxRecords", "traits": { - "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.

" + "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.

" } }, "SourceType": { @@ -13743,7 +13787,7 @@ } ], "traits": { - "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#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", @@ -13758,7 +13802,7 @@ "GlobalClusterIdentifier": { "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": { @@ -13770,7 +13814,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 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.

" + "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": { @@ -13805,7 +13849,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 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": {} } }, @@ -13824,7 +13868,7 @@ "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 that\n 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.\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": { @@ -13885,13 +13929,13 @@ "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 that\n 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.\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 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": { @@ -13929,7 +13973,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 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": {} } }, @@ -13948,19 +13992,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": { @@ -13972,7 +14016,7 @@ "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 that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 10000.

" + "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 10000.

" } }, "Marker": { @@ -14021,7 +14065,7 @@ "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": { @@ -14033,7 +14077,7 @@ "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 that\n 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.\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.

" } } }, @@ -14088,7 +14132,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": { @@ -14100,7 +14144,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": { @@ -14112,7 +14156,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": { @@ -14124,7 +14168,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "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.

" + "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": { @@ -14167,7 +14211,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": { @@ -14179,19 +14223,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": { @@ -14209,7 +14253,7 @@ "MaxRecords": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "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.

" + "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": { @@ -14232,7 +14276,7 @@ "target": "com.amazonaws.rds#SourceRegionMessage" }, "traits": { - "smithy.api#documentation": "

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.

\n

Use this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.

\n

To return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.

", + "smithy.api#documentation": "

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.

\n

Use this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.

\n

To return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -14247,13 +14291,13 @@ "RegionName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The source Amazon Web Services Region name. For example, us-east-1.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid Amazon Web Services Region name.

    \n
    • \n
" + "smithy.api#documentation": "

The source Amazon Web Services Region name. For example, us-east-1.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid Amazon Web Services Region name.

    \n
    • \n
" } }, "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": { @@ -14290,7 +14334,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

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": { @@ -14441,7 +14485,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", @@ -14482,7 +14526,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": {} } }, @@ -14503,7 +14547,7 @@ "target": "com.amazonaws.rds#Integer", "traits": { "smithy.api#default": 0, - "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
" } } }, @@ -14540,7 +14584,7 @@ } }, "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": { @@ -14576,7 +14620,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": { @@ -14763,7 +14807,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": { @@ -14912,7 +14956,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": { @@ -14997,7 +15041,7 @@ } }, "traits": { - "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.

" + "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": { @@ -15080,7 +15124,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 readable 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.

" + "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 readable 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": { @@ -15089,14 +15133,14 @@ "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": {} } }, "TargetDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB instance to promote to the primary DB instance.

\n

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.

\n

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The name of the DB instance to promote to the primary DB instance.

\n

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.

\n

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

" } } }, @@ -15135,7 +15179,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

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 " + "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": { @@ -15144,7 +15188,7 @@ "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": {} } }, @@ -15171,7 +15215,7 @@ "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

    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
" + "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": { @@ -15239,7 +15283,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": { @@ -16127,6 +16171,9 @@ "target": "com.amazonaws.rds#TagListMessage" }, "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, @@ -16144,7 +16191,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": { @@ -16241,7 +16288,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.

\n

This operation is supported for RDS for Oracle only.

" + "smithy.api#documentation": "

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.

\n

This operation is supported for RDS for Oracle only.

" } }, "com.amazonaws.rds#ModifyActivityStreamRequest": { @@ -16316,7 +16363,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, 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, 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": { @@ -16325,7 +16372,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": { @@ -16364,7 +16411,7 @@ } ], "traits": { - "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 " + "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": { @@ -16373,26 +16420,26 @@ "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:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", + "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", "smithy.api#required": {} } }, "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 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
" + "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 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.

" + "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": { "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, 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 to take when the timeout is reached, either ForceApplyCapacityChange or 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.

" } } } @@ -16414,7 +16461,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": { @@ -16443,7 +16490,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.

" + "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.

" } } } @@ -16495,7 +16542,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

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#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": { @@ -16524,7 +16571,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": { @@ -16563,208 +16610,208 @@ "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#default": false, - "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

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

" + "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

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

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. 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

" + "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": { "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 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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "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 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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "AllowMajorVersionUpgrade": { "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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

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 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": { "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

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for: Aurora DB clusters only

" } }, "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 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

" + "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 and Multi-AZ DB clusters

" + "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

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.m6gd.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

" + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.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

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

" + "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 \n Amazon RDS Provisioned IOPS storage \n 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

" + "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 \n Amazon RDS Provisioned IOPS storage \n 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": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for: Multi-AZ DB clusters only

" } }, "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is 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 value.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is 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 value.

\n

Valid for: Multi-AZ DB clusters only

" } }, "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

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": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" } }, "ServerlessV2ScalingConfiguration": { @@ -16773,7 +16820,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" } } }, @@ -16798,7 +16845,7 @@ } ], "traits": { - "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 operation 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

" + "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 operation 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": { @@ -16814,7 +16861,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": {} } } @@ -16851,7 +16898,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

" + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

" } }, "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { @@ -16867,20 +16914,20 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.

\n ", + "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.

\n ", "smithy.api#required": {} } }, "ValuesToAdd": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster 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 cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster 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 cluster 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 DB cluster 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 cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" + "smithy.api#documentation": "

A list of DB cluster 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 DB cluster 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 cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" } } }, @@ -16976,238 +17023,238 @@ "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

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.

" + "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. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and \n availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

\n

If you modify the DB instance class, an outage occurs during the change. 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

" + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.

\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 \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

" + "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#default": false, - "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.

" + "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

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 operations 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 " + "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 operations 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 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 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": "

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
" + "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

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": "

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.

" + "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#default": false, - "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" + "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" } }, "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

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

" + "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

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

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: gp2 | gp3 | io1 | standard\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: gp2 | gp3 | io1 | standard\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

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

" + "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

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.

" + "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

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 RDS User Guide.

\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": { "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": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" } }, "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 \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom.

" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" } }, "DeletionProtection": { @@ -17219,31 +17266,31 @@ "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.

" } }, "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": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom.

" } }, "AutomationMode": { @@ -17261,13 +17308,13 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" } } }, @@ -17300,7 +17347,7 @@ } ], "traits": { - "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 " + "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": { @@ -17309,14 +17356,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": {} } } @@ -17553,7 +17600,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

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

" + "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": { @@ -17576,7 +17623,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 operation. 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 operation. The accounts are returned as\n values for the restore attribute.

" } }, "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { @@ -17592,20 +17639,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 operation.

\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 operation.

\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.

" } } }, @@ -17634,13 +17681,13 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "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.

" + "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

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

" } } } @@ -17688,7 +17735,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

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": {} } }, @@ -17747,7 +17794,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": { @@ -17769,7 +17816,7 @@ "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": { @@ -17820,7 +17867,7 @@ } ], "traits": { - "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 " + "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": { @@ -17829,13 +17876,13 @@ "GlobalClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "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
" + "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": "

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

" + "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": { @@ -17847,13 +17894,13 @@ "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.

" } } } @@ -17892,7 +17939,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": {} } }, @@ -18112,7 +18159,25 @@ "OptionGroupArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the option group.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the option group.

" + } + }, + "SourceOptionGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group from which this option group is copied.

" + } + }, + "SourceAccountId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

" + } + }, + "CopyTimestamp": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Indicates when the option group was copied.

" } } }, @@ -18286,6 +18351,12 @@ "traits": { "smithy.api#documentation": "

The versions that are available for the option.

" } + }, + "CopyableCrossAccount": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the option can be copied across Amazon Web Services accounts.

" + } } }, "traits": { @@ -18744,7 +18815,7 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether a DB instance supports RDS on Outposts.

\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": "

Whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" } }, "SupportedActivityStreamModes": { @@ -18764,13 +18835,13 @@ "target": "com.amazonaws.rds#Boolean", "traits": { "smithy.api#default": false, - "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

" + "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

" } }, "SupportedNetworkTypes": { "target": "com.amazonaws.rds#StringList", "traits": { - "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "SupportsStorageThroughput": { @@ -18806,7 +18877,7 @@ } }, "traits": { - "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.

" + "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": { @@ -18849,7 +18920,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": { @@ -18924,7 +18995,7 @@ } }, "traits": { - "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.

" + "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": { @@ -18974,7 +19045,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": { @@ -19086,7 +19157,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The license model for the DB instance.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" + "smithy.api#documentation": "

The license model for the DB instance.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" } }, "Iops": { @@ -19191,7 +19262,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": { @@ -19220,7 +19291,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 " + "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": { @@ -19249,7 +19320,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": {} } } @@ -19272,20 +19343,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": "

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
" + "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
" } } }, @@ -19347,20 +19418,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": { @@ -19469,7 +19540,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

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

" + "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": { @@ -19478,7 +19549,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": {} } } @@ -19509,7 +19580,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

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.

\n

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

" + "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.

\n

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

" } }, "com.amazonaws.rds#RebootDBInstanceMessage": { @@ -19518,14 +19589,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": "

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.

" + "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.

" } } }, @@ -19673,7 +19744,7 @@ } ], "traits": { - "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 " + "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": { @@ -19721,7 +19792,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

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { @@ -19857,6 +19928,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, @@ -19874,7 +19948,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": { @@ -20017,7 +20091,7 @@ "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 " } } }, @@ -20240,7 +20314,7 @@ } ], "traits": { - "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

" + "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": { @@ -20297,7 +20371,7 @@ "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": {} } }, @@ -20311,7 +20385,7 @@ "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

" } } }, @@ -20409,7 +20483,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

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": { @@ -20424,7 +20498,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": { @@ -20442,14 +20516,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

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": { @@ -20461,58 +20535,58 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with the restored DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

A DB subnet group to associate with the restored DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" } }, "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) and aurora-mysql \n (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

", + "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) and aurora-mysql \n (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

", "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

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,\n 8.0.mysql_aurora.3.02.0\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

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,\n 8.0.mysql_aurora.3.02.0\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

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": {} } }, "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.

", + "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.

", "smithy.api#required": {} } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

\n

Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

" + "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

\n

Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

" } }, "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

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
" + "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

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": { @@ -20527,26 +20601,26 @@ "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

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use 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.

" + "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

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use 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.

" } }, "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.

" + "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

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

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": {} } }, @@ -20573,13 +20647,13 @@ "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.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" } }, "DeletionProtection": { @@ -20597,7 +20671,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

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.

" + "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": { @@ -20612,7 +20686,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" } } } @@ -20690,7 +20764,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

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { @@ -20699,160 +20773,160 @@ "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 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

" + "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

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

\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

" + "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": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" } }, "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": { "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

" } }, "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 and Multi-AZ DB clusters

" + "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": { "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

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\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, for example db.m6gd.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.m6gd.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

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

" + "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, \n see Amazon RDS Provisioned IOPS storage \n 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

" + "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, \n see Amazon RDS Provisioned IOPS storage \n 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

" } }, "ServerlessV2ScalingConfiguration": { @@ -20861,7 +20935,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" } } }, @@ -20942,7 +21016,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

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { @@ -20951,58 +21025,58 @@ "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#default": false, - "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

" + "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

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": { @@ -21011,91 +21085,91 @@ "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

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

\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

" + "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": { "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

" } }, "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 and Multi-AZ DB clusters

" + "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

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": "

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": { "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

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" } }, "ScalingConfiguration": { "target": "com.amazonaws.rds#ScalingConfiguration", "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" } }, "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 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

" + "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.m6gd.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.m6gd.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

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

" + "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, \n see Amazon RDS Provisioned IOPS storage \n 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

" + "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, \n see Amazon RDS Provisioned IOPS storage \n 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

" } }, "ServerlessV2ScalingConfiguration": { @@ -21104,7 +21178,7 @@ "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" } } }, @@ -21197,7 +21271,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": { @@ -21206,86 +21280,86 @@ "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

    Can't be specified when DBClusterSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBClusterSnapshotIdentifier isn't specified.

    \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

    Can't be specified when DBClusterSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBClusterSnapshotIdentifier isn't specified.

    \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
" } }, "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

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

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#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

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \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 \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 \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

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": { @@ -21294,73 +21368,73 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\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: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, 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": "

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.

" + "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

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": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance 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 RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The list of logs that the restored DB instance 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 RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\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 don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \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 don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \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
" } }, "DeletionProtection": { @@ -21372,37 +21446,37 @@ "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" } }, "DBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.

\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

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Multi-AZ DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be specified when DBSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBSnapshotIdentifier isn't specified.

    \n
    • \n
  • \n

    If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier\n must be the ARN of the shared snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an Aurora DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

    \n
    • \n
" + "smithy.api#documentation": "

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.

\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

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Multi-AZ DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be specified when DBSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBSnapshotIdentifier isn't specified.

    \n
    • \n
  • \n

    If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier\n must be the ARN of the shared snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an Aurora DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

    \n
    • \n
" } } }, @@ -21483,7 +21557,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": { @@ -21498,46 +21572,46 @@ "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 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 " + "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.

", + "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

Valid Values: \n 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

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 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

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": { "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": { @@ -21549,25 +21623,25 @@ "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

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.

" + "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\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 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
" + "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": { "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 the default DBParameterGroup \n for the specified DB engine is used.

" + "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 the default DBParameterGroup \n for the specified DB engine is used.

" } }, "BackupRetentionPeriod": { @@ -21579,13 +21653,13 @@ "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

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

Type: Integer

\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": { @@ -21627,7 +21701,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 \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": { @@ -21639,7 +21713,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, \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

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, \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": { @@ -21651,7 +21725,7 @@ "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

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.

" + "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": { @@ -21663,32 +21737,32 @@ "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

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

" + "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.

" + "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

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

Valid Values: \n 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

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": {} } }, @@ -21715,19 +21789,19 @@ "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 RDS User Guide.

" + "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": { "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.

" + "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.

" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

" + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

" } }, "EnableCloudwatchLogsExports": { @@ -21757,19 +21831,19 @@ "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.

" + "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.

" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" } } } @@ -21862,7 +21936,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

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": { @@ -21871,99 +21945,99 @@ "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#default": false, - "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.

" + "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

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

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

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#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 \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

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": { @@ -21978,67 +22052,67 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\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: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, 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": "

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.

" + "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

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

" + "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": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance 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 RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The list of logs that the restored DB instance 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 RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

\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 the default DBParameterGroup \n for the specified DB engine is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \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 the default DBParameterGroup \n for the specified DB engine is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \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
" } }, "DeletionProtection": { @@ -22056,43 +22130,43 @@ "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "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": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" } }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" } }, "StorageThroughput": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" } } }, @@ -22148,7 +22222,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " + "smithy.api#documentation": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " } }, "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { @@ -22255,42 +22329,42 @@ "MinCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The minimum capacity must be less than or equal to the maximum capacity.

" + "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The minimum capacity must be less than or equal to the maximum capacity.

" } }, "MaxCapacity": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The maximum capacity must be greater than or equal to the minimum capacity.

" + "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The maximum capacity must be greater than or equal to the minimum capacity.

" } }, "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": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

\n

Specify a value between 300 and 86,400 seconds.

" + "smithy.api#documentation": "

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

\n

Specify a value between 300 and 86,400 seconds.

" } }, "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 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.

" + "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 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.

" + "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 v1 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v1 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": { @@ -22311,7 +22385,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 v1 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": { @@ -22323,7 +22397,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 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.

" + "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": { @@ -22334,7 +22408,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 v1 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#ServerlessV2ScalingConfiguration": { @@ -22354,7 +22428,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { @@ -22374,7 +22448,7 @@ } }, "traits": { - "smithy.api#documentation": "

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { @@ -22583,6 +22657,12 @@ "traits": { "smithy.api#enumValue": "db-proxy" } + }, + "blue_green_deployment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blue-green-deployment" + } } } }, @@ -22718,7 +22798,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

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 " + "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": { @@ -22785,7 +22865,7 @@ } ], "traits": { - "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 " + "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": { @@ -22814,7 +22894,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables replication of automated backups to a different Amazon Web Services Region.

\n

This command doesn't apply to RDS Custom.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Enables replication of automated backups to a different Amazon Web Services Region.

\n

This command doesn't apply to RDS Custom.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { @@ -22842,7 +22922,7 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\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\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 run in the source Amazon Web Services Region.

\n " + "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\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\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 run in the source Amazon Web Services Region.

\n " } } } @@ -22916,7 +22996,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

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": { @@ -22953,7 +23033,7 @@ "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": {} } }, @@ -22966,7 +23046,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
" } } } @@ -22997,7 +23077,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

\n

For more information, see \n Database Activity Streams\n in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

\n

For more information, see \n Database Activity Streams\n in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#StopActivityStreamRequest": { @@ -23024,7 +23104,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\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 identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" } }, "KinesisStreamName": { @@ -23061,7 +23141,7 @@ } ], "traits": { - "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 " + "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": { @@ -23110,7 +23190,7 @@ } ], "traits": { - "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 " + "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": { @@ -23130,7 +23210,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { @@ -23247,7 +23327,7 @@ "SubnetOutpost": { "target": "com.amazonaws.rds#Outpost", "traits": { - "smithy.api#documentation": "

If the subnet is associated with an Outpost, this value specifies the 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": "

If the subnet is associated with an Outpost, this value specifies the 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

" } }, "SubnetStatus": { @@ -23382,7 +23462,7 @@ } ], "traits": { - "smithy.api#documentation": "

Switches over a blue/green deployment.

\n

Before you switch over, production traffic is routed to the databases in the blue environment. \n After you switch over, production traffic is routed to the databases in the green environment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + "smithy.api#documentation": "

Switches over a blue/green deployment.

\n

Before you switch over, production traffic is routed to the databases in the blue environment. \n After you switch over, production traffic is routed to the databases in the green environment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" } }, "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest": { @@ -23391,14 +23471,14 @@ "BlueGreenDeploymentIdentifier": { "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", "traits": { - "smithy.api#documentation": "

The blue/green deployment identifier.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", + "smithy.api#documentation": "

The blue/green deployment identifier.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", "smithy.api#required": {} } }, "SwitchoverTimeout": { "target": "com.amazonaws.rds#SwitchoverTimeout", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, for the switchover to complete. The default is 300.

\n

If the switchover takes longer than the specified duration, then any changes are rolled back, \n and no changes are made to the environments.

" + "smithy.api#documentation": "

The amount of time, in seconds, for the switchover to complete. The default is 300.

\n

If the switchover takes longer than the specified duration, then any changes are rolled back, \n and no changes are made to the environments.

" } } } @@ -23429,12 +23509,12 @@ "Status": { "target": "com.amazonaws.rds#SwitchoverDetailStatus", "traits": { - "smithy.api#documentation": "

The switchover status of a resource in a blue/green deployment.

\n

Values:

\n
    \n
  • \n

    \n preparing-for-switchover - The resource is being prepared to switch over.

    \n
    • \n
  • \n

    \n ready-for-switchover - The resource is ready to switch\n over.

    \n
    • \n
  • \n

    \n switchover-in-progress - The resource is being switched over.

    \n
    • \n
  • \n

    \n switchover-completed - The resource has been switched over.

    \n
    • \n
  • \n

    \n switchover-failed - The resource attempted to switch over but failed.

    \n
    • \n
" + "smithy.api#documentation": "

The switchover status of a resource in a blue/green deployment.

\n

Values:

\n
    \n
  • \n

    \n preparing-for-switchover - The resource is being prepared to switch over.

    \n
    • \n
  • \n

    \n ready-for-switchover - The resource is ready to switch\n over.

    \n
    • \n
  • \n

    \n switchover-in-progress - The resource is being switched over.

    \n
    • \n
  • \n

    \n switchover-completed - The resource has been switched over.

    \n
    • \n
  • \n

    \n switchover-failed - The resource attempted to switch over but failed.

    \n
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" } }, "com.amazonaws.rds#SwitchoverDetailList": { @@ -23472,7 +23552,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Oracle read replica DB instance.

    \n
    • \n
", + "smithy.api#documentation": "

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Oracle read replica DB instance.

    \n
    • \n
", "smithy.api#required": {} } } @@ -23514,7 +23594,7 @@ } }, "traits": { - "smithy.api#documentation": "

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#TagList": { @@ -23585,7 +23665,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 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": { @@ -23825,6 +23905,12 @@ "traits": { "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" } + }, + "ClientPasswordAuthType": { + "target": "com.amazonaws.rds#ClientPasswordAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + } } }, "traits": { @@ -23863,6 +23949,12 @@ "traits": { "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" } + }, + "ClientPasswordAuthType": { + "target": "com.amazonaws.rds#ClientPasswordAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + } } }, "traits": { @@ -23991,7 +24083,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The membership status of the VPC security group.

\n

Currently, the only valid status is active.

" + "smithy.api#documentation": "

The membership status of the VPC security group.

\n

Currently, the only valid status is active.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/redshift-data.2019-12-20.json b/codegen/sdk-codegen/aws-models/redshift-data.2019-12-20.json index 9284991a42c..95c9153a912 100644 --- a/codegen/sdk-codegen/aws-models/redshift-data.2019-12-20.json +++ b/codegen/sdk-codegen/aws-models/redshift-data.2019-12-20.json @@ -34,7 +34,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
" + "smithy.api#documentation": "

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

" } }, "com.amazonaws.redshiftdata#BatchExecuteStatementException": { @@ -66,7 +66,7 @@ "Sqls": { "target": "com.amazonaws.redshiftdata#SqlList", "traits": { - "smithy.api#documentation": "

One or more SQL statements to run.

", + "smithy.api#documentation": "

One or more SQL statements to run. \n \n The SQL statements are run as a single transaction. They run serially in the order of the array. \n Subsequent SQL statements don't start until the previous statement in the array completes. \n If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

", "smithy.api#required": {} } }, @@ -112,6 +112,13 @@ "traits": { "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" } + }, + "ClientToken": { + "target": "com.amazonaws.redshiftdata#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } } } }, @@ -197,7 +204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a running query. To be canceled, a query must be running.

" + "smithy.api#documentation": "

Cancels a running query. To be canceled, a query must be running.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

" } }, "com.amazonaws.redshiftdata#CancelStatementRequest": { @@ -223,6 +230,15 @@ } } }, + "com.amazonaws.redshiftdata#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.redshiftdata#ColumnList": { "type": "list", "member": { @@ -370,7 +386,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information\n includes when the query started, when it finished, the query status, the number of rows returned, and the SQL\n statement.

", + "smithy.api#documentation": "

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information\n includes when the query started, when it finished, the query status, the number of rows returned, and the SQL\n statement.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#readonly": {} } }, @@ -531,12 +547,12 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
", + "smithy.api#documentation": "

Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "ColumnList", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "ColumnList" }, "smithy.api#readonly": {} } @@ -651,7 +667,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
" + "smithy.api#documentation": "

Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

" } }, "com.amazonaws.redshiftdata#ExecuteStatementException": { @@ -736,6 +752,13 @@ "traits": { "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" } + }, + "ClientToken": { + "target": "com.amazonaws.redshiftdata#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } } } }, @@ -856,7 +879,7 @@ } ], "traits": { - "smithy.api#documentation": "

Fetches the temporarily cached result of an SQL statement. \n A token is returned to page through the statement results.

", + "smithy.api#documentation": "

Fetches the temporarily cached result of an SQL statement. \n A token is returned to page through the statement results.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -957,12 +980,12 @@ } ], "traits": { - "smithy.api#documentation": "

List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
", + "smithy.api#documentation": "

List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Databases", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Databases" }, "smithy.api#readonly": {} } @@ -1053,12 +1076,12 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
", + "smithy.api#documentation": "

Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Schemas", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Schemas" }, "smithy.api#readonly": {} } @@ -1158,12 +1181,12 @@ } ], "traits": { - "smithy.api#documentation": "

List of SQL statements. By default, only finished statements are shown. \n A token is returned to page through the statement list.

", + "smithy.api#documentation": "

List of SQL statements. By default, only finished statements are shown. \n A token is returned to page through the statement list.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Statements", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Statements" }, "smithy.api#readonly": {} } @@ -1252,12 +1275,12 @@ } ], "traits": { - "smithy.api#documentation": "

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
", + "smithy.api#documentation": "

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Tables", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Tables" }, "smithy.api#readonly": {} } @@ -1417,17 +1440,14 @@ "traits": { "aws.api#service": { "sdkId": "Redshift Data", - "arnNamespace": "redshift-data", - "cloudFormationName": "RedshiftData", - "cloudTrailEventSource": "redshift-data.amazonaws.com", - "endpointPrefix": "redshift-data" + "arnNamespace": "redshift-data" }, "aws.auth#sigv4": { "name": "redshift-data" }, "aws.protocols#awsJson1_1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run SQL statements, which are committed if the statement succeeds.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Cluster Management Guide.

", + "smithy.api#documentation": "

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run SQL statements, which are committed if the statement succeeds.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#title": "Redshift Data API Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1748,9 +1768,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -1760,9 +1780,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseFIPS": true, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -1772,9 +1792,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, "Endpoint": "https://example.com" } } @@ -1841,7 +1861,7 @@ "value": { "target": "com.amazonaws.redshiftdata#ParameterValue", "traits": { - "smithy.api#documentation": "

The value of the parameter. \n Amazon Redshift implicitly converts to the proper data type. For more inforation, see \n Data types in the \n Amazon Redshift Database Developer Guide.

", + "smithy.api#documentation": "

The value of the parameter. \n Amazon Redshift implicitly converts to the proper data type. For more information, see \n Data types in the \n Amazon Redshift Database Developer Guide.

", "smithy.api#required": {} } } @@ -1961,28 +1981,28 @@ "traits": { "smithy.api#enum": [ { - "value": "SUBMITTED", - "name": "SUBMITTED" + "name": "SUBMITTED", + "value": "SUBMITTED" }, { - "value": "PICKED", - "name": "PICKED" + "name": "PICKED", + "value": "PICKED" }, { - "value": "STARTED", - "name": "STARTED" + "name": "STARTED", + "value": "STARTED" }, { - "value": "FINISHED", - "name": "FINISHED" + "name": "FINISHED", + "value": "FINISHED" }, { - "value": "ABORTED", - "name": "ABORTED" + "name": "ABORTED", + "value": "ABORTED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" } ] } @@ -2001,32 +2021,32 @@ "traits": { "smithy.api#enum": [ { - "value": "SUBMITTED", - "name": "SUBMITTED" + "name": "SUBMITTED", + "value": "SUBMITTED" }, { - "value": "PICKED", - "name": "PICKED" + "name": "PICKED", + "value": "PICKED" }, { - "value": "STARTED", - "name": "STARTED" + "name": "STARTED", + "value": "STARTED" }, { - "value": "FINISHED", - "name": "FINISHED" + "name": "FINISHED", + "value": "FINISHED" }, { - "value": "ABORTED", - "name": "ABORTED" + "name": "ABORTED", + "value": "ABORTED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" }, { - "value": "ALL", - "name": "ALL" + "name": "ALL", + "value": "ALL" } ] } diff --git a/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json b/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json index 363214f5453..ef71f872569 100644 --- a/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json +++ b/codegen/sdk-codegen/aws-models/redshift-serverless.2021-04-21.json @@ -5364,4 +5364,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json index a77238e2005..6c2028f6eab 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json +++ b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json @@ -482,7 +482,7 @@ } ], "traits": { - "smithy.api#documentation": "

Compares a face in the source input image with each of the 100\n largest faces detected in the target input image.

\n

If the source image contains multiple faces, the service detects the largest face and\n compares it with each face detected in the target image.

\n \n

CompareFaces uses machine learning algorithms, which are probabilistic. A false negative\n is an incorrect prediction that a face in the target image has a low similarity confidence\n score when compared to the face in the source image. To reduce the probability of false\n negatives, we recommend that you compare the target image against multiple source images. If\n you plan to use CompareFaces to make a decision that impacts an individual's\n rights, privacy, or access to services, we recommend that you pass the result to a human for\n review and further validation before taking action.

\n \n

You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.

\n

In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.

\n \n

By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.

\n \n

\n CompareFaces also returns an array of faces that don't match the source\n image. For each face, it returns a bounding box, confidence value, landmarks, pose details,\n and quality. The response also returns information about the face in the source image,\n including the bounding box of the face and confidence value.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar by specifying LOW,\n MEDIUM, or HIGH. If you do not want to filter detected faces,\n specify NONE. The default value is NONE.

\n

If the image doesn't contain Exif metadata, CompareFaces returns\n orientation information for the source and target images. Use these values to display the\n images with the correct image orientation.

\n

If no faces are detected in the source or target images, CompareFaces\n returns an InvalidParameterException error.

\n \n

This is a stateless API operation. That is, data returned by this operation doesn't\n persist.

\n \n \n

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer\n Guide.

\n

This operation requires permissions to perform the\n rekognition:CompareFaces action.

" + "smithy.api#documentation": "

Compares a face in the source input image with each of the 100\n largest faces detected in the target input image.

\n

If the source image contains multiple faces, the service detects the largest face and\n compares it with each face detected in the target image.

\n \n

CompareFaces uses machine learning algorithms, which are probabilistic. A false negative\n is an incorrect prediction that a face in the target image has a low similarity confidence\n score when compared to the face in the source image. To reduce the probability of false\n negatives, we recommend that you compare the target image against multiple source images. If\n you plan to use CompareFaces to make a decision that impacts an individual's\n rights, privacy, or access to services, we recommend that you pass the result to a human for\n review and further validation before taking action.

\n \n

You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.

\n

In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.

\n \n

By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.

\n \n

\n CompareFaces also returns an array of faces that don't match the source\n image. For each face, it returns a bounding box, confidence value, landmarks, pose details,\n and quality. The response also returns information about the face in the source image,\n including the bounding box of the face and confidence value.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar by specifying LOW,\n MEDIUM, or HIGH. If you do not want to filter detected faces,\n specify NONE. The default value is NONE.

\n

If the image doesn't contain Exif metadata, CompareFaces returns\n orientation information for the source and target images. Use these values to display the\n images with the correct image orientation.

\n

If no faces are detected in the source or target images, CompareFaces\n returns an InvalidParameterException error.

\n \n

This is a stateless API operation. That is, data returned by this operation doesn't\n persist.

\n \n

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer\n Guide.

\n

This operation requires permissions to perform the\n rekognition:CompareFaces action.

" } }, "com.amazonaws.rekognition#CompareFacesMatch": { @@ -826,7 +826,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n

\n

To copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.

\n \n \n

For more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

\n \n

To copy a model, the destination project, source project, and source model version must already exist.

\n \n \n

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.

" + "smithy.api#documentation": "

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n

\n

To copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.

\n

For more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

\n \n

To copy a model, the destination project, source project, and source model version must already exist.

\n \n

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.

" } }, "com.amazonaws.rekognition#CopyProjectVersionRequest": { @@ -876,7 +876,7 @@ "KmsKeyId": { "target": "com.amazonaws.rekognition#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).

\n

If you choose to use your own KMS key, you need the following permissions on the KMS key.

\n
    \n
  • \n

    kms:CreateGrant

    \n
    • \n
  • \n

    kms:DescribeKey

    \n
    • \n
  • \n

    kms:GenerateDataKey

    \n
    • \n
  • \n

    kms:Decrypt

    \n
    • \n
\n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

" + "smithy.api#documentation": "

The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).

\n

If you choose to use your own KMS key, you need the following permissions on the KMS key.

\n
    \n
  • \n

    kms:CreateGrant

    \n
    • \n
  • \n

    kms:DescribeKey

    \n
    • \n
  • \n

    kms:GenerateDataKey

    \n
    • \n
  • \n

    kms:Decrypt

    \n
    • \n
\n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

" } } } @@ -1027,7 +1027,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using\n an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

\n\n

To create a training dataset for a project, specify train for the value of \n DatasetType. To create the test dataset for a project,\n specify test for the value of DatasetType.\n

\n \n \n

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset.\n Creating a dataset takes a while to complete. Use DescribeDataset to check the \n current status. The dataset created successfully if the value of Status is\n CREATE_COMPLETE.

\n

To check if any non-terminal errors occurred, call ListDatasetEntries\nand check for the presence of errors lists in the JSON Lines.

\n

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). \n Currently, you can't access the terminal error information.\n \n

\n \n \n

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

\n \n

This operation requires permissions to perform the rekognition:CreateDataset action.\n If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

" + "smithy.api#documentation": "

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using\n an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

\n

To create a training dataset for a project, specify train for the value of \n DatasetType. To create the test dataset for a project,\n specify test for the value of DatasetType.\n

\n

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset.\n Creating a dataset takes a while to complete. Use DescribeDataset to check the \n current status. The dataset created successfully if the value of Status is\n CREATE_COMPLETE.

\n

To check if any non-terminal errors occurred, call ListDatasetEntries\nand check for the presence of errors lists in the JSON Lines.

\n

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). \n Currently, you can't access the terminal error information.\n \n

\n

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

\n

This operation requires permissions to perform the rekognition:CreateDataset action.\n If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

" } }, "com.amazonaws.rekognition#CreateDatasetRequest": { @@ -1162,7 +1162,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion\n is an Amazon Resource Name (ARN) for the version of the model.

\n \n \n

Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n

\n \n \n \n

You can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData and TestingData fields.\n

\n

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.

\n

Instead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.

\n \n \n \n

Training takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status field is TRAINING_COMPLETED.

\n \n

If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.

\n \n \n

Once training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n

\n \n

After evaluating the model, you start the model\n by calling StartProjectVersion.

\n

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

" + "smithy.api#documentation": "

Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion\n is an Amazon Resource Name (ARN) for the version of the model.

\n

Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n

\n \n

You can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData and TestingData fields.\n

\n

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.

\n

Instead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.

\n \n

Training takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status field is TRAINING_COMPLETED.

\n

If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.

\n

Once training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n

\n

After evaluating the model, you start the model\n by calling StartProjectVersion.

\n

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

" } }, "com.amazonaws.rekognition#CreateProjectVersionRequest": { @@ -1210,7 +1210,7 @@ "KmsKeyId": { "target": "com.amazonaws.rekognition#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training and test images copied into the service for model training.\n Your source images are unaffected. The key is also used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).

\n

If you choose to use your own KMS key, you need the following permissions on the KMS key.

\n
    \n
  • \n

    kms:CreateGrant

    \n
    • \n
  • \n

    kms:DescribeKey

    \n
    • \n
  • \n

    kms:GenerateDataKey

    \n
    • \n
  • \n

    kms:Decrypt

    \n
    • \n
\n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

" + "smithy.api#documentation": "

The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training and test images copied into the service for model training.\n Your source images are unaffected. The key is also used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).

\n

If you choose to use your own KMS key, you need the following permissions on the KMS key.

\n
    \n
  • \n

    kms:CreateGrant

    \n
    • \n
  • \n

    kms:DescribeKey

    \n
    • \n
  • \n

    kms:GenerateDataKey

    \n
    • \n
  • \n

    kms:Decrypt

    \n
    • \n
\n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

" } } } @@ -1261,7 +1261,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

\n

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.

\n
    \n
  • \n

    If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the\n face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to\n stop processing.

    \n
    • \n
  • \n

    If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an\n Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.\n You specify what you want to detect in ConnectedHomeSettings, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. \n When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.

    \n
    • \n
\n \n

\n Use Name to assign an identifier for the stream processor. You use Name\n to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with\n the Name field.

\n

This operation requires permissions to perform the\n rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

" + "smithy.api#documentation": "

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

\n

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.

\n
    \n
  • \n

    If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the\n face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to\n stop processing.

    \n
    • \n
  • \n

    If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an\n Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.\n You specify what you want to detect in ConnectedHomeSettings, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. \n When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.

    \n
    • \n
\n

\n Use Name to assign an identifier for the stream processor. You use Name\n to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with\n the Name field.

\n

This operation requires permissions to perform the\n rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

" } }, "com.amazonaws.rekognition#CreateStreamProcessorRequest": { @@ -1314,7 +1314,7 @@ "KmsKeyId": { "target": "com.amazonaws.rekognition#KmsKeyId", "traits": { - "smithy.api#documentation": "

\n The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. \n The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected. \n

\n

\n

" + "smithy.api#documentation": "

\n The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. \n The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected. \n

\n

\n

" } }, "RegionsOfInterest": { @@ -1390,7 +1390,7 @@ "GroundTruth": { "target": "com.amazonaws.rekognition#GroundTruthBlob", "traits": { - "smithy.api#documentation": "

A Base64-encoded binary data object\n containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling UpdateDatasetEntries.\n If you are using an AWS SDK to call UpdateDatasetEntries, you don't need to encode Changes as the SDK encodes the data for you.\n\n

\n \n \n

For example JSON lines,\n see Image-Level labels in manifest files and \n and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n

", + "smithy.api#documentation": "

A Base64-encoded binary data object\n containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling UpdateDatasetEntries.\n If you are using an AWS SDK to call UpdateDatasetEntries, you don't need to encode Changes as the SDK encodes the data for you.\n\n

\n

For example JSON lines,\n see Image-Level labels in manifest files and \n and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n

", "smithy.api#required": {} } } @@ -2156,7 +2156,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified collection. You can use DescribeCollection to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.

\n \n

For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Describes the specified collection. You can use DescribeCollection to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.

\n

For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#DescribeCollectionRequest": { @@ -2183,7 +2183,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

The version of the face model that's used by the collection for face detection.

\n \n

For more information, see Model versioning in the \n Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

The version of the face model that's used by the collection for face detection.

\n

For more information, see Model versioning in the \n Amazon Rekognition Developer Guide.

" } }, "CollectionARN": { @@ -2649,7 +2649,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

\n

You specify which version of a model version to use by using the ProjectVersionArn input\n parameter.

\n

You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file.

\n

For each object that the model version detects on an image, the API returns a \n (CustomLabel) object in an array (CustomLabels).\n Each CustomLabel object provides the label name (Name), the level\n of confidence that the image contains the object (Confidence), and \n object location information, if it exists, for the label on the image (Geometry).

\n \n \n \n \n \n \n \n \n \n \n

To filter labels that are returned, specify a value for MinConfidence.\n DetectCustomLabelsLabels only returns labels with a confidence that's higher than\n the specified value.\n\n The value of MinConfidence maps to the assumed threshold values\n created during training. For more information, see Assumed threshold\n in the Amazon Rekognition Custom Labels Developer Guide. \n Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of\n MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence\n responses from DetectCustomLabels are also returned as a percentage. \n You can use MinConfidence to change the precision and recall or your model. \n For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

\n \n

If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.

\n \n \n \n \n\n

This is a stateless API operation. That is, the operation does not persist any\n data.

\n

This operation requires permissions to perform the\n rekognition:DetectCustomLabels action.

\n \n \n \n

For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

" + "smithy.api#documentation": "

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

\n

You specify which version of a model version to use by using the ProjectVersionArn input\n parameter.

\n

You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file.

\n

For each object that the model version detects on an image, the API returns a \n (CustomLabel) object in an array (CustomLabels).\n Each CustomLabel object provides the label name (Name), the level\n of confidence that the image contains the object (Confidence), and \n object location information, if it exists, for the label on the image (Geometry).

\n

To filter labels that are returned, specify a value for MinConfidence.\n DetectCustomLabelsLabels only returns labels with a confidence that's higher than\n the specified value.\n\n The value of MinConfidence maps to the assumed threshold values\n created during training. For more information, see Assumed threshold\n in the Amazon Rekognition Custom Labels Developer Guide. \n Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of\n MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence\n responses from DetectCustomLabels are also returned as a percentage. \n You can use MinConfidence to change the precision and recall or your model. \n For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

\n

If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.

\n

This is a stateless API operation. That is, the operation does not persist any\n data.

\n

This operation requires permissions to perform the\n rekognition:DetectCustomLabels action.

\n

For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

" } }, "com.amazonaws.rekognition#DetectCustomLabelsRequest": { @@ -2801,7 +2801,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.

\n \n

For an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.

\n \n

You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n

\n Optional Parameters\n

\n

You can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.

\n

When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.

\n

You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.

\n

\n Response Elements\n

\n

For each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information regarding labels:

\n
    \n
  • \n

    Name - The name of the detected label.

    \n
    • \n
  • \n

    Confidence - The level of confidence in the label assigned to a detected object.\n

    \n
    • \n
  • \n

    Parents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.

    \n
    • \n
  • \n

    Aliases - Possible Aliases for the label.

    \n
    • \n
  • \n

    Categories - The label categories that the detected label belongs to. A given label\n can belong to more than one category.

    \n
    • \n
  • \n

    BoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.

    \n
    • \n
\n

The API returns the following information regarding the image, as part of the\n ImageProperties structure:

\n
    \n
  • \n

    Quality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.

    \n
    • \n
  • \n

    Dominant Color - An array of the dominant colors in the image.

    \n
    • \n
  • \n

    Foreground - Information about the Sharpness and Brightness of the input image’s\n foreground.

    \n
    • \n
  • \n

    Background - Information about the Sharpness and Brightness of the input image’s\n background.

    \n
    • \n
\n

The list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:

\n

\n {Name: lighthouse, Confidence: 98.4629}\n

\n

\n {Name: rock,Confidence: 79.2097}\n

\n

\n {Name: sea,Confidence: 75.061}\n

\n

The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.

\n

\n {Name: flower,Confidence: 99.0562}\n

\n

\n {Name: plant,Confidence: 99.0562}\n

\n

\n {Name: tulip,Confidence: 99.0562}\n

\n

In this example, the detection algorithm more precisely identifies the flower as a\n tulip.

\n \n

If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.

\n \n

This is a stateless API operation. That is, the operation does not persist any\n data.

\n

This operation requires permissions to perform the\n rekognition:DetectLabels action.

" + "smithy.api#documentation": "

Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.

\n

For an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.

\n

You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n

\n Optional Parameters\n

\n

You can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.

\n

When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.

\n

You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.

\n

\n Response Elements\n

\n

For each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information regarding labels:

\n
    \n
  • \n

    Name - The name of the detected label.

    \n
    • \n
  • \n

    Confidence - The level of confidence in the label assigned to a detected object.\n

    \n
    • \n
  • \n

    Parents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.

    \n
    • \n
  • \n

    Aliases - Possible Aliases for the label.

    \n
    • \n
  • \n

    Categories - The label categories that the detected label belongs to.

    \n
    • \n
  • \n

    BoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.

    \n
    • \n
\n

The API returns the following information regarding the image, as part of the\n ImageProperties structure:

\n
    \n
  • \n

    Quality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.

    \n
    • \n
  • \n

    Dominant Color - An array of the dominant colors in the image.

    \n
    • \n
  • \n

    Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.

    \n
    • \n
  • \n

    Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.

    \n
    • \n
\n

The list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:

\n

\n {Name: lighthouse, Confidence: 98.4629}\n

\n

\n {Name: rock,Confidence: 79.2097}\n

\n

\n {Name: sea,Confidence: 75.061}\n

\n

The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.

\n

\n {Name: flower,Confidence: 99.0562}\n

\n

\n {Name: plant,Confidence: 99.0562}\n

\n

\n {Name: tulip,Confidence: 99.0562}\n

\n

In this example, the detection algorithm more precisely identifies the flower as a\n tulip.

\n \n

If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.

\n \n

This is a stateless API operation. That is, the operation does not persist any\n data.

\n

This operation requires permissions to perform the\n rekognition:DetectLabels action.

" } }, "com.amazonaws.rekognition#DetectLabelsFeatureList": { @@ -3079,7 +3079,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects unsafe content in a specified JPEG or PNG format image. Use\n DetectModerationLabels to moderate images depending on your requirements. For\n example, you might want to filter images that contain nudity, but not images containing\n suggestive content.

\n

To filter images, use the labels returned by DetectModerationLabels to\n determine which types of content are appropriate.

\n \n

For information about moderation labels, see Detecting Unsafe Content in the\n Amazon Rekognition Developer Guide.

\n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

" + "smithy.api#documentation": "

Detects unsafe content in a specified JPEG or PNG format image. Use\n DetectModerationLabels to moderate images depending on your requirements. For\n example, you might want to filter images that contain nudity, but not images containing\n suggestive content.

\n

To filter images, use the labels returned by DetectModerationLabels to\n determine which types of content are appropriate.

\n

For information about moderation labels, see Detecting Unsafe Content in the\n Amazon Rekognition Developer Guide.

\n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

" } }, "com.amazonaws.rekognition#DetectModerationLabelsRequest": { @@ -3164,7 +3164,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the \n following types of PPE.

\n
    \n
  • \n

    Face cover

    \n
    • \n
  • \n

    Hand cover

    \n
    • \n
  • \n

    Head cover

    \n
    • \n
\n \n

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.\n The image must be either a PNG or JPG formatted file.

\n \n

\n DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

\n

For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).\n For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE\n covers the body part. The API returns the confidence it has in each detection\n (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected \n person and each detected item of PPE.

\n

You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter.\n The summary provides the following information.

\n
    \n
  • \n

    The persons detected as wearing all of the types of PPE that you specify.

    \n
    • \n
  • \n

    The persons detected as not wearing all of the types PPE that you specify.

    \n
    • \n
  • \n

    The persons detected where PPE adornment could not be determined.

    \n
    • \n
\n

This is a stateless API operation. That is, the operation does not persist any data.

\n \n

This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.

" + "smithy.api#documentation": "

Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the \n following types of PPE.

\n
    \n
  • \n

    Face cover

    \n
    • \n
  • \n

    Hand cover

    \n
    • \n
  • \n

    Head cover

    \n
    • \n
\n

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.\n The image must be either a PNG or JPG formatted file.

\n

\n DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

\n

For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).\n For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE\n covers the body part. The API returns the confidence it has in each detection\n (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected \n person and each detected item of PPE.

\n

You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter.\n The summary provides the following information.

\n
    \n
  • \n

    The persons detected as wearing all of the types of PPE that you specify.

    \n
    • \n
  • \n

    The persons detected as not wearing all of the types PPE that you specify.

    \n
    • \n
  • \n

    The persons detected where PPE adornment could not be determined.

    \n
    • \n
\n

This is a stateless API operation. That is, the operation does not persist any data.

\n

This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.

" } }, "com.amazonaws.rekognition#DetectProtectiveEquipmentRequest": { @@ -3243,7 +3243,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects text in the input image and converts it into machine-readable text.

\n

Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal\n axis.

\n \n

For more information, see Detecting text in the Amazon Rekognition Developer\n Guide.

" + "smithy.api#documentation": "

Detects text in the input image and converts it into machine-readable text.

\n

Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal\n axis.

\n

For more information, see Detecting text in the Amazon Rekognition Developer\n Guide.

" } }, "com.amazonaws.rekognition#DetectTextFilters": { @@ -3371,7 +3371,7 @@ } ], "traits": { - "smithy.api#documentation": "

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n

\n

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

\n

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.

\n\n

This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.

" + "smithy.api#documentation": "

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n

\n

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

\n

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.

\n

This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.

" } }, "com.amazonaws.rekognition#DistributeDatasetEntriesRequest": { @@ -3818,7 +3818,7 @@ } }, "traits": { - "smithy.api#documentation": "

Structure containing attributes of the face that the algorithm detected.

\n

A FaceDetail object contains either the default facial attributes or all\n facial attributes. The default attributes are BoundingBox,\n Confidence, Landmarks, Pose, and\n Quality.

\n

\n GetFaceDetection is the only Amazon Rekognition Video stored video operation that can\n return a FaceDetail object with all attributes. To specify which attributes to\n return, use the FaceAttributes input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default\n attributes. The corresponding Start operations don't have a FaceAttributes input\n parameter.

\n
    \n
  • \n

    GetCelebrityRecognition

    \n
    • \n
  • \n

    GetPersonTracking

    \n
    • \n
  • \n

    GetFaceSearch

    \n
    • \n
\n

The Amazon Rekognition Image DetectFaces and IndexFaces operations\n can return all facial attributes. To specify which attributes to return, use the\n Attributes input parameter for DetectFaces. For\n IndexFaces, use the DetectAttributes input parameter.

" + "smithy.api#documentation": "

Structure containing attributes of the face that the algorithm detected.

\n

A FaceDetail object contains either the default facial attributes or all\n facial attributes. The default attributes are BoundingBox,\n Confidence, Landmarks, Pose, and\n Quality.

\n

\n GetFaceDetection is the only Amazon Rekognition Video stored video operation that can\n return a FaceDetail object with all attributes. To specify which attributes to\n return, use the FaceAttributes input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default\n attributes. The corresponding Start operations don't have a FaceAttributes input\n parameter:

\n
    \n
  • \n

    GetCelebrityRecognition

    \n
    • \n
  • \n

    GetPersonTracking

    \n
    • \n
  • \n

    GetFaceSearch

    \n
    • \n
\n

The Amazon Rekognition Image DetectFaces and IndexFaces operations\n can return all facial attributes. To specify which attributes to return, use the\n Attributes input parameter for DetectFaces. For\n IndexFaces, use the DetectAttributes input parameter.

" } }, "com.amazonaws.rekognition#FaceDetailList": { @@ -4125,7 +4125,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.

\n \n

For more information, see Getting information about a celebrity in the\n Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the\n rekognition:GetCelebrityInfo action.

" + "smithy.api#documentation": "

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.

\n

For more information, see Getting information about a celebrity in the\n Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the\n rekognition:GetCelebrityInfo action.

" } }, "com.amazonaws.rekognition#GetCelebrityInfoRequest": { @@ -4195,7 +4195,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by\n StartCelebrityRecognition.

\n

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a\n call to StartCelebrityRecognition which returns a job identifier\n (JobId).

\n

When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion\n status to the Amazon Simple Notification Service topic registered in the initial call to\n StartCelebrityRecognition. To get the results of the celebrity recognition\n analysis, first check that the status value published to the Amazon SNS topic is\n SUCCEEDED. If so, call GetCelebrityDetection and pass the job\n identifier (JobId) from the initial call to StartCelebrityDetection.

\n \n

For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

\n

\n GetCelebrityRecognition returns detected celebrities and the time(s) they\n are detected in an array (Celebrities) of CelebrityRecognition\n objects. Each CelebrityRecognition\n contains information about the celebrity in a CelebrityDetail object and the\n time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face\n attributes, a face bounding box, known gender, the celebrity's name, and a confidence\n estimate.

\n \n

\n GetCelebrityRecognition only returns the default facial\n attributes (BoundingBox, Confidence, Landmarks,\n Pose, and Quality). The BoundingBox field only\n applies to the detected face instance. The other facial attributes listed in the\n Face object of the following response syntax are not returned. For more\n information, see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n

By default, the Celebrities array is sorted by time (milliseconds from the start of the video).\n You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

\n

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store\n the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

\n

No information is returned for faces not recognized as celebrities.

\n

Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection\n and populate the NextToken request parameter with the token\n value returned from the previous call to GetCelebrityRecognition.

", + "smithy.api#documentation": "

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by\n StartCelebrityRecognition.

\n

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a\n call to StartCelebrityRecognition which returns a job identifier\n (JobId).

\n

When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion\n status to the Amazon Simple Notification Service topic registered in the initial call to\n StartCelebrityRecognition. To get the results of the celebrity recognition\n analysis, first check that the status value published to the Amazon SNS topic is\n SUCCEEDED. If so, call GetCelebrityDetection and pass the job\n identifier (JobId) from the initial call to StartCelebrityDetection.

\n

For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

\n

\n GetCelebrityRecognition returns detected celebrities and the time(s) they\n are detected in an array (Celebrities) of CelebrityRecognition\n objects. Each CelebrityRecognition\n contains information about the celebrity in a CelebrityDetail object and the\n time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face\n attributes, a face bounding box, known gender, the celebrity's name, and a confidence\n estimate.

\n \n

\n GetCelebrityRecognition only returns the default facial\n attributes (BoundingBox, Confidence, Landmarks,\n Pose, and Quality). The BoundingBox field only\n applies to the detected face instance. The other facial attributes listed in the\n Face object of the following response syntax are not returned. For more\n information, see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n

By default, the Celebrities array is sorted by time (milliseconds from the start of the video).\n You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

\n

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store\n the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

\n

No information is returned for faces not recognized as celebrities.

\n

Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection\n and populate the NextToken request parameter with the token\n value returned from the previous call to GetCelebrityRecognition.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4300,7 +4300,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by\n StartContentModeration. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n\n

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling\n StartContentModeration which returns a job identifier (JobId).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartContentModeration.\n To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.

\n

\n GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels,\n and the time they are detected, in an array, ModerationLabels, of\n ContentModerationDetection objects.\n

\n

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying NAME for the SortBy\n input parameter.

\n

Since video analysis can return a large number of results, use the MaxResults parameter to limit\n the number of labels returned in a single call to GetContentModeration. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetContentModeration\n and populate the NextToken request parameter with the value of NextToken\n returned from the previous call to GetContentModeration.

\n \n

For more information, see moderating content in the Amazon Rekognition Developer Guide.

", + "smithy.api#documentation": "

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by\n StartContentModeration. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling\n StartContentModeration which returns a job identifier (JobId).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartContentModeration.\n To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n

For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.

\n

\n GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels,\n and the time they are detected, in an array, ModerationLabels, of\n ContentModerationDetection objects.\n

\n

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying NAME for the SortBy\n input parameter.

\n

Since video analysis can return a large number of results, use the MaxResults parameter to limit\n the number of labels returned in a single call to GetContentModeration. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetContentModeration\n and populate the NextToken request parameter with the value of NextToken\n returned from the previous call to GetContentModeration.

\n

For more information, see moderating content in the Amazon Rekognition Developer Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4510,7 +4510,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the face search results for Amazon Rekognition Video face search started by\n StartFaceSearch. The search returns faces in a collection that match the faces\n of persons detected in a video. It also includes the time(s) that faces are matched in the video.

\n

Face search in a video is an asynchronous operation. You start face search by calling\n to StartFaceSearch which returns a job identifier (JobId).\n When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartFaceSearch.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier\n (JobId) from the initial call to StartFaceSearch.

\n \n

For more information, see Searching Faces in a Collection in the\n Amazon Rekognition Developer Guide.

\n

The search results are retured in an array, Persons, of\n PersonMatch objects. EachPersonMatch element contains\n details about the matching faces in the input collection, person information (facial attributes,\n bounding boxes, and person identifer)\n for the matched person, and the time the person was matched in the video.

\n \n

\n GetFaceSearch only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n\n

By default, the Persons array is sorted by the time, in milliseconds from the\n start of the video, persons are matched.\n You can also sort by persons by specifying INDEX for the SORTBY input\n parameter.

", + "smithy.api#documentation": "

Gets the face search results for Amazon Rekognition Video face search started by\n StartFaceSearch. The search returns faces in a collection that match the faces\n of persons detected in a video. It also includes the time(s) that faces are matched in the video.

\n

Face search in a video is an asynchronous operation. You start face search by calling\n to StartFaceSearch which returns a job identifier (JobId).\n When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartFaceSearch.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier\n (JobId) from the initial call to StartFaceSearch.

\n

For more information, see Searching Faces in a Collection in the\n Amazon Rekognition Developer Guide.

\n

The search results are retured in an array, Persons, of\n PersonMatch objects. EachPersonMatch element contains\n details about the matching faces in the input collection, person information (facial attributes,\n bounding boxes, and person identifer)\n for the matched person, and the time the person was matched in the video.

\n \n

\n GetFaceSearch only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n

By default, the Persons array is sorted by the time, in milliseconds from the\n start of the video, persons are matched.\n You can also sort by persons by specifying INDEX for the SORTBY input\n parameter.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4615,7 +4615,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

\n\n

The label detection operation is started by a call to StartLabelDetection\n which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results\n of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetLabelDetection and pass the job identifier\n (JobId) from the initial call to StartLabelDetection.

\n

\n GetLabelDetection returns an array of detected labels (Labels) sorted by the time\n the labels were detected. You can also sort by the label name by specifying NAME for the\n SortBy input parameter.

\n

The labels returned include the label name, the percentage confidence in the accuracy of the detected label,\n and the time the label was detected in the video.

\n

The returned labels also include bounding box information for common objects, a \n hierarchical taxonomy of detected labels, and the version of the label model used for detection.

\n \n

Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token\n value returned from the previous call to GetLabelDetection.

", + "smithy.api#documentation": "

Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

\n

The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When\n the label detection operation finishes, Amazon Rekognition publishes a completion status to the\n Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection.

\n

To get the results of the label detection operation, first check that the status value\n published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the\n initial call to StartLabelDetection.

\n

\n GetLabelDetection returns an array of detected labels\n (Labels) sorted by the time the labels were detected. You can also sort by the\n label name by specifying NAME for the SortBy input parameter. If\n there is no NAME specified, the default sort is by\n timestamp.

\n

You can select how results are aggregated by using the AggregateBy input\n parameter. The default aggregation method is TIMESTAMPS. You can also aggregate\n by SEGMENTS, which aggregates all instances of labels detected in a given\n segment.

\n

The returned Labels array may include the following attributes:

\n
    \n
  • \n

    Name - The name of the detected label.

    \n
    • \n
  • \n

    Confidence - The level of confidence in the label assigned to a detected object.

    \n
    • \n
  • \n

    Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical\n taxonomy of detected labels. For example, a detected car might be assigned the label car.\n The label car has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). The response includes the all ancestors for a label, where every ancestor is\n a unique label. In the previous example, Car, Vehicle, and Transportation are returned as\n unique labels in the response.

    \n
    • \n
  • \n

    Aliases - Possible Aliases for the label.

    \n
    • \n
  • \n

    Categories - The label categories that the detected label belongs to.

    \n
    • \n
  • \n

    BoundingBox — Bounding boxes are described for all instances of detected common object labels, \n returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing \n the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.

    \n
    • \n
  • \n

    Timestamp - Time, in milliseconds from the start of the video, that the label was detected.\n For aggregation by SEGMENTS, the StartTimestampMillis,\n EndTimestampMillis, and DurationMillis structures are what\n define a segment. Although the “Timestamp” structure is still returned with each label,\n its value is set to be the same as StartTimestampMillis.

    \n
    • \n
\n

Timestamp and Bounding box information are returned for detected Instances, only if\n aggregation is done by TIMESTAMPS. If aggregating by SEGMENTS,\n information about detected instances isn’t returned.

\n

The version of the label model used for the detection is also returned.

\n

\n Note DominantColors isn't returned for Instances,\n although it is shown as part of the response in the sample seen below.\n

\n

Use MaxResults parameter to limit the number of labels returned. If\n there are more results than specified in MaxResults, the value of\n NextToken in the operation response contains a pagination token for getting the\n next set of results. To get the next page of results, call GetlabelDetection and\n populate the NextToken request parameter with the token value returned from the\n previous call to GetLabelDetection.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4650,6 +4650,12 @@ "traits": { "smithy.api#documentation": "

Sort to use for elements in the Labels array.\n Use TIMESTAMP to sort array elements by the time labels are detected.\n Use NAME to alphabetically group elements for a label together.\n Within each label group, the array element are sorted by detection confidence.\n The default sort is by TIMESTAMP.

" } + }, + "AggregateBy": { + "target": "com.amazonaws.rekognition#LabelDetectionAggregateBy", + "traits": { + "smithy.api#documentation": "

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

" + } } } }, @@ -4726,7 +4732,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

\n\n

The person path tracking operation is started by a call to StartPersonTracking\n which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

\n

To get the results of the person path tracking operation, first check \n that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetPersonTracking and pass the job identifier\n (JobId) from the initial call to StartPersonTracking.

\n

\n GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their \n paths were tracked in the video.

\n \n

\n GetPersonTracking only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned.

\n \n

For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n\n \n

By default, the array is sorted by the time(s) a person's path is tracked in the video.\n You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

\n\n

Use the MaxResults parameter to limit the number of items returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token\n value returned from the previous call to GetPersonTracking.

", + "smithy.api#documentation": "

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

\n

The person path tracking operation is started by a call to StartPersonTracking\n which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

\n

To get the results of the person path tracking operation, first check \n that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetPersonTracking and pass the job identifier\n (JobId) from the initial call to StartPersonTracking.

\n

\n GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their \n paths were tracked in the video.

\n \n

\n GetPersonTracking only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned.

\n

For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n

By default, the array is sorted by the time(s) a person's path is tracked in the video.\n You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

\n

Use the MaxResults parameter to limit the number of items returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token\n value returned from the previous call to GetPersonTracking.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4831,7 +4837,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

\n

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling StartSegmentDetection which returns a job identifier (JobId).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartSegmentDetection. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call\n of StartSegmentDetection.

\n

\n GetSegmentDetection returns detected segments in an array (Segments)\n of SegmentDetection objects. Segments is sorted by the segment types \n specified in the SegmentTypes input parameter of StartSegmentDetection. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.

\n

Use SelectedSegmentTypes to find out the type of segment detection requested in the \n call to StartSegmentDetection.

\n

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetSegmentDetection.

\n \n

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

", + "smithy.api#documentation": "

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

\n

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling StartSegmentDetection which returns a job identifier (JobId).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartSegmentDetection. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call\n of StartSegmentDetection.

\n

\n GetSegmentDetection returns detected segments in an array (Segments)\n of SegmentDetection objects. Segments is sorted by the segment types \n specified in the SegmentTypes input parameter of StartSegmentDetection. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.

\n

Use SelectedSegmentTypes to find out the type of segment detection requested in the \n call to StartSegmentDetection.

\n

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetSegmentDetection.

\n

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5214,7 +5220,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the input image either as bytes or an S3 object.

\n

You pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.

\n \n

For more information, see Analyzing an Image Loaded from a Local File System\n in the Amazon Rekognition Developer Guide.

\n

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n

If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Provides the input image either as bytes or an S3 object.

\n

You pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.

\n

For more information, see Analyzing an Image Loaded from a Local File System\n in the Amazon Rekognition Developer Guide.

\n

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n

If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.

\n

For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#ImageBlob": { @@ -5314,7 +5320,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects faces in the input image and adds them to the specified collection.

\n

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.

\n \n

For more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.

\n

To get the number of faces in a collection, call DescribeCollection.

\n

If you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.

\n

If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.

\n

To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n

\n \n

For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.

\n

If you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.

\n

You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.

\n \n

Information about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:

\n
    \n
  • \n

    The number of faces detected exceeds the value of the MaxFaces request\n parameter.

    \n
    • \n
  • \n

    The face is too small compared to the image dimensions.

    \n
    • \n
  • \n

    The face is too blurry.

    \n
    • \n
  • \n

    The image is too dark.

    \n
    • \n
  • \n

    The face has an extreme pose.

    \n
    • \n
  • \n

    The face doesn’t have enough detail to be suitable for face search.

    \n
    • \n
\n

In response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:

\n
    \n
  • \n

    The bounding box, BoundingBox, of the detected face.

    \n
    • \n
  • \n

    A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.

    \n
    • \n
  • \n

    A face ID, FaceId, assigned by the service for each face that's detected\n and stored.

    \n
    • \n
  • \n

    An image ID, ImageId, assigned by the service for the input image.

    \n
    • \n
\n

If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide the same\n image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

\n

\n \n

The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

\n

This operation requires permissions to perform the rekognition:IndexFaces\n action.

" + "smithy.api#documentation": "

Detects faces in the input image and adds them to the specified collection.

\n

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.

\n

For more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.

\n

To get the number of faces in a collection, call DescribeCollection.

\n

If you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.

\n

If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.

\n

To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n

\n

For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.

\n

If you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.

\n

You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.

\n \n

Information about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:

\n
    \n
  • \n

    The number of faces detected exceeds the value of the MaxFaces request\n parameter.

    \n
    • \n
  • \n

    The face is too small compared to the image dimensions.

    \n
    • \n
  • \n

    The face is too blurry.

    \n
    • \n
  • \n

    The image is too dark.

    \n
    • \n
  • \n

    The face has an extreme pose.

    \n
    • \n
  • \n

    The face doesn’t have enough detail to be suitable for face search.

    \n
    • \n
\n

In response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:

\n
    \n
  • \n

    The bounding box, BoundingBox, of the detected face.

    \n
    • \n
  • \n

    A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.

    \n
    • \n
  • \n

    A face ID, FaceId, assigned by the service for each face that's detected\n and stored.

    \n
    • \n
  • \n

    An image ID, ImageId, assigned by the service for the input image.

    \n
    • \n
\n

If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide the same\n image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

\n

\n

The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

\n

This operation requires permissions to perform the rekognition:IndexFaces\n action.

" } }, "com.amazonaws.rekognition#IndexFacesModelVersion": { @@ -5809,12 +5815,81 @@ "traits": { "smithy.api#documentation": "

Details about the detected label.

" } + }, + "StartTimestampMillis": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "

The time in milliseconds defining the start of the timeline segment containing a continuously detected label.

" + } + }, + "EndTimestampMillis": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "

The time in milliseconds defining the end of the timeline segment containing a continuously detected label.

" + } + }, + "DurationMillis": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "

The time duration of a segment in milliseconds, I.e. time elapsed from StartTimestampMillis to EndTimestampMillis.

" + } } }, "traits": { "smithy.api#documentation": "

Information about a label detected in a video analysis request and the time the label was detected in the video.

" } }, + "com.amazonaws.rekognition#LabelDetectionAggregateBy": { + "type": "enum", + "members": { + "TIMESTAMPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMPS" + } + }, + "SEGMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEGMENTS" + } + } + } + }, + "com.amazonaws.rekognition#LabelDetectionFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#LabelDetectionFeatureName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.rekognition#LabelDetectionFeatureName": { + "type": "enum", + "members": { + "GENERAL_LABELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERAL_LABELS" + } + } + } + }, + "com.amazonaws.rekognition#LabelDetectionSettings": { + "type": "structure", + "members": { + "GeneralLabels": { + "target": "com.amazonaws.rekognition#GeneralLabelsSettings" + } + }, + "traits": { + "smithy.api#documentation": "

Contains the specified filters that should be applied to a list of returned GENERAL_LABELS.

" + } + }, "com.amazonaws.rekognition#LabelDetectionSortBy": { "type": "enum", "members": { @@ -6114,7 +6189,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns list of collection IDs in your account. If the result is truncated, the\n response also provides a NextToken that you can use in the subsequent request to\n fetch the next set of collection IDs.

\n \n

For an example, see Listing collections in the Amazon Rekognition Developer\n Guide.

\n

This operation requires permissions to perform the\n rekognition:ListCollections action.

", + "smithy.api#documentation": "

Returns list of collection IDs in your account. If the result is truncated, the\n response also provides a NextToken that you can use in the subsequent request to\n fetch the next set of collection IDs.

\n

For an example, see Listing collections in the Amazon Rekognition Developer\n Guide.

\n

This operation requires permissions to perform the\n rekognition:ListCollections action.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6201,7 +6276,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nLists the entries (images) within a dataset. An entry is a\nJSON Line that contains the information for a single image, including\nthe image location, assigned labels, and object location bounding boxes. For \nmore information, see Creating a manifest file.

\n

JSON Lines in the response include information about non-terminal\n errors found in the dataset. \n Non terminal errors are reported in errors lists within each JSON Line. The\n same information is reported in the training and testing validation result manifests that\n Amazon Rekognition Custom Labels creates during model training.\n

\n \n

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.\n

\n

This operation requires permissions to perform the rekognition:ListDatasetEntries action.

", + "smithy.api#documentation": "

\nLists the entries (images) within a dataset. An entry is a\nJSON Line that contains the information for a single image, including\nthe image location, assigned labels, and object location bounding boxes. For \nmore information, see Creating a manifest file.

\n

JSON Lines in the response include information about non-terminal\n errors found in the dataset. \n Non terminal errors are reported in errors lists within each JSON Line. The\n same information is reported in the training and testing validation result manifests that\n Amazon Rekognition Custom Labels creates during model training.\n

\n

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.\n

\n

This operation requires permissions to perform the rekognition:ListDatasetEntries action.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6322,7 +6397,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see \n Labeling images.\n

\n

\n Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images\n in the Amazon Rekognition Custom Labels Developer Guide.

", + "smithy.api#documentation": "

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see \n Labeling images.\n

\n

\n Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images\n in the Amazon Rekognition Custom Labels Developer Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6996,7 +7071,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details and path tracking information for a single time a person's path is tracked in a video.\n Amazon Rekognition operations that track people's paths return an array of PersonDetection objects\n with elements for each time a person's path is tracked in a video.

\n \n

For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Details and path tracking information for a single time a person's path is tracked in a video.\n Amazon Rekognition operations that track people's paths return an array of PersonDetection objects\n with elements for each time a person's path is tracked in a video.

\n

For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#PersonDetections": { @@ -7078,7 +7153,7 @@ } }, "traits": { - "smithy.api#documentation": "

The X and Y coordinates of a point on an image or video frame. The X and Y values are\n ratios of the overall image size or video resolution. For example, if an input image is\n 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel\n coordinate on the image.

\n \n

An array of Point objects makes up a Polygon. A\n Polygon is returned by DetectText and by DetectCustomLabels\n Polygon represents a fine-grained polygon around a detected item. For more\n information, see Geometry in the Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

The X and Y coordinates of a point on an image or video frame. The X and Y values are\n ratios of the overall image size or video resolution. For example, if an input image is\n 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel\n coordinate on the image.

\n

An array of Point objects makes up a Polygon. A\n Polygon is returned by DetectText and by DetectCustomLabels\n Polygon represents a fine-grained polygon around a detected item. For more\n information, see Geometry in the Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#Polygon": { @@ -7230,7 +7305,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a project policy in the response from ListProjectPolicies.

\n\n

" + "smithy.api#documentation": "

Describes a project policy in the response from ListProjectPolicies.

\n

" } }, "com.amazonaws.rekognition#ProjectPolicyDocument": { @@ -7707,7 +7782,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.

\n \n \n

For more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n \n

The response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.

\n

To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.

\n \n

You copy a model version by calling CopyProjectVersion.

" + "smithy.api#documentation": "

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.

\n

For more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

The response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.

\n

To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.

\n

You copy a model version by calling CopyProjectVersion.

" } }, "com.amazonaws.rekognition#PutProjectPolicyRequest": { @@ -7886,7 +7961,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an array of celebrities recognized in the input image. For more\n information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

\n

\n RecognizeCelebrities returns the 64 largest faces in the image. It lists\n the recognized celebrities in the CelebrityFaces array and any unrecognized faces\n in the UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.

\n

For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.

\n

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.

\n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n \n

For an example, see Recognizing celebrities in an image in the Amazon Rekognition\n Developer Guide.

\n

This operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.

" + "smithy.api#documentation": "

Returns an array of celebrities recognized in the input image. For more\n information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

\n

\n RecognizeCelebrities returns the 64 largest faces in the image. It lists\n the recognized celebrities in the CelebrityFaces array and any unrecognized faces\n in the UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.

\n

For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.

\n

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.

\n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n

For an example, see Recognizing celebrities in an image in the Amazon Rekognition\n Developer Guide.

\n

This operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.

" } }, "com.amazonaws.rekognition#RecognizeCelebritiesRequest": { @@ -8169,7 +8244,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -8218,15 +8293,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -8603,8 +8669,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -8616,8 +8682,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -8629,8 +8695,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-1" } }, @@ -8642,8 +8708,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-1" } }, @@ -8655,8 +8721,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -8668,8 +8734,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -8681,8 +8747,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ca-central-1" } }, @@ -8694,8 +8760,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ca-central-1" } }, @@ -8707,8 +8773,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -8720,8 +8786,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -8733,8 +8799,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-1" } }, @@ -8746,8 +8812,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-1" } }, @@ -8759,8 +8825,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-1" } }, @@ -8772,8 +8838,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -8785,8 +8851,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-1" } }, @@ -8798,8 +8864,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-1" } }, @@ -8811,8 +8877,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -8824,8 +8890,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -8837,8 +8903,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-2" } }, @@ -8850,8 +8916,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-2" } }, @@ -8863,8 +8929,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -8876,8 +8942,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -8889,8 +8955,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-2" } }, @@ -8902,8 +8968,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-2" } }, @@ -8915,8 +8981,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-1" } }, @@ -8928,8 +8994,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -8941,8 +9007,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-1" } }, @@ -8954,8 +9020,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-1" } }, @@ -8967,8 +9033,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -8980,8 +9046,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -8993,8 +9059,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-2" } }, @@ -9006,8 +9072,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-2" } }, @@ -9019,8 +9085,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -9032,8 +9098,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -9045,8 +9111,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-1" } }, @@ -9058,8 +9124,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-1" } }, @@ -9071,8 +9137,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -9084,8 +9150,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -9097,8 +9163,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-gov-west-1" } }, @@ -9110,8 +9176,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-gov-west-1" } }, @@ -9123,8 +9189,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -9136,8 +9202,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -9149,8 +9215,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-1" } }, @@ -9162,8 +9228,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-1" } }, @@ -9175,8 +9241,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -9188,8 +9254,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -9201,8 +9267,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-2" } }, @@ -9214,8 +9280,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-2" } }, @@ -9227,8 +9293,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -9240,8 +9306,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -9253,8 +9319,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1" } }, @@ -9266,8 +9332,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1" } }, @@ -9279,8 +9345,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-2" } }, @@ -9292,8 +9358,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -9305,8 +9371,8 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-2" } }, @@ -9318,8 +9384,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-2" } }, @@ -9331,8 +9397,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -9343,8 +9409,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -9355,8 +9421,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", "Endpoint": "https://example.com" } @@ -9533,7 +9599,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the S3 bucket name and object name.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Provides the S3 bucket name and object name.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n

For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the\n Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#S3ObjectName": { @@ -9589,7 +9655,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.

\n \n

You can also search faces without indexing faces by using the\n SearchFacesByImage operation.

\n \n

The operation response returns an array of faces that match, ordered by similarity\n score with the highest similarity first. More specifically, it is an array of metadata for\n each face match that is found. Along with the metadata, the response also includes a\n confidence value for each face match, indicating the confidence that the\n specific face matches the input face.

\n \n

For an example, see Searching for a face using its face ID in the Amazon Rekognition\n Developer Guide.

\n

This operation requires permissions to perform the rekognition:SearchFaces\n action.

" + "smithy.api#documentation": "

For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.

\n \n

You can also search faces without indexing faces by using the\n SearchFacesByImage operation.

\n \n

The operation response returns an array of faces that match, ordered by similarity\n score with the highest similarity first. More specifically, it is an array of metadata for\n each face match that is found. Along with the metadata, the response also includes a\n confidence value for each face match, indicating the confidence that the\n specific face matches the input face.

\n

For an example, see Searching for a face using its face ID in the Amazon Rekognition\n Developer Guide.

\n

This operation requires permissions to perform the rekognition:SearchFaces\n action.

" } }, "com.amazonaws.rekognition#SearchFacesByImage": { @@ -9630,7 +9696,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.

\n \n

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls\n to the SearchFaces operation.

\n

You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.

\n \n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n

The response returns an array of faces that match, ordered by similarity score with\n the highest similarity first. More specifically, it is an array of metadata for each face\n match found. Along with the metadata, the response also includes a similarity\n indicating how similar the face is to the input face. In the response, the operation also\n returns the bounding box (and a confidence level that the bounding box contains a face) of the\n face that Amazon Rekognition used for the input image.

\n

If no faces are detected in the input image, SearchFacesByImage returns an\n InvalidParameterException error.

\n \n

For an example, Searching for a Face Using an Image in the Amazon Rekognition\n Developer Guide.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar for filtering by specifying\n LOW, MEDIUM, or HIGH. If you do not want to filter\n detected faces, specify NONE. The default value is NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.

\n \n

This operation requires permissions to perform the\n rekognition:SearchFacesByImage action.

" + "smithy.api#documentation": "

For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.

\n \n

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls\n to the SearchFaces operation.

\n

You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.

\n \n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n

The response returns an array of faces that match, ordered by similarity score with\n the highest similarity first. More specifically, it is an array of metadata for each face\n match found. Along with the metadata, the response also includes a similarity\n indicating how similar the face is to the input face. In the response, the operation also\n returns the bounding box (and a confidence level that the bounding box contains a face) of the\n face that Amazon Rekognition used for the input image.

\n

If no faces are detected in the input image, SearchFacesByImage returns an\n InvalidParameterException error.

\n

For an example, Searching for a Face Using an Image in the Amazon Rekognition\n Developer Guide.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar for filtering by specifying\n LOW, MEDIUM, or HIGH. If you do not want to filter\n detected faces, specify NONE. The default value is NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.

\n \n

This operation requires permissions to perform the\n rekognition:SearchFacesByImage action.

" } }, "com.amazonaws.rekognition#SearchFacesByImageRequest": { @@ -9921,7 +9987,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n \n

The size of the collection exceeds the allowed limit. For more information,\n see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", + "smithy.api#documentation": "

\n

The size of the collection exceeds the allowed limit. For more information,\n see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", "smithy.api#error": "client" } }, @@ -10004,7 +10070,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous recognition of celebrities in a stored video.

\n

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartCelebrityRecognition\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier\n (JobId) from the initial call to StartCelebrityRecognition.

\n \n

For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

", + "smithy.api#documentation": "

Starts asynchronous recognition of celebrities in a stored video.

\n

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartCelebrityRecognition\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier\n (JobId) from the initial call to StartCelebrityRecognition.

\n

For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -10087,7 +10153,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartContentModeration\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

\n

To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Moderating content in the Amazon Rekognition Developer Guide.

", + "smithy.api#documentation": "

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartContentModeration\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

\n

To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n

For more information, see Moderating content in the Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -10176,7 +10242,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of faces in a stored video.

\n

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.\n Use Video to specify the bucket name and the filename of the video.\n StartFaceDetection returns a job identifier (JobId) that you\n use to get the results of the operation.\n When face detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the face detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier\n (JobId) from the initial call to StartFaceDetection.

\n \n

For more information, see Detecting faces in a stored video in the \n Amazon Rekognition Developer Guide.

", + "smithy.api#documentation": "

Starts asynchronous detection of faces in a stored video.

\n

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.\n Use Video to specify the bucket name and the filename of the video.\n StartFaceDetection returns a job identifier (JobId) that you\n use to get the results of the operation.\n When face detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the face detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier\n (JobId) from the initial call to StartFaceDetection.

\n

For more information, see Detecting faces in a stored video in the \n Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -10364,7 +10430,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of labels in a stored video.

\n

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.\n This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities\n like a person getting out of a car or a person skiing.

\n\n

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartLabelDetection returns a job identifier (JobId) which you use to get the\n results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

\n

To get the results of the label detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier\n (JobId) from the initial call to StartLabelDetection.

\n

", + "smithy.api#documentation": "

Starts asynchronous detection of labels in a stored video.

\n

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.\n This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities\n like a person getting out of a car or a person skiing.

\n

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartLabelDetection returns a job identifier (JobId) which you use to get the\n results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

\n

To get the results of the label detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier\n (JobId) from the initial call to StartLabelDetection.

\n

\n Optional Parameters\n

\n

\n StartLabelDetection has the GENERAL_LABELS Feature applied by\n default. This feature allows you to provide filtering criteria to the Settings\n parameter. You can filter with sets of individual labels or with label categories. You can\n specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive\n filters. For more information on filtering, see Detecting labels in a\n video.

\n

You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 50.

", "smithy.api#idempotent": {} } }, @@ -10387,7 +10453,7 @@ "MinConfidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence\n represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level\n lower than this specified value.

\n

If you don't specify MinConfidence, the operation returns labels with confidence\n values greater than or equal to 50 percent.

" + "smithy.api#documentation": "

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence\n represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level\n lower than this specified value.

\n

If you don't specify MinConfidence, the operation returns labels and\n bounding boxes (if detected) with confidence values greater than or equal to 50\n percent.

" } }, "NotificationChannel": { @@ -10401,6 +10467,18 @@ "traits": { "smithy.api#documentation": "

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.\n For example, you can use JobTag to group related jobs and identify them in the completion notification.

" } + }, + "Features": { + "target": "com.amazonaws.rekognition#LabelDetectionFeatureList", + "traits": { + "smithy.api#documentation": "

The features to return after video analysis. You can specify that GENERAL_LABELS are returned.

" + } + }, + "Settings": { + "target": "com.amazonaws.rekognition#LabelDetectionSettings", + "traits": { + "smithy.api#documentation": "

The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. \n Settings can include filters for GENERAL_LABELS.

" + } } } }, @@ -10533,7 +10611,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.

\n

Once the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.

\n \n

You are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.

\n \n \n

For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.

\n \n

This operation requires permissions to perform the \n rekognition:StartProjectVersion action.

" + "smithy.api#documentation": "

Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.

\n

Once the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.

\n \n

You are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.

\n \n

For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.

\n

This operation requires permissions to perform the \n rekognition:StartProjectVersion action.

" } }, "com.amazonaws.rekognition#StartProjectVersionRequest": { @@ -10549,7 +10627,7 @@ "MinInferenceUnits": { "target": "com.amazonaws.rekognition#InferenceUnits", "traits": { - "smithy.api#documentation": "

The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing.

\n \n

For information about the number \n of transactions per second (TPS) that an inference unit can support, see \n Running a trained Amazon Rekognition Custom Labels model in the \n Amazon Rekognition Custom Labels Guide.\n

\n

Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n

", + "smithy.api#documentation": "

The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing.

\n

For information about the number \n of transactions per second (TPS) that an inference unit can support, see \n Running a trained Amazon Rekognition Custom Labels model in the \n Amazon Rekognition Custom Labels Guide.\n

\n

Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n

", "smithy.api#required": {} } }, @@ -10610,7 +10688,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of segment detection in a stored video.

\n

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and \n the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in NotificationChannel.

\n

You can use the Filters (StartSegmentDetectionFilters) \n input parameter to specify the minimum detection confidence returned in the response. \n Within Filters, use ShotFilter (StartShotDetectionFilter)\n to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter)\n to filter technical cues.

\n

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) \n from the initial call to StartSegmentDetection.

\n\n \n

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

", + "smithy.api#documentation": "

Starts asynchronous detection of segment detection in a stored video.

\n

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and \n the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in NotificationChannel.

\n

You can use the Filters (StartSegmentDetectionFilters) \n input parameter to specify the minimum detection confidence returned in the response. \n Within Filters, use ShotFilter (StartShotDetectionFilter)\n to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter)\n to filter technical cues.

\n

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) \n from the initial call to StartSegmentDetection.

\n

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -10733,7 +10811,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor.\n To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to\n CreateStreamProcessor.

\n

If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.

" + "smithy.api#documentation": "

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor.\n To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to\n CreateStreamProcessor.

\n

If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.

" } }, "com.amazonaws.rekognition#StartStreamProcessorRequest": { @@ -10749,13 +10827,13 @@ "StartSelector": { "target": "com.amazonaws.rekognition#StreamProcessingStartSelector", "traits": { - "smithy.api#documentation": "

\n Specifies the starting point in the Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds.\n For more information about fragment numbers, see Fragment. \n

\n

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

" + "smithy.api#documentation": "

\n Specifies the starting point in the Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds.\n For more information about fragment numbers, see Fragment. \n

\n

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

" } }, "StopSelector": { "target": "com.amazonaws.rekognition#StreamProcessingStopSelector", "traits": { - "smithy.api#documentation": "

\n Specifies when to stop processing the stream. You can specify a \n maximum amount of time to process the video. \n

\n

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

" + "smithy.api#documentation": "

\n Specifies when to stop processing the stream. You can specify a \n maximum amount of time to process the video. \n

\n

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

" } } } @@ -11123,7 +11201,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

\n

Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition\n detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,\n one for a person at second 2 and one for a pet at second 4.

\n

Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

" + "smithy.api#documentation": "

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

\n

Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition\n detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,\n one for a person at second 2 and one for a pet at second 4.

\n

Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

" } }, "com.amazonaws.rekognition#StreamProcessorOutput": { @@ -11546,7 +11624,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a word or line of text detected by DetectText.

\n

The DetectedText field contains the text that Amazon Rekognition detected in the\n image.

\n

Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.

\n \n

For more information, see Detecting text in the Amazon Rekognition Developer\n Guide.

" + "smithy.api#documentation": "

Information about a word or line of text detected by DetectText.

\n

The DetectedText field contains the text that Amazon Rekognition detected in the\n image.

\n

Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.

\n

For more information, see Detecting text in the Amazon Rekognition Developer\n Guide.

" } }, "com.amazonaws.rekognition#TextDetectionList": { @@ -11801,7 +11879,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n

\n \n \n \n

If the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

\n \n

You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.

\n\n \n

\n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.

\n

To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.

\n

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n

\n

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

" + "smithy.api#documentation": "

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

If the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

\n

You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.

\n

\n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.

\n

To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.

\n

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n

\n

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

" } }, "com.amazonaws.rekognition#UpdateDatasetEntriesRequest": { @@ -11925,7 +12003,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the Amazon S3 bucket location of the validation data for a model training job.

\n

The validation data includes error information for individual JSON Lines in the dataset.\n For more information, see Debugging a Failed Model Training in the\n Amazon Rekognition Custom Labels Developer Guide.

\n \n

You get the ValidationData object for the training dataset (TrainingDataResult)\n and the test dataset (TestingDataResult) by calling DescribeProjectVersions.

\n

The assets array contains a single Asset object. \n The GroundTruthManifest field of the Asset object contains the S3 bucket location of\n the validation data. \n

" + "smithy.api#documentation": "

Contains the Amazon S3 bucket location of the validation data for a model training job.

\n

The validation data includes error information for individual JSON Lines in the dataset.\n For more information, see Debugging a Failed Model Training in the\n Amazon Rekognition Custom Labels Developer Guide.

\n

You get the ValidationData object for the training dataset (TrainingDataResult)\n and the test dataset (TestingDataResult) by calling DescribeProjectVersions.

\n

The assets array contains a single Asset object. \n The GroundTruthManifest field of the Asset object contains the S3 bucket location of\n the validation data. \n

" } }, "com.amazonaws.rekognition#VersionName": { diff --git a/codegen/sdk-codegen/aws-models/resiliencehub.2020-04-30.json b/codegen/sdk-codegen/aws-models/resiliencehub.2020-04-30.json index f44dcab9dbf..85f1a4b4b20 100644 --- a/codegen/sdk-codegen/aws-models/resiliencehub.2020-04-30.json +++ b/codegen/sdk-codegen/aws-models/resiliencehub.2020-04-30.json @@ -7242,4 +7242,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/resource-explorer-2.2022-07-28.json b/codegen/sdk-codegen/aws-models/resource-explorer-2.2022-07-28.json index 1e36e339d81..d4def561052 100644 --- a/codegen/sdk-codegen/aws-models/resource-explorer-2.2022-07-28.json +++ b/codegen/sdk-codegen/aws-models/resource-explorer-2.2022-07-28.json @@ -260,7 +260,7 @@ } ], "traits": { - "smithy.api#documentation": "

Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating\n an index. Resource Explorer begins discovering the resources in this Region and stores the details\n about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.

\n \n

This operation creates only a local index. To promote the\n local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the\n UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.

\n \n

For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see\n Turn\n on Resource Explorer to index your resources in an Amazon Web Services Region in the\n Amazon Web Services Resource Explorer User Guide.

\n

If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then\n this operation also creates a\n service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate\n your resources to populate the index.

\n
    \n
  • \n

    \n Action:\n resource-explorer-2:CreateIndex\n

    \n

    \n Resource: The ARN of the index (as it will\n exist after the operation completes) in the Amazon Web Services Region and account in which\n you're trying to create the index. Use the wildcard character (*)\n at the end of the string to match the eventual UUID. For example, the following\n Resource element restricts the role or user to creating an\n index in only the us-east-2 Region of the specified account.

    \n

    \n \"Resource\":\n \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"\n

    \n

    Alternatively, you can use \"Resource\": \"*\" to allow the role or\n user to create an index in any Region.

    \n
    • \n
  • \n

    \n Action:\n iam:CreateServiceLinkedRole\n

    \n

    \n Resource: No specific resource (*).

    \n

    This permission is required only the first time you create an index to turn on\n Resource Explorer in the account. Resource Explorer uses this to create the service-linked\n role needed to index the resources in your account. Resource Explorer uses the\n same service-linked role for all additional indexes you create\n afterwards.

    \n
    • \n
", + "smithy.api#documentation": "

Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating\n an index. Resource Explorer begins discovering the resources in this Region and stores the details\n about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.

\n \n

This operation creates only a local index. To promote the\n local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the\n UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.

\n \n

For more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see\n Turn\n on Resource Explorer to index your resources in an Amazon Web Services Region in the\n Amazon Web Services Resource Explorer User Guide.

\n

If this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then\n this operation also creates a\n service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate\n your resources to populate the index.

\n
    \n
  • \n

    \n Action:\n resource-explorer-2:CreateIndex\n

    \n

    \n Resource: The ARN of the index (as it will\n exist after the operation completes) in the Amazon Web Services Region and account in which\n you're trying to create the index. Use the wildcard character (*)\n at the end of the string to match the eventual UUID. For example, the following\n Resource element restricts the role or user to creating an\n index in only the us-east-2 Region of the specified account.

    \n

    \n \"Resource\":\n \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"\n

    \n

    Alternatively, you can use \"Resource\": \"*\" to allow the role or\n user to create an index in any Region.

    \n
    • \n
  • \n

    \n Action:\n iam:CreateServiceLinkedRole\n

    \n

    \n Resource: No specific resource (*).

    \n

    This permission is required only the first time you create an index to turn on\n Resource Explorer in the account. Resource Explorer uses this to create the service-linked\n role needed to index the resources in your account. Resource Explorer uses the\n same service-linked role for all additional indexes you create\n afterwards.

    \n
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/CreateIndex" @@ -344,7 +344,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a view that users can query by using the Search operation.\n Results from queries that you make using this view include only resources that match the\n view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views\n in the Amazon Web Services Resource Explorer User Guide.

\n

Only the principals with an IAM identity-based policy that grants Allow\n to the Search action on a Resource with the Amazon resource name (ARN) of\n this view can Search using views you create with this\n operation.

", + "smithy.api#documentation": "

Creates a view that users can query by using the Search operation.\n Results from queries that you make using this view include only resources that match the\n view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views\n in the Amazon Web Services Resource Explorer User Guide.

\n

Only the principals with an IAM identity-based policy that grants Allow\n to the Search action on a Resource with the Amazon resource name (ARN) of\n this view can Search using views you create with this\n operation.

", "smithy.api#http": { "method": "POST", "uri": "/CreateView" @@ -445,7 +445,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.\n When you delete an index, Resource Explorer stops discovering and indexing resources in that\n Region. Resource Explorer also deletes all views in that Region. These actions occur as\n asynchronous background tasks. You can check to see when the actions are complete by\n using the GetIndex operation and checking the Status\n response value.

", + "smithy.api#documentation": "

Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.\n When you delete an index, Resource Explorer stops discovering and indexing resources in that\n Region. Resource Explorer also deletes all views in that Region. These actions occur as\n asynchronous background tasks. You can check to see when the actions are complete by\n using the GetIndex operation and checking the Status\n response value.

\n \n

If the index you delete is the aggregator index for the Amazon Web Services account, you must\n wait 24 hours before you can promote another local index to be the\n aggregator index for the account. Users can't perform account-wide searches using\n Resource Explorer until another aggregator index is configured.

\n ", "smithy.api#http": { "method": "POST", "uri": "/DeleteIndex" @@ -674,25 +674,25 @@ "Type": { "target": "com.amazonaws.resourceexplorer2#IndexType", "traits": { - "smithy.api#documentation": "

Specifies the type of the index in this Region. For information about the aggregator\n index and how it differs from a local index, see Turning on cross-Region search\n by creating an aggregator index.

" + "smithy.api#documentation": "

The type of the index in this Region. For information about the aggregator index and\n how it differs from a local index, see Turning on cross-Region search\n by creating an aggregator index.

" } }, "State": { "target": "com.amazonaws.resourceexplorer2#IndexState", "traits": { - "smithy.api#documentation": "

Indicates the current state of the index in this Amazon Web Services Region.

" + "smithy.api#documentation": "

The current state of the index in this Amazon Web Services Region.

" } }, "ReplicatingFrom": { "target": "com.amazonaws.resourceexplorer2#RegionList", "traits": { - "smithy.api#documentation": "

If this index is Type=AGGREGATOR, then this response value contains a\n list of the Amazon Web Services Regions that replicate their content to the index in this Region. Not\n present for a local index.

" + "smithy.api#documentation": "

This response value is present only if this index is\n Type=AGGREGATOR.

\n

A list of the Amazon Web Services Regions that replicate their content to the index in this\n Region.

" } }, "ReplicatingTo": { "target": "com.amazonaws.resourceexplorer2#RegionList", "traits": { - "smithy.api#documentation": "

Identifies the Amazon Web Services Region that has an index set to Type=AGGREGATOR, if\n one exists. If it does, then the Region you called this operation in replicates its\n index information to the Region specified in this response value. Not present if there\n isn't an aggregator index in the account.

" + "smithy.api#documentation": "

This response value is present only if this index is Type=LOCAL.

\n

The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index\n does exist then the Region in which you called this operation replicates its index\n information to the Region specified in this response value.

" } }, "CreatedAt": { @@ -1364,14 +1364,14 @@ "x-amz-source-account" ] }, - "smithy.api#documentation": "

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can\n explore your resources using an internet search engine-like experience. Examples of\n resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB\n tables. You can search for your resources using resource metadata like names, tags, and\n IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn\n the service on, to simplify your cross-Region workloads.

\n

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which\n you turn on Resource Explorer. Resource Explorer creates and\n maintains an index in each Region, with the details of that Region's\n resources.

\n

You can search across all of the indexed\n Regions in your account by designating one of your Amazon Web Services Regions to contain\n the aggregator index for the account. When you promote a local index in\n a Region to become the aggregator index for the account, Resource Explorer automatically\n replicates the index information from all local indexes in the other Regions to the\n aggregator index. Therefore, the Region with the aggregator index has a copy of all resource\n information for all Regions in the account where you turned on Resource Explorer. As a result,\n views in the aggregator index Region include resources from all of the indexed Regions in your\n account.

\n

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the\n service, see the Amazon Web Services Resource Explorer User Guide.

", + "smithy.api#documentation": "

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can\n explore your resources using an internet search engine-like experience. Examples of\n resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB\n tables. You can search for your resources using resource metadata like names, tags, and\n IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn\n the service on, to simplify your cross-Region workloads.

\n

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which\n you turn on Resource Explorer. Resource Explorer creates\n and maintains an index in each Region, with the details of that Region's\n resources.

\n

You can search across all of the\n indexed Regions in your account by designating one of your Amazon Web Services Regions to\n contain the aggregator index for the account. When you promote a local index\n in a Region to become the aggregator index for the account, Resource Explorer automatically\n replicates the index information from all local indexes in the other Regions to the\n aggregator index. Therefore, the Region with the aggregator index has a copy of all resource\n information for all Regions in the account where you turned on Resource Explorer. As a result,\n views in the aggregator index Region include resources from all of the indexed Regions in your\n account.

\n

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the\n service, see the Amazon Web Services Resource Explorer User Guide.

", "smithy.api#title": "AWS Resource Explorer", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -1413,15 +1413,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -1616,6 +1607,58 @@ }, "smithy.rules#endpointTests": { "testCases": [ + { + "documentation": "For region ap-south-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseDualStack": false, + "UseFIPS": false + } + }, { "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", "expect": { @@ -1624,9 +1667,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-south-1" + "UseFIPS": true } }, { @@ -1637,9 +1680,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-south-1" + "UseFIPS": true } }, { @@ -1650,9 +1693,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-south-1" + "UseFIPS": false } }, { @@ -1663,9 +1706,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-south-1" + "UseFIPS": false } }, { @@ -1676,9 +1719,9 @@ } }, "params": { + "Region": "eu-south-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-south-1" + "UseFIPS": true } }, { @@ -1689,9 +1732,9 @@ } }, "params": { + "Region": "eu-south-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-south-1" + "UseFIPS": true } }, { @@ -1702,9 +1745,9 @@ } }, "params": { + "Region": "eu-south-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-south-1" + "UseFIPS": false } }, { @@ -1715,9 +1758,9 @@ } }, "params": { + "Region": "eu-south-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-south-1" + "UseFIPS": false } }, { @@ -1728,9 +1771,9 @@ } }, "params": { + "Region": "eu-south-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-south-2" + "UseFIPS": true } }, { @@ -1741,9 +1784,9 @@ } }, "params": { + "Region": "eu-south-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-south-2" + "UseFIPS": true } }, { @@ -1754,9 +1797,9 @@ } }, "params": { + "Region": "eu-south-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-south-2" + "UseFIPS": false } }, { @@ -1767,9 +1810,61 @@ } }, "params": { + "Region": "eu-south-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-south-2" + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -1780,9 +1875,9 @@ } }, "params": { + "Region": "me-central-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "me-central-1" + "UseFIPS": true } }, { @@ -1793,9 +1888,9 @@ } }, "params": { + "Region": "me-central-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "me-central-1" + "UseFIPS": true } }, { @@ -1806,9 +1901,9 @@ } }, "params": { + "Region": "me-central-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "me-central-1" + "UseFIPS": false } }, { @@ -1819,9 +1914,9 @@ } }, "params": { + "Region": "me-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "me-central-1" + "UseFIPS": false } }, { @@ -1832,9 +1927,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ca-central-1" + "UseFIPS": true } }, { @@ -1845,9 +1940,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ca-central-1" + "UseFIPS": true } }, { @@ -1858,9 +1953,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ca-central-1" + "UseFIPS": false } }, { @@ -1871,9 +1966,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ca-central-1" + "UseFIPS": false } }, { @@ -1884,9 +1979,9 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-central-1" + "UseFIPS": true } }, { @@ -1897,9 +1992,9 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-central-1" + "UseFIPS": true } }, { @@ -1910,9 +2005,9 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-central-1" + "UseFIPS": false } }, { @@ -1923,9 +2018,61 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-central-1" + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -1936,9 +2083,9 @@ } }, "params": { + "Region": "us-west-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-1" + "UseFIPS": true } }, { @@ -1949,9 +2096,9 @@ } }, "params": { + "Region": "us-west-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-1" + "UseFIPS": true } }, { @@ -1962,9 +2109,9 @@ } }, "params": { + "Region": "us-west-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-1" + "UseFIPS": false } }, { @@ -1975,9 +2122,9 @@ } }, "params": { + "Region": "us-west-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-1" + "UseFIPS": false } }, { @@ -1988,9 +2135,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-2" + "UseFIPS": true } }, { @@ -2001,9 +2148,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-2" + "UseFIPS": true } }, { @@ -2014,9 +2161,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-2" + "UseFIPS": false } }, { @@ -2027,9 +2174,61 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-2" + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -2040,9 +2239,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-north-1" + "UseFIPS": true } }, { @@ -2053,9 +2252,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-north-1" + "UseFIPS": true } }, { @@ -2066,9 +2265,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-north-1" + "UseFIPS": false } }, { @@ -2079,9 +2278,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-north-1" + "UseFIPS": false } }, { @@ -2092,9 +2291,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-3" + "UseFIPS": true } }, { @@ -2105,9 +2304,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-3" + "UseFIPS": true } }, { @@ -2118,9 +2317,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-3" + "UseFIPS": false } }, { @@ -2131,9 +2330,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-3" + "UseFIPS": false } }, { @@ -2144,9 +2343,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-2" + "UseFIPS": true } }, { @@ -2157,9 +2356,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-2" + "UseFIPS": true } }, { @@ -2170,9 +2369,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-2" + "UseFIPS": false } }, { @@ -2183,9 +2382,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-2" + "UseFIPS": false } }, { @@ -2196,9 +2395,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-1" + "UseFIPS": true } }, { @@ -2209,9 +2408,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-1" + "UseFIPS": true } }, { @@ -2222,9 +2421,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-1" + "UseFIPS": false } }, { @@ -2235,9 +2434,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-1" + "UseFIPS": false } }, { @@ -2248,9 +2447,9 @@ } }, "params": { + "Region": "ap-northeast-3", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-3" + "UseFIPS": true } }, { @@ -2261,9 +2460,9 @@ } }, "params": { + "Region": "ap-northeast-3", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-3" + "UseFIPS": true } }, { @@ -2274,9 +2473,9 @@ } }, "params": { + "Region": "ap-northeast-3", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-3" + "UseFIPS": false } }, { @@ -2287,9 +2486,9 @@ } }, "params": { + "Region": "ap-northeast-3", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-3" + "UseFIPS": false } }, { @@ -2300,9 +2499,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-2" + "UseFIPS": true } }, { @@ -2313,9 +2512,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-2" + "UseFIPS": true } }, { @@ -2326,9 +2525,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-2" + "UseFIPS": false } }, { @@ -2339,9 +2538,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" + "UseFIPS": false } }, { @@ -2352,9 +2551,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-1" + "UseFIPS": true } }, { @@ -2365,9 +2564,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-1" + "UseFIPS": true } }, { @@ -2378,9 +2577,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-1" + "UseFIPS": false } }, { @@ -2391,9 +2590,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-1" + "UseFIPS": false } }, { @@ -2404,9 +2603,9 @@ } }, "params": { + "Region": "me-south-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "me-south-1" + "UseFIPS": true } }, { @@ -2417,9 +2616,9 @@ } }, "params": { + "Region": "me-south-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "me-south-1" + "UseFIPS": true } }, { @@ -2430,9 +2629,9 @@ } }, "params": { + "Region": "me-south-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "me-south-1" + "UseFIPS": false } }, { @@ -2443,9 +2642,9 @@ } }, "params": { + "Region": "me-south-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "me-south-1" + "UseFIPS": false } }, { @@ -2456,9 +2655,9 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "sa-east-1" + "UseFIPS": true } }, { @@ -2469,9 +2668,9 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "sa-east-1" + "UseFIPS": true } }, { @@ -2482,9 +2681,9 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "sa-east-1" + "UseFIPS": false } }, { @@ -2495,165 +2694,477 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "sa-east-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-1.api.aws" + "url": "https://resource-explorer-2-fips.ap-east-1.api.aws" } }, "params": { + "Region": "ap-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-1" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-1.api.aws" + "url": "https://resource-explorer-2-fips.ap-east-1.api.aws" } }, "params": { + "Region": "ap-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-1" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-1.api.aws" + "url": "https://resource-explorer-2.ap-east-1.api.aws" } }, "params": { + "Region": "ap-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-1.api.aws" + "url": "https://resource-explorer-2.ap-east-1.api.aws" } }, "params": { + "Region": "ap-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-2.api.aws" + "url": "https://resource-explorer-2-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-2" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-2.api.aws" + "url": "https://resource-explorer-2-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-2" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-2.api.aws" + "url": "https://resource-explorer-2.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-2" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-2.api.aws" + "url": "https://resource-explorer-2.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-2" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "documentation": "For region ca-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-3.api.aws" + "url": "https://resource-explorer-2-fips.ca-west-1.api.aws" } }, "params": { + "Region": "ca-west-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-3" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "documentation": "For region ca-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-3.api.aws" + "url": "https://resource-explorer-2-fips.ca-west-1.api.aws" } }, "params": { + "Region": "ca-west-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-3" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "documentation": "For region ca-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-3.api.aws" + "url": "https://resource-explorer-2.ca-west-1.api.aws" } }, "params": { + "Region": "ca-west-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-3" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ca-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-3.api.aws" + "url": "https://resource-explorer-2.ca-west-1.api.aws" } }, "params": { + "Region": "ca-west-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-3" + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -2664,9 +3175,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": true } }, { @@ -2677,9 +3188,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": true } }, { @@ -2690,9 +3201,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": false } }, { @@ -2703,9 +3214,61 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-6 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-6.api.aws" + } + }, + "params": { + "Region": "ap-southeast-6", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-6 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-6.api.aws" + } + }, + "params": { + "Region": "ap-southeast-6", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-6 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-6.api.aws" + } + }, + "params": { + "Region": "ap-southeast-6", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-6 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-6.api.aws" + } + }, + "params": { + "Region": "ap-southeast-6", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -2716,9 +3279,9 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-2" + "UseFIPS": true } }, { @@ -2729,9 +3292,9 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-2" + "UseFIPS": true } }, { @@ -2742,9 +3305,9 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-2" + "UseFIPS": false } }, { @@ -2755,9 +3318,61 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-2" + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -2768,9 +3383,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -2780,9 +3395,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -3235,7 +3850,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the type of the index from one of the following types to the other. For more\n information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on\n cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.

\n
    \n
  • \n

    \n \n AGGREGATOR index type\n

    \n

    The index contains information about resources from all Amazon Web Services Regions in the\n Amazon Web Services account in which you've created a Resource Explorer index. Resource information from\n all other Regions is replicated to this Region's index.

    \n

    When you change the index type to AGGREGATOR, Resource Explorer turns on\n replication of all discovered resource information from the other Amazon Web Services Regions\n in your account to this index. You can then, from this Region only, perform\n resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.\n Turning on replication from all other Regions is performed by asynchronous\n background tasks. You can check the status of the asynchronous tasks by using\n the GetIndex operation. When the asynchronous tasks complete,\n the Status response of that operation changes from\n UPDATING to ACTIVE. After that, you can start to\n see results from other Amazon Web Services Regions in query results. However, it can take\n several hours for replication from all other Regions to complete.

    \n \n

    You can have only one aggregator index per Amazon Web Services account. Before you can\n promote a different index to be the aggregator index for the account, you must\n first demote the existing aggregator index to type LOCAL.

    \n     \n
    • \n
  • \n

    \n \n LOCAL index type\n

    \n

    The index contains information about resources in only the Amazon Web Services Region in\n which the index exists. If an aggregator index in another Region exists, then\n information in this local index is replicated to the aggregator index.

    \n

    When you change the index type to LOCAL, Resource Explorer turns off the\n replication of resource information from all other Amazon Web Services Regions in the\n Amazon Web Services account to this Region. The aggregator index remains in the\n UPDATING state until all replication with other Regions\n successfully stops. You can check the status of the asynchronous task by using\n the GetIndex operation. When Resource Explorer successfully stops all\n replication with other Regions, the Status response of that\n operation changes from UPDATING to ACTIVE. Separately,\n the resource information from other Regions that was previously stored in the\n index is deleted within 30 days by another background task. Until that\n asynchronous task completes, some results from other Regions can continue to\n appear in search results.

    \n \n

    After you demote an aggregator index to a local index, you must wait\n 24 hours before you can promote another index to be the new\n aggregator index for the account.

    \n     \n
    • \n
", + "smithy.api#documentation": "

Changes the type of the index from one of the following types to the other. For more\n information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on\n cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.

\n
    \n
  • \n

    \n \n AGGREGATOR index type\n

    \n

    The index contains information about resources from all Amazon Web Services Regions in the\n Amazon Web Services account in which you've created a Resource Explorer index. Resource information from\n all other Regions is replicated to this Region's index.

    \n

    When you change the index type to AGGREGATOR, Resource Explorer turns on\n replication of all discovered resource information from the other Amazon Web Services Regions\n in your account to this index. You can then, from this Region only, perform\n resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.\n Turning on replication from all other Regions is performed by asynchronous\n background tasks. You can check the status of the asynchronous tasks by using\n the GetIndex operation. When the asynchronous tasks complete,\n the Status response of that operation changes from\n UPDATING to ACTIVE. After that, you can start to\n see results from other Amazon Web Services Regions in query results. However, it can take\n several hours for replication from all other Regions to complete.

    \n \n

    You can have only one aggregator index per Amazon Web Services account. Before you can\n promote a different index to be the aggregator index for the account, you must\n first demote the existing aggregator index to type LOCAL.

    \n     \n
    • \n
  • \n

    \n \n LOCAL index type\n

    \n

    The index contains information about resources in only the Amazon Web Services Region in\n which the index exists. If an aggregator index in another Region exists, then\n information in this local index is replicated to the aggregator index.

    \n

    When you change the index type to LOCAL, Resource Explorer turns off the\n replication of resource information from all other Amazon Web Services Regions in the\n Amazon Web Services account to this Region. The aggregator index remains in the\n UPDATING state until all replication with other Regions\n successfully stops. You can check the status of the asynchronous task by using\n the GetIndex operation. When Resource Explorer successfully stops all\n replication with other Regions, the Status response of that\n operation changes from UPDATING to ACTIVE. Separately,\n the resource information from other Regions that was previously stored in the\n index is deleted within 30 days by another background task. Until that\n asynchronous task completes, some results from other Regions can continue to\n appear in search results.

    \n \n

    After you demote an aggregator index to a local index, you must wait\n 24 hours before you can promote another index to be the new\n aggregator index for the account.

    \n     \n
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/UpdateIndexType" diff --git a/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json b/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json index 2c2ff2fe081..e7d35b1b472 100644 --- a/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json +++ b/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json @@ -52,7 +52,7 @@ } ], "traits": { - "smithy.api#documentation": "

Accepts the transfer of a domain from another Amazon Web Services account to the\n\t\t\t\tcurrentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.

\n\t\t

If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input\n\t\t\tinstead of text because otherwise CLI will throw an error from domain\n\t\t\ttransfer input that includes single quotes.

\n\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" + "smithy.api#documentation": "

Accepts the transfer of a domain from another Amazon Web Services account to the\n\t\t\t\tcurrentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.

\n

If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input\n\t\t\tinstead of text because otherwise CLI will throw an error from domain\n\t\t\ttransfer input that includes single quotes.

\n

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,\n\t\t\t\tDomain Transfer from Aws Account 111122223333 has been cancelled.

" } }, "com.amazonaws.route53domains#AcceptDomainTransferFromAnotherAwsAccountRequest": { @@ -61,20 +61,20 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that was specified when another Amazon Web Services account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t

", + "smithy.api#documentation": "

The name of the domain that was specified when another Amazon Web Services account\n\t\t\tsubmitted a TransferDomainToAnotherAwsAccount request.

", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.route53domains#String", "traits": { - "smithy.api#documentation": "

The password that was returned by the \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t

", + "smithy.api#documentation": "

The password that was returned by the TransferDomainToAnotherAwsAccount request.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The AcceptDomainTransferFromAnotherAwsAccount request includes the following elements.

" + "smithy.api#documentation": "

The AcceptDomainTransferFromAnotherAwsAccount request includes the following\n\t\t\telements.

" } }, "com.amazonaws.route53domains#AcceptDomainTransferFromAnotherAwsAccountResponse": { @@ -83,12 +83,12 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.

" + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } } }, "traits": { - "smithy.api#documentation": "

The AcceptDomainTransferFromAnotherAwsAccount response includes the following element.

" + "smithy.api#documentation": "

The AcceptDomainTransferFromAnotherAwsAccount response includes the following\n\t\t\telement.

" } }, "com.amazonaws.route53domains#AccountId": { @@ -110,13 +110,75 @@ } } }, + "com.amazonaws.route53domains#AssociateDelegationSignerToDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#AssociateDelegationSignerToDomainRequest" + }, + "output": { + "target": "com.amazonaws.route53domains#AssociateDelegationSignerToDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#DnssecLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#DuplicateRequest" + }, + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#TLDRulesViolation" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a delegation signer (DS) record in the registry zone for this domain\n\t\t\tname.

\n

Note that creating DS record at the registry impacts DNSSEC validation of your DNS\n\t\t\trecords. This action may render your domain name unavailable on the internet if the\n\t\t\tsteps are completed in the wrong order, or with incorrect timing. For more information\n\t\t\tabout DNSSEC signing, see Configuring DNSSEC\n\t\t\t\tsigning in the Route 53 developer\n\t\t\tguide.

" + } + }, + "com.amazonaws.route53domains#AssociateDelegationSignerToDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

", + "smithy.api#required": {} + } + }, + "SigningAttributes": { + "target": "com.amazonaws.route53domains#DnssecSigningAttributes", + "traits": { + "smithy.api#documentation": "

The information about a key, including the algorithm, public key-value, and\n\t\t\tflags.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53domains#AssociateDelegationSignerToDomainResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "

The identifier for tracking the progress of the request. To query the operation\n\t\t\tstatus, use GetOperationDetail.

" + } + } + } + }, "com.amazonaws.route53domains#BillingRecord": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that the billing record applies to. If the domain name contains characters \n\t\t\tother than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. \n\t\t\tFor more information, see \n\t\t\tDNS Domain Name Format \n\t\t\tin the Amazon Route 53 Developer Guide.

" + "smithy.api#documentation": "

The name of the domain that the billing record applies to. If the domain name contains\n\t\t\tcharacters other than a-z, 0-9, and - (hyphen), such as an internationalized domain\n\t\t\tname, then this value is in Punycode. For more information, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.

" } }, "Operation": { @@ -141,7 +203,7 @@ "target": "com.amazonaws.route53domains#Price", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The price that you were charged for the operation, in US dollars.

\n\t\t

Example value: 12.0

" + "smithy.api#documentation": "

The price that you were charged for the operation, in US dollars.

\n

Example value: 12.0

" } } }, @@ -178,7 +240,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t

\n\t\t\n\t\t \n\t\t\t

You must cancel the transfer before the other Amazon Web Services account accepts the transfer using \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.

\n\t\t \n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" + "smithy.api#documentation": "

Cancels the transfer of a domain from the current Amazon Web Services account to\n\t\t\tanother Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.

\n \n

You must cancel the transfer before the other Amazon Web Services account accepts\n\t\t\t\tthe transfer using AcceptDomainTransferFromAnotherAwsAccount.

\n \n

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,\n\t\t\t\tDomain Transfer from Aws Account 111122223333 has been cancelled.

" } }, "com.amazonaws.route53domains#CancelDomainTransferToAnotherAwsAccountRequest": { @@ -193,7 +255,7 @@ } }, "traits": { - "smithy.api#documentation": "

The CancelDomainTransferToAnotherAwsAccount request includes the following element.

" + "smithy.api#documentation": "

The CancelDomainTransferToAnotherAwsAccount request includes the following\n\t\t\telement.

" } }, "com.amazonaws.route53domains#CancelDomainTransferToAnotherAwsAccountResponse": { @@ -202,12 +264,12 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. \n\t\t\tBecause the transfer request was canceled, the value is no longer valid, and you can't use GetOperationDetail \n\t\t\tto query the operation status.

" + "smithy.api#documentation": "

The identifier that TransferDomainToAnotherAwsAccount returned to track\n\t\t\tthe progress of the request. Because the transfer request was canceled, the value is no\n\t\t\tlonger valid, and you can't use GetOperationDetail to query the operation\n\t\t\tstatus.

" } } }, "traits": { - "smithy.api#documentation": "

The CancelDomainTransferToAnotherAwsAccount response includes the following element.

" + "smithy.api#documentation": "

The CancelDomainTransferToAnotherAwsAccount response includes the\n\t\t\tfollowing element.

" } }, "com.amazonaws.route53domains#CheckDomainAvailability": { @@ -227,7 +289,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must \n\t\t\tsubmit another request to determine the availability of the domain name.

" + "smithy.api#documentation": "

This operation checks the availability of one domain name. Note that if the\n\t\t\tavailability status of a domain is pending, you must submit another request to determine\n\t\t\tthe availability of the domain name.

" } }, "com.amazonaws.route53domains#CheckDomainAvailabilityRequest": { @@ -236,7 +298,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

The domain name can contain only the following characters:

\n\t\t
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in example.com.

    \n
    • \n
\n\t\t

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports \n\t\t\tinternationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\tFor more information, see \n\t\t\tFormatting Internationalized Domain Names.\n\t\t

", + "smithy.api#documentation": "

The name of the domain that you want to get availability for. The top-level domain\n\t\t\t(TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

The domain name can contain only the following characters:

\n
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.

    \n
    • \n
\n

Internationalized domain names are not supported for some top-level domains. To\n\t\t\tdetermine whether the TLD that you want to use supports internationalized domain names,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

", "smithy.api#required": {} } }, @@ -257,8 +319,7 @@ "Availability": { "target": "com.amazonaws.route53domains#DomainAvailability", "traits": { - "smithy.api#documentation": "

Whether the domain name is available for registering.

\n\t\t \n

You can register only domains designated as AVAILABLE.

\n \n\t\t

Valid values:

\n\t\t
\n
AVAILABLE
\n
\n

The domain name is available.

\n
\n
AVAILABLE_RESERVED
\n
\n

The domain name is reserved under specific conditions.

\n
\n
AVAILABLE_PREORDER
\n
\n

The domain name is available and can be preordered.

\n
\n
DONT_KNOW
\n
\n

The TLD registry didn't reply with a definitive answer about whether the domain name is available. \n\t\t\t\t\tRoute 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. \n\t\t\t\t\tTry again later.

\n
\n
PENDING
\n
\n

The TLD registry didn't return a response in the expected amount of time. When the response is delayed, \n\t\t\t\t\tit usually takes just a few extra seconds. You can resubmit the request immediately.

\n
\n
RESERVED
\n
\n

The domain name has been reserved for another person or organization.

\n
\n
UNAVAILABLE
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_PREMIUM
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_RESTRICTED
\n
\n

The domain name is forbidden.

\n
\n
", - "smithy.api#required": {} + "smithy.api#documentation": "

Whether the domain name is available for registering.

\n \n

You can register only domains designated as AVAILABLE.

\n \n

Valid values:

\n
\n
AVAILABLE
\n
\n

The domain name is available.

\n
\n
AVAILABLE_RESERVED
\n
\n

The domain name is reserved under specific conditions.

\n
\n
AVAILABLE_PREORDER
\n
\n

The domain name is available and can be preordered.

\n
\n
DONT_KNOW
\n
\n

The TLD registry didn't reply with a definitive answer about whether the\n\t\t\t\t\t\tdomain name is available. Route 53 can return this response for a variety of\n\t\t\t\t\t\treasons, for example, the registry is performing maintenance. Try again\n\t\t\t\t\t\tlater.

\n
\n
PENDING
\n
\n

The TLD registry didn't return a response in the expected amount of time.\n\t\t\t\t\t\tWhen the response is delayed, it usually takes just a few extra seconds. You\n\t\t\t\t\t\tcan resubmit the request immediately.

\n
\n
RESERVED
\n
\n

The domain name has been reserved for another person or\n\t\t\t\t\t\torganization.

\n
\n
UNAVAILABLE
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_PREMIUM
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_RESTRICTED
\n
\n

The domain name is forbidden.

\n
\n
" } } }, @@ -292,14 +353,14 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

The domain name can contain only the following characters:

\n\t\t
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in example.com.

    \n
    • \n
", + "smithy.api#documentation": "

The name of the domain that you want to transfer to Route 53. The top-level domain\n\t\t\t(TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

The domain name can contain only the following characters:

\n
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.

    \n
    • \n
", "smithy.api#required": {} } }, "AuthCode": { "target": "com.amazonaws.route53domains#DomainAuthCode", "traits": { - "smithy.api#documentation": "

If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, \n\t\t\tthe code that you got from the current registrar for the domain.

" + "smithy.api#documentation": "

If the registrar for the top-level domain (TLD) requires an authorization code to\n\t\t\ttransfer the domain, the code that you got from the current registrar for the\n\t\t\tdomain.

" } } }, @@ -313,8 +374,7 @@ "Transferability": { "target": "com.amazonaws.route53domains#DomainTransferability", "traits": { - "smithy.api#documentation": "

A complex type that contains information about whether the specified domain can be transferred to Route 53.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A complex type that contains information about whether the specified domain can be\n\t\t\ttransferred to Route 53.

" } } }, @@ -331,6 +391,29 @@ } } }, + "com.amazonaws.route53domains#Consent": { + "type": "structure", + "members": { + "MaxPrice": { + "target": "com.amazonaws.route53domains#Price", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum amount the customer agreed to accept.

", + "smithy.api#required": {} + } + }, + "Currency": { + "target": "com.amazonaws.route53domains#Currency", + "traits": { + "smithy.api#documentation": "

Currency for the MaxPrice.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Customer's consent for the owner change request.

" + } + }, "com.amazonaws.route53domains#ContactDetail": { "type": "structure", "members": { @@ -349,7 +432,7 @@ "ContactType": { "target": "com.amazonaws.route53domains#ContactType", "traits": { - "smithy.api#documentation": "

Indicates whether the contact is a person, company, association, or public organization. Note the following:

\n\t\t
    \n
  • \n

    If you specify a value other than PERSON, you must also specify a value for \n\t\t\t\tOrganizationName.

    \n
    • \n
  • \n

    For some TLDs, the privacy protection available depends on the value that you specify for \n\t\t\t\tContact Type. For the privacy protection settings for your TLD, see \n\t\t\t\tDomains that You Can \n\t\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer Guide\n

    \n
    • \n
  • \n

    For .es domains, the value of ContactType must be PERSON for all three contacts.

    \n
    • \n
" + "smithy.api#documentation": "

Indicates whether the contact is a person, company, association, or public\n\t\t\torganization. Note the following:

\n
    \n
  • \n

    If you specify a value other than PERSON, you must also specify a\n\t\t\t\t\tvalue for OrganizationName.

    \n
    • \n
  • \n

    For some TLDs, the privacy protection available depends on the value that you\n\t\t\t\t\tspecify for Contact Type. For the privacy protection settings for\n\t\t\t\t\tyour TLD, see Domains that You\n\t\t\t\t\t\tCan Register with Amazon Route 53 in the Amazon Route 53\n\t\t\t\t\t\tDeveloper Guide\n

    \n
    • \n
  • \n

    For .es domains, the value of ContactType must be\n\t\t\t\t\t\tPERSON for all three contacts.

    \n
    • \n
" } }, "OrganizationName": { @@ -397,7 +480,7 @@ "PhoneNumber": { "target": "com.amazonaws.route53domains#ContactNumber", "traits": { - "smithy.api#documentation": "

The phone number of the contact.

\n\t\t

Constraints: Phone number must be specified in the format \"+[country\tdialing code].[number including any area code>]\". \n\t\t\tFor example, a US phone number might appear as \"+1.1234567890\".

" + "smithy.api#documentation": "

The phone number of the contact.

\n

Constraints: Phone number must be specified in the format \"+[country dialing\n\t\t\tcode].[number including any area code>]\". For example, a US phone number might appear\n\t\t\tas \"+1.1234567890\".

" } }, "Email": { @@ -409,13 +492,13 @@ "Fax": { "target": "com.amazonaws.route53domains#ContactNumber", "traits": { - "smithy.api#documentation": "

Fax number of the contact.

\n\t\t

Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". \n\t\t\tFor example, a US phone number might appear as \"+1.1234567890\".

" + "smithy.api#documentation": "

Fax number of the contact.

\n

Constraints: Phone number must be specified in the format \"+[country dialing\n\t\t\tcode].[number including any area code]\". For example, a US phone number might appear as\n\t\t\t\t\"+1.1234567890\".

" } }, "ExtraParams": { "target": "com.amazonaws.route53domains#ExtraParamList", "traits": { - "smithy.api#documentation": "

A list of name-value pairs for parameters required by certain top-level domains.

" + "smithy.api#documentation": "

A list of name-value pairs for parameters required by certain top-level\n\t\t\tdomains.

" } } }, @@ -443,1041 +526,1549 @@ } }, "com.amazonaws.route53domains#ContactType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PERSON", - "name": "PERSON" - }, - { - "value": "COMPANY", - "name": "COMPANY" - }, - { - "value": "ASSOCIATION", - "name": "ASSOCIATION" - }, - { - "value": "PUBLIC_BODY", - "name": "PUBLIC_BODY" - }, - { - "value": "RESELLER", - "name": "RESELLER" + "type": "enum", + "members": { + "PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSON" + } + }, + "COMPANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPANY" + } + }, + "ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATION" + } + }, + "PUBLIC_BODY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC_BODY" + } + }, + "RESELLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESELLER" } - ] + } } }, "com.amazonaws.route53domains#CountryCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AC", - "name": "AC" - }, - { - "value": "AD", - "name": "AD" - }, - { - "value": "AE", - "name": "AE" - }, - { - "value": "AF", - "name": "AF" - }, - { - "value": "AG", - "name": "AG" - }, - { - "value": "AI", - "name": "AI" - }, - { - "value": "AL", - "name": "AL" - }, - { - "value": "AM", - "name": "AM" - }, - { - "value": "AN", - "name": "AN" - }, - { - "value": "AO", - "name": "AO" - }, - { - "value": "AQ", - "name": "AQ" - }, - { - "value": "AR", - "name": "AR" - }, - { - "value": "AS", - "name": "AS" - }, - { - "value": "AT", - "name": "AT" - }, - { - "value": "AU", - "name": "AU" - }, - { - "value": "AW", - "name": "AW" - }, - { - "value": "AX", - "name": "AX" - }, - { - "value": "AZ", - "name": "AZ" - }, - { - "value": "BA", - "name": "BA" - }, - { - "value": "BB", - "name": "BB" - }, - { - "value": "BD", - "name": "BD" - }, - { - "value": "BE", - "name": "BE" - }, - { - "value": "BF", - "name": "BF" - }, - { - "value": "BG", - "name": "BG" - }, - { - "value": "BH", - "name": "BH" - }, - { - "value": "BI", - "name": "BI" - }, - { - "value": "BJ", - "name": "BJ" - }, - { - "value": "BL", - "name": "BL" - }, - { - "value": "BM", - "name": "BM" - }, - { - "value": "BN", - "name": "BN" - }, - { - "value": "BO", - "name": "BO" - }, - { - "value": "BQ", - "name": "BQ" - }, - { - "value": "BR", - "name": "BR" - }, - { - "value": "BS", - "name": "BS" - }, - { - "value": "BT", - "name": "BT" - }, - { - "value": "BV", - "name": "BV" - }, - { - "value": "BW", - "name": "BW" - }, - { - "value": "BY", - "name": "BY" - }, - { - "value": "BZ", - "name": "BZ" - }, - { - "value": "CA", - "name": "CA" - }, - { - "value": "CC", - "name": "CC" - }, - { - "value": "CD", - "name": "CD" - }, - { - "value": "CF", - "name": "CF" - }, - { - "value": "CG", - "name": "CG" - }, - { - "value": "CH", - "name": "CH" - }, - { - "value": "CI", - "name": "CI" - }, - { - "value": "CK", - "name": "CK" - }, - { - "value": "CL", - "name": "CL" - }, - { - "value": "CM", - "name": "CM" - }, - { - "value": "CN", - "name": "CN" - }, - { - "value": "CO", - "name": "CO" - }, - { - "value": "CR", - "name": "CR" - }, - { - "value": "CU", - "name": "CU" - }, - { - "value": "CV", - "name": "CV" - }, - { - "value": "CW", - "name": "CW" - }, - { - "value": "CX", - "name": "CX" - }, - { - "value": "CY", - "name": "CY" - }, - { - "value": "CZ", - "name": "CZ" - }, - { - "value": "DE", - "name": "DE" - }, - { - "value": "DJ", - "name": "DJ" - }, - { - "value": "DK", - "name": "DK" - }, - { - "value": "DM", - "name": "DM" - }, - { - "value": "DO", - "name": "DO" - }, - { - "value": "DZ", - "name": "DZ" - }, - { - "value": "EC", - "name": "EC" - }, - { - "value": "EE", - "name": "EE" - }, - { - "value": "EG", - "name": "EG" - }, - { - "value": "EH", - "name": "EH" - }, - { - "value": "ER", - "name": "ER" - }, - { - "value": "ES", - "name": "ES" - }, - { - "value": "ET", - "name": "ET" - }, - { - "value": "FI", - "name": "FI" - }, - { - "value": "FJ", - "name": "FJ" - }, - { - "value": "FK", - "name": "FK" - }, - { - "value": "FM", - "name": "FM" - }, - { - "value": "FO", - "name": "FO" - }, - { - "value": "FR", - "name": "FR" - }, - { - "value": "GA", - "name": "GA" - }, - { - "value": "GB", - "name": "GB" - }, - { - "value": "GD", - "name": "GD" - }, - { - "value": "GE", - "name": "GE" - }, - { - "value": "GF", - "name": "GF" - }, - { - "value": "GG", - "name": "GG" - }, - { - "value": "GH", - "name": "GH" - }, - { - "value": "GI", - "name": "GI" - }, - { - "value": "GL", - "name": "GL" - }, - { - "value": "GM", - "name": "GM" - }, - { - "value": "GN", - "name": "GN" - }, - { - "value": "GP", - "name": "GP" - }, - { - "value": "GQ", - "name": "GQ" - }, - { - "value": "GR", - "name": "GR" - }, - { - "value": "GS", - "name": "GS" - }, - { - "value": "GT", - "name": "GT" - }, - { - "value": "GU", - "name": "GU" - }, - { - "value": "GW", - "name": "GW" - }, - { - "value": "GY", - "name": "GY" - }, - { - "value": "HK", - "name": "HK" - }, - { - "value": "HM", - "name": "HM" - }, - { - "value": "HN", - "name": "HN" - }, - { - "value": "HR", - "name": "HR" - }, - { - "value": "HT", - "name": "HT" - }, - { - "value": "HU", - "name": "HU" - }, - { - "value": "ID", - "name": "ID" - }, - { - "value": "IE", - "name": "IE" - }, - { - "value": "IL", - "name": "IL" - }, - { - "value": "IM", - "name": "IM" - }, - { - "value": "IN", - "name": "IN" - }, - { - "value": "IO", - "name": "IO" - }, - { - "value": "IQ", - "name": "IQ" - }, - { - "value": "IR", - "name": "IR" - }, - { - "value": "IS", - "name": "IS" - }, - { - "value": "IT", - "name": "IT" - }, - { - "value": "JE", - "name": "JE" - }, - { - "value": "JM", - "name": "JM" - }, - { - "value": "JO", - "name": "JO" - }, - { - "value": "JP", - "name": "JP" - }, - { - "value": "KE", - "name": "KE" - }, - { - "value": "KG", - "name": "KG" - }, - { - "value": "KH", - "name": "KH" - }, - { - "value": "KI", - "name": "KI" - }, - { - "value": "KM", - "name": "KM" - }, - { - "value": "KN", - "name": "KN" - }, - { - "value": "KP", - "name": "KP" - }, - { - "value": "KR", - "name": "KR" - }, - { - "value": "KW", - "name": "KW" - }, - { - "value": "KY", - "name": "KY" - }, - { - "value": "KZ", - "name": "KZ" - }, - { - "value": "LA", - "name": "LA" - }, - { - "value": "LB", - "name": "LB" - }, - { - "value": "LC", - "name": "LC" - }, - { - "value": "LI", - "name": "LI" - }, - { - "value": "LK", - "name": "LK" - }, - { - "value": "LR", - "name": "LR" - }, - { - "value": "LS", - "name": "LS" - }, - { - "value": "LT", - "name": "LT" - }, - { - "value": "LU", - "name": "LU" - }, - { - "value": "LV", - "name": "LV" - }, - { - "value": "LY", - "name": "LY" - }, - { - "value": "MA", - "name": "MA" - }, - { - "value": "MC", - "name": "MC" - }, - { - "value": "MD", - "name": "MD" - }, - { - "value": "ME", - "name": "ME" - }, - { - "value": "MF", - "name": "MF" - }, - { - "value": "MG", - "name": "MG" - }, - { - "value": "MH", - "name": "MH" - }, - { - "value": "MK", - "name": "MK" - }, - { - "value": "ML", - "name": "ML" - }, - { - "value": "MM", - "name": "MM" - }, - { - "value": "MN", - "name": "MN" - }, - { - "value": "MO", - "name": "MO" - }, - { - "value": "MP", - "name": "MP" - }, - { - "value": "MQ", - "name": "MQ" - }, - { - "value": "MR", - "name": "MR" - }, - { - "value": "MS", - "name": "MS" - }, - { - "value": "MT", - "name": "MT" - }, - { - "value": "MU", - "name": "MU" - }, - { - "value": "MV", - "name": "MV" - }, - { - "value": "MW", - "name": "MW" - }, - { - "value": "MX", - "name": "MX" - }, - { - "value": "MY", - "name": "MY" - }, - { - "value": "MZ", - "name": "MZ" - }, - { - "value": "NA", - "name": "NA" - }, - { - "value": "NC", - "name": "NC" - }, - { - "value": "NE", - "name": "NE" - }, - { - "value": "NF", - "name": "NF" - }, - { - "value": "NG", - "name": "NG" - }, - { - "value": "NI", - "name": "NI" - }, - { - "value": "NL", - "name": "NL" - }, - { - "value": "NO", - "name": "NO" - }, - { - "value": "NP", - "name": "NP" - }, - { - "value": "NR", - "name": "NR" - }, - { - "value": "NU", - "name": "NU" - }, - { - "value": "NZ", - "name": "NZ" - }, - { - "value": "OM", - "name": "OM" - }, - { - "value": "PA", - "name": "PA" - }, - { - "value": "PE", - "name": "PE" - }, - { - "value": "PF", - "name": "PF" - }, - { - "value": "PG", - "name": "PG" - }, - { - "value": "PH", - "name": "PH" - }, - { - "value": "PK", - "name": "PK" - }, - { - "value": "PL", - "name": "PL" - }, - { - "value": "PM", - "name": "PM" - }, - { - "value": "PN", - "name": "PN" - }, - { - "value": "PR", - "name": "PR" - }, - { - "value": "PS", - "name": "PS" - }, - { - "value": "PT", - "name": "PT" - }, - { - "value": "PW", - "name": "PW" - }, - { - "value": "PY", - "name": "PY" - }, - { - "value": "QA", - "name": "QA" - }, - { - "value": "RE", - "name": "RE" - }, - { - "value": "RO", - "name": "RO" - }, - { - "value": "RS", - "name": "RS" - }, - { - "value": "RU", - "name": "RU" - }, - { - "value": "RW", - "name": "RW" - }, - { - "value": "SA", - "name": "SA" - }, - { - "value": "SB", - "name": "SB" - }, - { - "value": "SC", - "name": "SC" - }, - { - "value": "SD", - "name": "SD" - }, - { - "value": "SE", - "name": "SE" - }, - { - "value": "SG", - "name": "SG" - }, - { - "value": "SH", - "name": "SH" - }, - { - "value": "SI", - "name": "SI" - }, - { - "value": "SJ", - "name": "SJ" - }, - { - "value": "SK", - "name": "SK" - }, - { - "value": "SL", - "name": "SL" - }, - { - "value": "SM", - "name": "SM" - }, - { - "value": "SN", - "name": "SN" - }, - { - "value": "SO", - "name": "SO" - }, - { - "value": "SR", - "name": "SR" - }, - { - "value": "SS", - "name": "SS" - }, - { - "value": "ST", - "name": "ST" - }, - { - "value": "SV", - "name": "SV" - }, - { - "value": "SX", - "name": "SX" - }, - { - "value": "SY", - "name": "SY" - }, - { - "value": "SZ", - "name": "SZ" - }, - { - "value": "TC", - "name": "TC" - }, - { - "value": "TD", - "name": "TD" - }, - { - "value": "TF", - "name": "TF" - }, - { - "value": "TG", - "name": "TG" - }, - { - "value": "TH", - "name": "TH" - }, - { - "value": "TJ", - "name": "TJ" - }, - { - "value": "TK", - "name": "TK" - }, - { - "value": "TL", - "name": "TL" - }, - { - "value": "TM", - "name": "TM" - }, - { - "value": "TN", - "name": "TN" - }, - { - "value": "TO", - "name": "TO" - }, - { - "value": "TP", - "name": "TP" - }, - { - "value": "TR", - "name": "TR" - }, - { - "value": "TT", - "name": "TT" - }, - { - "value": "TV", - "name": "TV" - }, - { - "value": "TW", - "name": "TW" - }, - { - "value": "TZ", - "name": "TZ" - }, - { - "value": "UA", - "name": "UA" - }, - { - "value": "UG", - "name": "UG" - }, - { - "value": "US", - "name": "US" - }, - { - "value": "UY", - "name": "UY" - }, - { - "value": "UZ", - "name": "UZ" - }, - { - "value": "VA", - "name": "VA" - }, - { - "value": "VC", - "name": "VC" - }, - { - "value": "VE", - "name": "VE" - }, - { - "value": "VG", - "name": "VG" - }, - { - "value": "VI", - "name": "VI" - }, - { - "value": "VN", - "name": "VN" - }, - { - "value": "VU", - "name": "VU" - }, - { - "value": "WF", - "name": "WF" - }, - { - "value": "WS", - "name": "WS" - }, - { - "value": "YE", - "name": "YE" - }, - { - "value": "YT", - "name": "YT" - }, - { - "value": "ZA", - "name": "ZA" - }, - { - "value": "ZM", - "name": "ZM" - }, - { - "value": "ZW", - "name": "ZW" + "type": "enum", + "members": { + "AC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AC" + } + }, + "AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AD" + } + }, + "AE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AE" + } + }, + "AF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AF" + } + }, + "AG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AG" + } + }, + "AI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI" + } + }, + "AL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL" + } + }, + "AM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AM" + } + }, + "AN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AN" + } + }, + "AO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AO" + } + }, + "AQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AQ" + } + }, + "AR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AR" + } + }, + "AS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AS" + } + }, + "AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT" + } + }, + "AU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU" + } + }, + "AW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AW" + } + }, + "AX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AX" + } + }, + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "BA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BA" + } + }, + "BB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BB" + } + }, + "BD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BD" + } + }, + "BE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BE" + } + }, + "BF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BF" + } + }, + "BG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BG" + } + }, + "BH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BH" + } + }, + "BI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BI" + } + }, + "BJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BJ" + } + }, + "BL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BL" + } + }, + "BM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BM" + } + }, + "BN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BN" + } + }, + "BO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BO" + } + }, + "BQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BQ" + } + }, + "BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BR" + } + }, + "BS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BS" + } + }, + "BT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BT" + } + }, + "BV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BV" + } + }, + "BW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BW" + } + }, + "BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BY" + } + }, + "BZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZ" + } + }, + "CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA" + } + }, + "CC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CC" + } + }, + "CD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CD" + } + }, + "CF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CF" + } + }, + "CG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CG" + } + }, + "CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CH" + } + }, + "CI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CI" + } + }, + "CK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CK" + } + }, + "CL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CL" + } + }, + "CM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CM" + } + }, + "CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CN" + } + }, + "CO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" + } + }, + "CR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR" + } + }, + "CU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CU" + } + }, + "CV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CV" + } + }, + "CW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CW" + } + }, + "CX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CX" + } + }, + "CY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CY" + } + }, + "CZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CZ" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DE" + } + }, + "DJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DJ" + } + }, + "DK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DK" + } + }, + "DM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DM" + } + }, + "DO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO" + } + }, + "DZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DZ" + } + }, + "EC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC" + } + }, + "EE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EE" + } + }, + "EG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EG" + } + }, + "EH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EH" + } + }, + "ER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ER" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES" + } + }, + "ET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ET" + } + }, + "FI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI" + } + }, + "FJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FJ" + } + }, + "FK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FK" + } + }, + "FM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FM" + } + }, + "FO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FO" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FR" + } + }, + "GA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GA" + } + }, + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } + }, + "GD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GD" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "GF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GF" + } + }, + "GG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GG" + } + }, + "GH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GH" + } + }, + "GI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GI" + } + }, + "GL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GL" + } + }, + "GM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GM" + } + }, + "GN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GN" + } + }, + "GP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GP" + } + }, + "GQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GQ" + } + }, + "GR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GR" + } + }, + "GS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GS" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "GU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GU" + } + }, + "GW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GW" + } + }, + "GY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GY" + } + }, + "HK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HK" + } + }, + "HM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HM" + } + }, + "HN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HN" + } + }, + "HR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HR" + } + }, + "HT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HT" + } + }, + "HU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HU" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + }, + "IE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IE" + } + }, + "IL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IL" + } + }, + "IM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IM" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "IO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IO" + } + }, + "IQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IQ" + } + }, + "IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IR" + } + }, + "IS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IS" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT" + } + }, + "JE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JE" + } + }, + "JM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JM" + } + }, + "JO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JO" + } + }, + "JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JP" + } + }, + "KE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KE" + } + }, + "KG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KG" + } + }, + "KH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KH" + } + }, + "KI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KI" + } + }, + "KM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KM" + } + }, + "KN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KN" + } + }, + "KP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KP" + } + }, + "KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KR" + } + }, + "KW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KW" + } + }, + "KY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KY" + } + }, + "KZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KZ" + } + }, + "LA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LA" + } + }, + "LB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LB" + } + }, + "LC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LC" + } + }, + "LI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LI" + } + }, + "LK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LK" + } + }, + "LR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LR" + } + }, + "LS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LS" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "LU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LU" + } + }, + "LV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LV" + } + }, + "LY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LY" + } + }, + "MA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MA" + } + }, + "MC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MC" + } + }, + "MD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD" + } + }, + "ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ME" + } + }, + "MF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MF" + } + }, + "MG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MG" + } + }, + "MH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MH" + } + }, + "MK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MK" + } + }, + "ML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ML" + } + }, + "MM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MM" + } + }, + "MN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MN" + } + }, + "MO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MO" + } + }, + "MP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MP" + } + }, + "MQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MQ" + } + }, + "MR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MR" + } + }, + "MS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS" + } + }, + "MT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MT" + } + }, + "MU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MU" + } + }, + "MV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MV" + } + }, + "MW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MW" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "MY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MY" + } + }, + "MZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MZ" + } + }, + "NA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NA" + } + }, + "NC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NC" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "NF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NF" + } + }, + "NG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NG" + } + }, + "NI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NI" + } + }, + "NL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NL" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "NP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NP" + } + }, + "NR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NR" + } + }, + "NU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NU" + } + }, + "NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NZ" + } + }, + "OM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OM" + } + }, + "PA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PA" + } + }, + "PE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PE" + } + }, + "PF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PF" + } + }, + "PG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PG" + } + }, + "PH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PH" + } + }, + "PK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PK" + } + }, + "PL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PL" + } + }, + "PM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PM" + } + }, + "PN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PN" + } + }, + "PR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PR" + } + }, + "PS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PS" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT" + } + }, + "PW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PW" + } + }, + "PY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PY" + } + }, + "QA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QA" + } + }, + "RE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RE" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RO" + } + }, + "RS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RS" + } + }, + "RU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RU" + } + }, + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RW" + } + }, + "SA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SA" + } + }, + "SB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SB" + } + }, + "SC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SC" + } + }, + "SD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SD" + } + }, + "SE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SE" + } + }, + "SG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SG" + } + }, + "SH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SH" + } + }, + "SI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SI" + } + }, + "SJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SJ" + } + }, + "SK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SK" + } + }, + "SL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SL" + } + }, + "SM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SM" + } + }, + "SN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SN" + } + }, + "SO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SO" + } + }, + "SR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SR" + } + }, + "SS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SS" + } + }, + "ST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ST" + } + }, + "SV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SV" + } + }, + "SX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SX" + } + }, + "SY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SY" + } + }, + "SZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SZ" + } + }, + "TC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TC" + } + }, + "TD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TD" + } + }, + "TF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TF" + } + }, + "TG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TG" + } + }, + "TH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TH" + } + }, + "TJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TJ" + } + }, + "TK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TK" + } + }, + "TL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TL" + } + }, + "TM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TM" + } + }, + "TN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TN" + } + }, + "TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO" + } + }, + "TP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TP" + } + }, + "TR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TR" + } + }, + "TT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TT" + } + }, + "TV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TV" + } + }, + "TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TW" + } + }, + "TZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TZ" + } + }, + "UA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UA" + } + }, + "UG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UG" + } + }, + "US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US" + } + }, + "UY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UY" + } + }, + "UZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UZ" + } + }, + "VA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VA" + } + }, + "VC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VC" + } + }, + "VE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VE" + } + }, + "VG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VG" + } + }, + "VI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VI" + } + }, + "VN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VN" + } + }, + "VU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VU" + } + }, + "WF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WF" + } + }, + "WS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WS" + } + }, + "YE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YE" + } + }, + "YT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YT" + } + }, + "ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZA" + } + }, + "ZM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZM" + } + }, + "ZW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZW" } - ] + } } }, "com.amazonaws.route53domains#Currency": { @@ -1521,7 +2112,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation deletes the specified domain. This action is permanent. For more information,\n\t\t\tsee Deleting a domain name registration.

\n\t\t

To transfer the domain registration to another registrar, use the transfer process that’s\n\t\t\tprovided by the registrar to which you want to transfer the registration. Otherwise,\n\t\t\tthe following apply:

\n\t\t
    \n
  1. \n

    You can’t get a refund for the cost of a deleted domain registration.

    \n
    2. \n
  2. \n

    The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry).

    \n
    3. \n
  3. \n

    When the registration has been deleted, we'll send you a confirmation to the registrant\n\t\t\t\tcontact. The email will come from\n\t\t\t\tnoreply@domainnameverification.net or\n\t\t\t\tnoreply@registrar.amazon.com.

    \n
    4. \n
" + "smithy.api#documentation": "

This operation deletes the specified domain. This action is permanent. For more\n\t\t\tinformation, see Deleting a domain name\n\t\t\t\tregistration.

\n

To transfer the domain registration to another registrar, use the transfer process\n\t\t\tthat’s provided by the registrar to which you want to transfer the registration.\n\t\t\tOtherwise, the following apply:

\n
    \n
  1. \n

    You can’t get a refund for the cost of a deleted domain registration.

    \n
    2. \n
  2. \n

    The registry for the top-level domain might hold the domain name for a brief\n\t\t\t\t\ttime before releasing it for other users to register (varies by registry).\n\t\t\t\t

    \n
    3. \n
  3. \n

    When the registration has been deleted, we'll send you a confirmation to the\n\t\t\t\t\tregistrant contact. The email will come from\n\t\t\t\t\t\tnoreply@domainnameverification.net or\n\t\t\t\t\t\tnoreply@registrar.amazon.com.

    \n
    4. \n
" } }, "com.amazonaws.route53domains#DeleteDomainRequest": { @@ -1542,7 +2133,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. \n\t\t\tTo query the operation status, use GetOperationDetail.

" + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } } } @@ -1567,7 +2158,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation deletes the specified tags for a domain.

\n\t\t

All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

" + "smithy.api#documentation": "

This operation deletes the specified tags for a domain.

\n

All tag operations are eventually consistent; subsequent operations might not\n\t\t\timmediately represent all issued operations.

" } }, "com.amazonaws.route53domains#DeleteTagsForDomainRequest": { @@ -1613,7 +2204,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation disables automatic renewal of domain registration for the specified domain.

" + "smithy.api#documentation": "

This operation disables automatic renewal of domain registration for the specified\n\t\t\tdomain.

" } }, "com.amazonaws.route53domains#DisableDomainAutoRenewRequest": { @@ -1658,7 +2249,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation removes the transfer lock on the domain (specifically the\n\t\t\tclientTransferProhibited status) to allow domain transfers. We recommend\n\t\t\tyou refrain from performing this action unless you intend to transfer the domain to a\n\t\t\tdifferent registrar. Successful submission returns an operation ID that you can use to track\n\t\t\tthe progress and completion of the action. If the request is not completed successfully, the\n\t\t\tdomain registrant will be notified by email.

" + "smithy.api#documentation": "

This operation removes the transfer lock on the domain (specifically the\n\t\t\t\tclientTransferProhibited status) to allow domain transfers. We\n\t\t\trecommend you refrain from performing this action unless you intend to transfer the\n\t\t\tdomain to a different registrar. Successful submission returns an operation ID that you\n\t\t\tcan use to track the progress and completion of the action. If the request is not\n\t\t\tcompleted successfully, the domain registrant will be notified by email.

" } }, "com.amazonaws.route53domains#DisableDomainTransferLockRequest": { @@ -1682,8 +2273,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } } }, @@ -1691,6 +2281,169 @@ "smithy.api#documentation": "

The DisableDomainTransferLock response includes the following element.

" } }, + "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainRequest" + }, + "output": { + "target": "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#DuplicateRequest" + }, + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#TLDRulesViolation" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a delegation signer (DS) record in the registry zone for this domain\n\t\t\tname.

" + } + }, + "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "

Name of the domain.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.route53domains#String", + "traits": { + "smithy.api#documentation": "

An internal identification number assigned to each DS record after it’s created. You\n\t\t\tcan retrieve it as part of DNSSEC information returned by GetDomainDetail.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" + } + } + } + }, + "com.amazonaws.route53domains#DnssecKey": { + "type": "structure", + "members": { + "Algorithm": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of the public key’s cryptographic algorithm according to an IANA assignment.

\n

If Route 53 is your DNS service, set this to 13.

\n

For more information about enabling DNSSEC signing, see Enabling DNSSEC signing and establishing a chain of trust.

" + } + }, + "Flags": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "

Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK\n\t\t\t(zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS\n\t\t\tprovider isn't Route 53 and you don’t have KSK available.

\n

If you have KSK and ZSK keys, always use KSK to create a delegations signer (DS)\n\t\t\trecord. If you have ZSK keys only – use ZSK to create a DS record.

" + } + }, + "PublicKey": { + "target": "com.amazonaws.route53domains#DnssecPublicKey", + "traits": { + "smithy.api#documentation": "

The base64-encoded public key part of the key pair that is passed to the registry\n\t\t\t.

" + } + }, + "DigestType": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of the DS digest algorithm according to an IANA assignment.

\n

For more information, see IANA\n\t\t\tfor DNSSEC Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms.

" + } + }, + "Digest": { + "target": "com.amazonaws.route53domains#String", + "traits": { + "smithy.api#documentation": "

The delegation signer digest.

\n

Digest is calculated from the public key provided using specified digest algorithm and\n\t\t\tthis digest is the actual value returned from the registry nameservers as the value of\n\t\t\tDS records.

" + } + }, + "KeyTag": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "

A numeric identification of the DNSKEY record referred to by this DS record.

" + } + }, + "Id": { + "target": "com.amazonaws.route53domains#String", + "traits": { + "smithy.api#documentation": "

An ID assigned to each DS record created by AssociateDelegationSignerToDomain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the DNSSEC key.

\n

You get this from your DNS provider and then give it to Route 53 (by using\n\t\t\t\tAssociateDelegationSignerToDomain) to pass it to the registry to establish\n\t\t\tthe chain of trust.

" + } + }, + "com.amazonaws.route53domains#DnssecKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#DnssecKey" + } + }, + "com.amazonaws.route53domains#DnssecLimitExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53domains#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This error is returned if you call AssociateDelegationSignerToDomain\n\t\t\twhen the specified domain has reached the maximum number of DS records. You can't add\n\t\t\tany additional DS records unless you delete an existing one first.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53domains#DnssecPublicKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32768 + } + } + }, + "com.amazonaws.route53domains#DnssecSigningAttributes": { + "type": "structure", + "members": { + "Algorithm": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "

Algorithm which was used to generate the digest from the public key.

" + } + }, + "Flags": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "

Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK\n\t\t\t(zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS\n\t\t\tprovider isn't Route 53 and you don’t have KSK available.

\n

If you have KSK and ZSK keys, always use KSK to create a delegations signer (DS)\n\t\t\trecord. If you have ZSK keys only – use ZSK to create a DS record.

" + } + }, + "PublicKey": { + "target": "com.amazonaws.route53domains#DnssecPublicKey", + "traits": { + "smithy.api#documentation": "

The base64-encoded public key part of the key pair that is passed to the registry.\n\t\t

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a delegation signer (DS) record that was created in the registry by\n\t\t\t\tAssociateDelegationSignerToDomain.

" + } + }, "com.amazonaws.route53domains#DomainAuthCode": { "type": "string", "traits": { @@ -1702,42 +2455,56 @@ } }, "com.amazonaws.route53domains#DomainAvailability": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "AVAILABLE_RESERVED", - "name": "AVAILABLE_RESERVED" - }, - { - "value": "AVAILABLE_PREORDER", - "name": "AVAILABLE_PREORDER" - }, - { - "value": "UNAVAILABLE", - "name": "UNAVAILABLE" - }, - { - "value": "UNAVAILABLE_PREMIUM", - "name": "UNAVAILABLE_PREMIUM" - }, - { - "value": "UNAVAILABLE_RESTRICTED", - "name": "UNAVAILABLE_RESTRICTED" - }, - { - "value": "RESERVED", - "name": "RESERVED" - }, - { - "value": "DONT_KNOW", - "name": "DONT_KNOW" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "AVAILABLE_RESERVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE_RESERVED" + } + }, + "AVAILABLE_PREORDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE_PREORDER" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + }, + "UNAVAILABLE_PREMIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE_PREMIUM" + } + }, + "UNAVAILABLE_RESTRICTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE_RESTRICTED" } - ] + }, + "RESERVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVED" + } + }, + "DONT_KNOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DONT_KNOW" + } + } } }, "com.amazonaws.route53domains#DomainLimitExceeded": { @@ -1845,7 +2612,7 @@ "Availability": { "target": "com.amazonaws.route53domains#String", "traits": { - "smithy.api#documentation": "

Whether the domain name is available for registering.

\n\t\t \n

You can register only the domains that are designated as AVAILABLE.

\n \n\t\t

Valid values:

\n\t\t
\n
AVAILABLE
\n
\n

The domain name is available.

\n
\n
AVAILABLE_RESERVED
\n
\n

The domain name is reserved under specific conditions.

\n
\n
AVAILABLE_PREORDER
\n
\n

The domain name is available and can be preordered.

\n
\n
DONT_KNOW
\n
\n

The TLD registry didn't reply with a definitive answer about whether the domain name is available. \n\t\t\t\t\tRoute 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. \n\t\t\t\t\tTry again later.

\n
\n
PENDING
\n
\n

The TLD registry didn't return a response in the expected amount of time. When the response is delayed, \n\t\t\t\t\tit usually takes just a few extra seconds. You can resubmit the request immediately.

\n
\n
RESERVED
\n
\n

The domain name has been reserved for another person or organization.

\n
\n
UNAVAILABLE
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_PREMIUM
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_RESTRICTED
\n
\n

The domain name is forbidden.

\n
\n
" + "smithy.api#documentation": "

Whether the domain name is available for registering.

\n \n

You can register only the domains that are designated as\n\t\t\t\tAVAILABLE.

\n \n

Valid values:

\n
\n
AVAILABLE
\n
\n

The domain name is available.

\n
\n
AVAILABLE_RESERVED
\n
\n

The domain name is reserved under specific conditions.

\n
\n
AVAILABLE_PREORDER
\n
\n

The domain name is available and can be preordered.

\n
\n
DONT_KNOW
\n
\n

The TLD registry didn't reply with a definitive answer about whether the\n\t\t\t\t\t\tdomain name is available. Route 53 can return this response for a variety of\n\t\t\t\t\t\treasons, for example, the registry is performing maintenance. Try again\n\t\t\t\t\t\tlater.

\n
\n
PENDING
\n
\n

The TLD registry didn't return a response in the expected amount of time.\n\t\t\t\t\t\tWhen the response is delayed, it usually takes just a few extra seconds. You\n\t\t\t\t\t\tcan resubmit the request immediately.

\n
\n
RESERVED
\n
\n

The domain name has been reserved for another person or\n\t\t\t\t\t\torganization.

\n
\n
UNAVAILABLE
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_PREMIUM
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_RESTRICTED
\n
\n

The domain name is forbidden.

\n
\n
" } } }, @@ -1865,8 +2632,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that the summary information applies to.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the domain that the summary information applies to.

" } }, "AutoRenew": { @@ -1878,13 +2644,13 @@ "TransferLock": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether a domain is locked from unauthorized transfer to another party.

" + "smithy.api#documentation": "

Indicates whether a domain is locked from unauthorized transfer to another\n\t\t\tparty.

" } }, "Expiry": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).

" + "smithy.api#documentation": "

Expiration date of the domain in Unix time format and Coordinated Universal Time\n\t\t\t(UTC).

" } } }, @@ -1906,7 +2672,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about whether the specified domain can be transferred to Route 53.

" + "smithy.api#documentation": "

A complex type that contains information about whether the specified domain can be\n\t\t\ttransferred to Route 53.

" } }, "com.amazonaws.route53domains#DuplicateRequest": { @@ -1963,7 +2729,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. \n\t\t\tThe cost of renewing your domain registration is billed to your Amazon Web Services account.

\n\t\t

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \n\t\t\tDomains That You Can Register with Amazon Route 53 \n\t\t\tin the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period \n\t\t\tso we can complete processing before the deadline.

" + "smithy.api#documentation": "

This operation configures Amazon Route 53 to automatically renew the specified domain\n\t\t\tbefore the domain registration expires. The cost of renewing your domain registration is\n\t\t\tbilled to your Amazon Web Services account.

\n

The period during which you can renew a domain name varies by TLD. For a list of TLDs\n\t\t\tand their renewal policies, see Domains That You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide. Route 53 requires that you renew before the end of the renewal\n\t\t\tperiod so we can complete processing before the deadline.

" } }, "com.amazonaws.route53domains#EnableDomainAutoRenewRequest": { @@ -2008,7 +2774,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) \n\t\t\tto prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" + "smithy.api#documentation": "

This operation sets the transfer lock on the domain (specifically the\n\t\t\t\tclientTransferProhibited status) to prevent domain transfers.\n\t\t\tSuccessful submission returns an operation ID that you can use to track the progress and\n\t\t\tcompletion of the action. If the request is not completed successfully, the domain\n\t\t\tregistrant will be notified by email.

" } }, "com.amazonaws.route53domains#EnableDomainTransferLockRequest": { @@ -2032,8 +2798,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To use this ID to query the\n\t\t\toperation status, use GetOperationDetail.

" } } }, @@ -2050,7 +2815,7 @@ "Name": { "target": "com.amazonaws.route53domains#ExtraParamName", "traits": { - "smithy.api#documentation": "

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require \n\t\t\tadditional parameters and the names of the parameters that they require:

\n\n\t\t
\n
.com.au and .net.au
\n
\n\t\t\t\t\t
    \n
  • \n

    \n AU_ID_NUMBER\n

    \n
    • \n
  • \n

    \n AU_ID_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ABN (Australian business number)

      \n
      • \n
    • \n

      \n ACN (Australian company number)

      \n
      • \n
    • \n

      \n TM (Trademark number)

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
.ca
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BRAND_NUMBER\n

    \n
    • \n
  • \n

    \n CA_BUSINESS_ENTITY_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n BANK (Bank)

      \n
      • \n
    • \n

      \n COMMERCIAL_COMPANY (Commercial company)

      \n
      • \n
    • \n

      \n COMPANY (Company)

      \n
      • \n
    • \n

      \n COOPERATION (Cooperation)

      \n
      • \n
    • \n

      \n COOPERATIVE (Cooperative)

      \n
      • \n
    • \n

      \n COOPRIX (Cooprix)

      \n
      • \n
    • \n

      \n CORP (Corporation)

      \n
      • \n
    • \n

      \n CREDIT_UNION (Credit union)

      \n
      • \n
    • \n

      \n FOMIA (Federation of mutual insurance associations)

      \n
      • \n
    • \n

      \n INC (Incorporated)

      \n
      • \n
    • \n

      \n LTD (Limited)

      \n
      • \n
    • \n

      \n LTEE (Limitée)

      \n
      • \n
    • \n

      \n LLC (Limited liability corporation)

      \n
      • \n
    • \n

      \n LLP (Limited liability partnership)

      \n
      • \n
    • \n

      \n LTE (Lte.)

      \n
      • \n
    • \n

      \n MBA (Mutual benefit association)

      \n
      • \n
    • \n

      \n MIC (Mutual insurance company)

      \n
      • \n
    • \n

      \n NFP (Not-for-profit corporation)

      \n
      • \n
    • \n

      \n SA (S.A.)

      \n
      • \n
    • \n

      \n SAVINGS_COMPANY (Savings company)

      \n
      • \n
    • \n

      \n SAVINGS_UNION (Savings union)

      \n
      • \n
    • \n

      \n SARL (Société à responsabilité limitée)

      \n
      • \n
    • \n

      \n TRUST (Trust)

      \n
      • \n
    • \n

      \n ULC (Unlimited liability corporation)

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n

    \n CA_LEGAL_TYPE\n

    \n\t\t\t\t\t\t\t

    When ContactType is PERSON, valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ABO (Aboriginal Peoples indigenous to Canada)

      \n
      • \n
    • \n

      \n CCT (Canadian citizen)

      \n
      • \n
    • \n

      \n LGR (Legal Representative of a Canadian Citizen or Permanent Resident)

      \n
      • \n
    • \n

      \n RES (Permanent resident of Canada)

      \n
      • \n
    \n\n\t\t\t\t\t\t\t

    When ContactType is a value other than PERSON, valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ASS (Canadian unincorporated association)

      \n
      • \n
    • \n

      \n CCO (Canadian corporation)

      \n
      • \n
    • \n

      \n EDU (Canadian educational institution)

      \n
      • \n
    • \n

      \n GOV (Government or government entity in Canada)

      \n
      • \n
    • \n

      \n HOP (Canadian Hospital)

      \n
      • \n
    • \n

      \n INB (Indian Band recognized by the Indian Act of Canada)

      \n
      • \n
    • \n

      \n LAM (Canadian Library, Archive, or Museum)

      \n
      • \n
    • \n

      \n MAJ (Her/His Majesty the Queen/King)

      \n
      • \n
    • \n

      \n OMK (Official mark registered in Canada)

      \n
      • \n
    • \n

      \n PLT (Canadian Political Party)

      \n
      • \n
    • \n

      \n PRT (Partnership Registered in Canada)

      \n
      • \n
    • \n

      \n TDM (Trademark registered in Canada)

      \n
      • \n
    • \n

      \n TRD (Canadian Trade Union)

      \n
      • \n
    • \n

      \n TRS (Trust established in Canada)

      \n
      • \n
    \n\n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
.es
\n
\n\t\t\t\t\t
    \n
  • \n

    \n ES_IDENTIFICATION\n

    \n\t\t\t\t\t\t\t

    The value of ES_IDENTIFICATION depends on the following values:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      The value of ES_LEGAL_FORM\n

      \n
      • \n
    • \n

      The value of ES_IDENTIFICATION_TYPE\n

      \n
      • \n
    \n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t

    \n If ES_LEGAL_FORM is any value other than INDIVIDUAL:\n

    \n\t\t\t\t\t\t\t
      \n
    • \n

      Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])

      \n
      • \n
    • \n

      Example: B12345678

      \n
      • \n
    \n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t

    \n If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for \n\t\t\t\t\t\t\t\tES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:\n

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

      \n\t\t\t\t\t\t\t\t\t
        \n
      • \n

        Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])

        \n
        • \n
      • \n

        Example: 12345678M

        \n
        • \n
      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

      \n\t\t\t\t\t\t\t\t\t
        \n
      • \n

        Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])

        \n
        • \n
      • \n

        Example: Y1234567X

        \n
        • \n
      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

      \n\t\t\t\t\t\t\t\t\t
        \n
      • \n

        Specify a passport number, drivers license number, or national identity card number

        \n
        • \n
      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n

    \n ES_IDENTIFICATION_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n DNI_AND_NIF (For Spanish contacts)

      \n
      • \n
    • \n

      \n NIE (For foreigners with legal residence)

      \n
      • \n
    • \n

      \n OTHER (For contacts outside of Spain)

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n

    \n ES_LEGAL_FORM\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ASSOCIATION\n

      \n
      • \n
    • \n

      \n CENTRAL_GOVERNMENT_BODY\n

      \n
      • \n
    • \n

      \n CIVIL_SOCIETY\n

      \n
      • \n
    • \n

      \n COMMUNITY_OF_OWNERS\n

      \n
      • \n
    • \n

      \n COMMUNITY_PROPERTY\n

      \n
      • \n
    • \n

      \n CONSULATE\n

      \n
      • \n
    • \n

      \n COOPERATIVE\n

      \n
      • \n
    • \n

      \n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n

      \n
      • \n
    • \n

      \n ECONOMIC_INTEREST_GROUP\n

      \n
      • \n
    • \n

      \n EMBASSY\n

      \n
      • \n
    • \n

      \n ENTITY_MANAGING_NATURAL_AREAS\n

      \n
      • \n
    • \n

      \n FARM_PARTNERSHIP\n

      \n
      • \n
    • \n

      \n FOUNDATION\n

      \n
      • \n
    • \n

      \n GENERAL_AND_LIMITED_PARTNERSHIP\n

      \n
      • \n
    • \n

      \n GENERAL_PARTNERSHIP\n

      \n
      • \n
    • \n

      \n INDIVIDUAL\n

      \n
      • \n
    • \n

      \n LIMITED_COMPANY\n

      \n
      • \n
    • \n

      \n LOCAL_AUTHORITY\n

      \n
      • \n
    • \n

      \n LOCAL_PUBLIC_ENTITY\n

      \n
      • \n
    • \n

      \n MUTUAL_INSURANCE_COMPANY\n

      \n
      • \n
    • \n

      \n NATIONAL_PUBLIC_ENTITY\n

      \n
      • \n
    • \n

      \n ORDER_OR_RELIGIOUS_INSTITUTION\n

      \n
      • \n
    • \n

      \n OTHERS (Only for contacts outside of Spain)\n

      \n
      • \n
    • \n

      \n POLITICAL_PARTY\n

      \n
      • \n
    • \n

      \n PROFESSIONAL_ASSOCIATION\n

      \n
      • \n
    • \n

      \n PUBLIC_LAW_ASSOCIATION\n

      \n
      • \n
    • \n

      \n PUBLIC_LIMITED_COMPANY\n

      \n
      • \n
    • \n

      \n REGIONAL_GOVERNMENT_BODY\n

      \n
      • \n
    • \n

      \n REGIONAL_PUBLIC_ENTITY\n

      \n
      • \n
    • \n

      \n SAVINGS_BANK\n

      \n
      • \n
    • \n

      \n SPANISH_OFFICE\n

      \n
      • \n
    • \n

      \n SPORTS_ASSOCIATION\n

      \n
      • \n
    • \n

      \n SPORTS_FEDERATION\n

      \n
      • \n
    • \n

      \n SPORTS_LIMITED_COMPANY\n

      \n
      • \n
    • \n

      \n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n

      \n
      • \n
    • \n

      \n TRADE_UNION\n

      \n
      • \n
    • \n

      \n WORKER_OWNED_COMPANY\n

      \n
      • \n
    • \n

      \n WORKER_OWNED_LIMITED_COMPANY\n

      \n
      • \n
    \n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
.eu
\n
\n\t\t
    \n
  • \n

    \n EU_COUNTRY_OF_CITIZENSHIP\n

    \n
    • \n
\n\t\t
\n
.fi
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
    • \n
  • \n

    \n FI_BUSINESS_NUMBER\n

    \n
    • \n
  • \n

    \n FI_ID_NUMBER\n

    \n
    • \n
  • \n

    \n FI_NATIONALITY\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n FINNISH\n

      \n
      • \n
    • \n

      \n NOT_FINNISH\n

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n

    \n FI_ORGANIZATION_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n COMPANY\n

      \n
      • \n
    • \n

      \n CORPORATION\n

      \n
      • \n
    • \n

      \n GOVERNMENT\n

      \n
      • \n
    • \n

      \n INSTITUTION\n

      \n
      • \n
    • \n

      \n POLITICAL_PARTY\n

      \n
      • \n
    • \n

      \n PUBLIC_COMMUNITY\n

      \n
      • \n
    • \n

      \n TOWNSHIP\n

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
.fr
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_CITY\n

    \n
    • \n
  • \n

    \n BIRTH_COUNTRY\n

    \n
    • \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
    • \n
  • \n

    \n BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. \n\t\t\t\t\t\t\tIf the contact was born somewhere other than France or its overseas departments, specify 99. For more information, \n\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers, see the Wikipedia entry \n\t\t\t\t\t\t\tDepartments of France.

    \n
    • \n
  • \n

    \n BRAND_NUMBER\n

    \n
    • \n
\n\t\t\t\t
\n
.it
\n
\n\t\t\t\t\t
    \n
  • \n

    \n IT_NATIONALITY\n

    \n
    • \n
  • \n

    \n IT_PIN\n

    \n
    • \n
  • \n

    \n IT_REGISTRANT_ENTITY_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n FOREIGNERS\n

      \n
      • \n
    • \n

      \n FREELANCE_WORKERS (Freelance workers and professionals)

      \n
      • \n
    • \n

      \n ITALIAN_COMPANIES (Italian companies and one-person companies)

      \n
      • \n
    • \n

      \n NON_PROFIT_ORGANIZATIONS\n

      \n
      • \n
    • \n

      \n OTHER_SUBJECTS\n

      \n
      • \n
    • \n

      \n PUBLIC_ORGANIZATIONS\n

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
.ru
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
    • \n
  • \n

    \n RU_PASSPORT_DATA\n

    \n
    • \n
\n\t\t\t\t
\n
.se
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_COUNTRY\n

    \n
    • \n
  • \n

    \n SE_ID_NUMBER\n

    \n
    • \n
\n\t\t\t\t
\n
.sg
\n
\n\t\t\t\t\t
    \n
  • \n

    \n SG_ID_NUMBER\n

    \n
    • \n
\n\t\t\t\t
\n
.co.uk, .me.uk, and .org.uk
\n
\n\t\t\t\t\t
    \n
  • \n

    \n UK_CONTACT_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n CRC (UK Corporation by Royal Charter)

      \n
      • \n
    • \n

      \n FCORP (Non-UK Corporation)

      \n
      • \n
    • \n

      \n FIND (Non-UK Individual, representing self)

      \n
      • \n
    • \n

      \n FOTHER (Non-UK Entity that does not fit into any other category)

      \n
      • \n
    • \n

      \n GOV (UK Government Body)

      \n
      • \n
    • \n

      \n IND (UK Individual (representing self))

      \n
      • \n
    • \n

      \n IP (UK Industrial/Provident Registered Company)

      \n
      • \n
    • \n

      \n LLP (UK Limited Liability Partnership)

      \n
      • \n
    • \n

      \n LTD (UK Limited Company)

      \n
      • \n
    • \n

      \n OTHER (UK Entity that does not fit into any other category)

      \n
      • \n
    • \n

      \n PLC (UK Public Limited Company)

      \n
      • \n
    • \n

      \n PTNR (UK Partnership)

      \n
      • \n
    • \n

      \n RCHAR (UK Registered Charity)

      \n
      • \n
    • \n

      \n SCH (UK School)

      \n
      • \n
    • \n

      \n STAT (UK Statutory Body)

      \n
      • \n
    • \n

      \n STRA (UK Sole Trader)

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n

    \n UK_COMPANY_NUMBER\n

    \n
    • \n
\n\t\t\t\t
\n
\n\n\t\t

In addition, many TLDs require a VAT_NUMBER.

", + "smithy.api#documentation": "

The name of an additional parameter that is required by a top-level domain. Here are\n\t\t\tthe top-level domains that require additional parameters and the names of the parameters\n\t\t\tthat they require:

\n
\n
.com.au and .net.au
\n
\n
    \n
  • \n

    \n AU_ID_NUMBER\n

    \n
    • \n
  • \n

    \n AU_ID_TYPE\n

    \n

    Valid values include the following:

    \n
      \n
    • \n

      \n ABN (Australian business number)

      \n
      • \n
    • \n

      \n ACN (Australian company number)

      \n
      • \n
    • \n

      \n TM (Trademark number)

      \n
      • \n
    \n
    • \n
\n
\n
.ca
\n
\n
    \n
  • \n

    \n BRAND_NUMBER\n

    \n
    • \n
  • \n

    \n CA_BUSINESS_ENTITY_TYPE\n

    \n

    Valid values include the following:

    \n
      \n
    • \n

      \n BANK (Bank)

      \n
      • \n
    • \n

      \n COMMERCIAL_COMPANY (Commercial\n\t\t\t\t\t\t\t\t\t\tcompany)

      \n
      • \n
    • \n

      \n COMPANY (Company)

      \n
      • \n
    • \n

      \n COOPERATION (Cooperation)

      \n
      • \n
    • \n

      \n COOPERATIVE (Cooperative)

      \n
      • \n
    • \n

      \n COOPRIX (Cooprix)

      \n
      • \n
    • \n

      \n CORP (Corporation)

      \n
      • \n
    • \n

      \n CREDIT_UNION (Credit union)

      \n
      • \n
    • \n

      \n FOMIA (Federation of mutual insurance\n\t\t\t\t\t\t\t\t\t\tassociations)

      \n
      • \n
    • \n

      \n INC (Incorporated)

      \n
      • \n
    • \n

      \n LTD (Limited)

      \n
      • \n
    • \n

      \n LTEE (Limitée)

      \n
      • \n
    • \n

      \n LLC (Limited liability corporation)

      \n
      • \n
    • \n

      \n LLP (Limited liability partnership)

      \n
      • \n
    • \n

      \n LTE (Lte.)

      \n
      • \n
    • \n

      \n MBA (Mutual benefit association)

      \n
      • \n
    • \n

      \n MIC (Mutual insurance company)

      \n
      • \n
    • \n

      \n NFP (Not-for-profit corporation)

      \n
      • \n
    • \n

      \n SA (S.A.)

      \n
      • \n
    • \n

      \n SAVINGS_COMPANY (Savings company)

      \n
      • \n
    • \n

      \n SAVINGS_UNION (Savings union)

      \n
      • \n
    • \n

      \n SARL (Société à responsabilité\n\t\t\t\t\t\t\t\t\t\tlimitée)

      \n
      • \n
    • \n

      \n TRUST (Trust)

      \n
      • \n
    • \n

      \n ULC (Unlimited liability corporation)

      \n
      • \n
    \n
    • \n
  • \n

    \n CA_LEGAL_TYPE\n

    \n

    When ContactType is PERSON, valid values\n\t\t\t\t\t\t\t\tinclude the following:

    \n
      \n
    • \n

      \n ABO (Aboriginal Peoples indigenous to\n\t\t\t\t\t\t\t\t\t\tCanada)

      \n
      • \n
    • \n

      \n CCT (Canadian citizen)

      \n
      • \n
    • \n

      \n LGR (Legal Representative of a Canadian\n\t\t\t\t\t\t\t\t\t\tCitizen or Permanent Resident)

      \n
      • \n
    • \n

      \n RES (Permanent resident of Canada)

      \n
      • \n
    \n

    When ContactType is a value other than\n\t\t\t\t\t\t\t\t\tPERSON, valid values include the following:

    \n
      \n
    • \n

      \n ASS (Canadian unincorporated\n\t\t\t\t\t\t\t\t\t\tassociation)

      \n
      • \n
    • \n

      \n CCO (Canadian corporation)

      \n
      • \n
    • \n

      \n EDU (Canadian educational institution)

      \n
      • \n
    • \n

      \n GOV (Government or government entity in\n\t\t\t\t\t\t\t\t\t\tCanada)

      \n
      • \n
    • \n

      \n HOP (Canadian Hospital)

      \n
      • \n
    • \n

      \n INB (Indian Band recognized by the Indian Act\n\t\t\t\t\t\t\t\t\t\tof Canada)

      \n
      • \n
    • \n

      \n LAM (Canadian Library, Archive, or\n\t\t\t\t\t\t\t\t\t\tMuseum)

      \n
      • \n
    • \n

      \n MAJ (Her/His Majesty the Queen/King)

      \n
      • \n
    • \n

      \n OMK (Official mark registered in\n\t\t\t\t\t\t\t\t\t\tCanada)

      \n
      • \n
    • \n

      \n PLT (Canadian Political Party)

      \n
      • \n
    • \n

      \n PRT (Partnership Registered in Canada)

      \n
      • \n
    • \n

      \n TDM (Trademark registered in Canada)

      \n
      • \n
    • \n

      \n TRD (Canadian Trade Union)

      \n
      • \n
    • \n

      \n TRS (Trust established in Canada)

      \n
      • \n
    \n
    • \n
\n
\n
.es
\n
\n
    \n
  • \n

    \n ES_IDENTIFICATION\n

    \n

    The value of ES_IDENTIFICATION depends on the\n\t\t\t\t\t\t\t\tfollowing values:

    \n
      \n
    • \n

      The value of ES_LEGAL_FORM\n

      \n
      • \n
    • \n

      The value of ES_IDENTIFICATION_TYPE\n

      \n
      • \n
    \n

    \n If ES_LEGAL_FORM is any value\n\t\t\t\t\t\t\t\t\tother than INDIVIDUAL:\n

    \n
      \n
    • \n

      Specify 1 letter + 8 numbers (CIF [Certificado de\n\t\t\t\t\t\t\t\t\t\tIdentificación Fiscal])

      \n
      • \n
    • \n

      Example: B12345678

      \n
      • \n
    \n

    \n If ES_LEGAL_FORM is\n\t\t\t\t\t\t\t\t\t\tINDIVIDUAL, the value that you specify for\n\t\t\t\t\t\t\t\t\t\tES_IDENTIFICATION depends on the value of\n\t\t\t\t\t\t\t\t\t\tES_IDENTIFICATION_TYPE:\n

    \n
      \n
    • \n

      If ES_IDENTIFICATION_TYPE is\n\t\t\t\t\t\t\t\t\t\t\tDNI_AND_NIF (for Spanish contacts):

      \n
        \n
      • \n

        Specify 8 numbers + 1 letter (DNI [Documento\n\t\t\t\t\t\t\t\t\t\t\t\tNacional de Identidad], NIF [Número de\n\t\t\t\t\t\t\t\t\t\t\t\tIdentificación Fiscal])

        \n
        • \n
      • \n

        Example: 12345678M

        \n
        • \n
      \n
      • \n
    • \n

      If ES_IDENTIFICATION_TYPE is NIE\n\t\t\t\t\t\t\t\t\t\t(for foreigners with legal residence):

      \n
        \n
      • \n

        Specify 1 letter + 7 numbers + 1 letter ( NIE\n\t\t\t\t\t\t\t\t\t\t\t\t[Número de Identidad de Extranjero])

        \n
        • \n
      • \n

        Example: Y1234567X

        \n
        • \n
      \n
      • \n
    • \n

      If ES_IDENTIFICATION_TYPE is\n\t\t\t\t\t\t\t\t\t\t\tOTHER (for contacts outside of\n\t\t\t\t\t\t\t\t\t\tSpain):

      \n
        \n
      • \n

        Specify a passport number, drivers license number,\n\t\t\t\t\t\t\t\t\t\t\t\tor national identity card number

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n ES_IDENTIFICATION_TYPE\n

    \n

    Valid values include the following:

    \n
      \n
    • \n

      \n DNI_AND_NIF (For Spanish contacts)

      \n
      • \n
    • \n

      \n NIE (For foreigners with legal\n\t\t\t\t\t\t\t\t\t\tresidence)

      \n
      • \n
    • \n

      \n OTHER (For contacts outside of Spain)

      \n
      • \n
    \n
    • \n
  • \n

    \n ES_LEGAL_FORM\n

    \n

    Valid values include the following:

    \n
      \n
    • \n

      \n ASSOCIATION\n

      \n
      • \n
    • \n

      \n CENTRAL_GOVERNMENT_BODY\n

      \n
      • \n
    • \n

      \n CIVIL_SOCIETY\n

      \n
      • \n
    • \n

      \n COMMUNITY_OF_OWNERS\n

      \n
      • \n
    • \n

      \n COMMUNITY_PROPERTY\n

      \n
      • \n
    • \n

      \n CONSULATE\n

      \n
      • \n
    • \n

      \n COOPERATIVE\n

      \n
      • \n
    • \n

      \n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n

      \n
      • \n
    • \n

      \n ECONOMIC_INTEREST_GROUP\n

      \n
      • \n
    • \n

      \n EMBASSY\n

      \n
      • \n
    • \n

      \n ENTITY_MANAGING_NATURAL_AREAS\n

      \n
      • \n
    • \n

      \n FARM_PARTNERSHIP\n

      \n
      • \n
    • \n

      \n FOUNDATION\n

      \n
      • \n
    • \n

      \n GENERAL_AND_LIMITED_PARTNERSHIP\n

      \n
      • \n
    • \n

      \n GENERAL_PARTNERSHIP\n

      \n
      • \n
    • \n

      \n INDIVIDUAL\n

      \n
      • \n
    • \n

      \n LIMITED_COMPANY\n

      \n
      • \n
    • \n

      \n LOCAL_AUTHORITY\n

      \n
      • \n
    • \n

      \n LOCAL_PUBLIC_ENTITY\n

      \n
      • \n
    • \n

      \n MUTUAL_INSURANCE_COMPANY\n

      \n
      • \n
    • \n

      \n NATIONAL_PUBLIC_ENTITY\n

      \n
      • \n
    • \n

      \n ORDER_OR_RELIGIOUS_INSTITUTION\n

      \n
      • \n
    • \n

      \n OTHERS (Only for contacts outside of\n\t\t\t\t\t\t\t\t\t\tSpain)\n

      \n
      • \n
    • \n

      \n POLITICAL_PARTY\n

      \n
      • \n
    • \n

      \n PROFESSIONAL_ASSOCIATION\n

      \n
      • \n
    • \n

      \n PUBLIC_LAW_ASSOCIATION\n

      \n
      • \n
    • \n

      \n PUBLIC_LIMITED_COMPANY\n

      \n
      • \n
    • \n

      \n REGIONAL_GOVERNMENT_BODY\n

      \n
      • \n
    • \n

      \n REGIONAL_PUBLIC_ENTITY\n

      \n
      • \n
    • \n

      \n SAVINGS_BANK\n

      \n
      • \n
    • \n

      \n SPANISH_OFFICE\n

      \n
      • \n
    • \n

      \n SPORTS_ASSOCIATION\n

      \n
      • \n
    • \n

      \n SPORTS_FEDERATION\n

      \n
      • \n
    • \n

      \n SPORTS_LIMITED_COMPANY\n

      \n
      • \n
    • \n

      \n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n

      \n
      • \n
    • \n

      \n TRADE_UNION\n

      \n
      • \n
    • \n

      \n WORKER_OWNED_COMPANY\n

      \n
      • \n
    • \n

      \n WORKER_OWNED_LIMITED_COMPANY\n

      \n
      • \n
    \n
    • \n
\n
\n
.eu
\n
\n
    \n
  • \n

    \n EU_COUNTRY_OF_CITIZENSHIP\n

    \n
    • \n
\n
\n
.fi
\n
\n
    \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
    • \n
  • \n

    \n FI_BUSINESS_NUMBER\n

    \n
    • \n
  • \n

    \n FI_ID_NUMBER\n

    \n
    • \n
  • \n

    \n FI_NATIONALITY\n

    \n

    Valid values include the following:

    \n
      \n
    • \n

      \n FINNISH\n

      \n
      • \n
    • \n

      \n NOT_FINNISH\n

      \n
      • \n
    \n
    • \n
  • \n

    \n FI_ORGANIZATION_TYPE\n

    \n

    Valid values include the following:

    \n
      \n
    • \n

      \n COMPANY\n

      \n
      • \n
    • \n

      \n CORPORATION\n

      \n
      • \n
    • \n

      \n GOVERNMENT\n

      \n
      • \n
    • \n

      \n INSTITUTION\n

      \n
      • \n
    • \n

      \n POLITICAL_PARTY\n

      \n
      • \n
    • \n

      \n PUBLIC_COMMUNITY\n

      \n
      • \n
    • \n

      \n TOWNSHIP\n

      \n
      • \n
    \n
    • \n
\n
\n
.fr
\n
\n
    \n
  • \n

    \n BIRTH_CITY\n

    \n
    • \n
  • \n

    \n BIRTH_COUNTRY\n

    \n
    • \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
    • \n
  • \n

    \n BIRTH_DEPARTMENT: Specify the INSEE code that\n\t\t\t\t\t\t\t\tcorresponds with the department where the contact was born. If the\n\t\t\t\t\t\t\t\tcontact was born somewhere other than France or its overseas\n\t\t\t\t\t\t\t\tdepartments, specify 99. For more information,\n\t\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers,\n\t\t\t\t\t\t\t\tsee the Wikipedia entry Departments of France.

    \n
    • \n
  • \n

    \n BRAND_NUMBER\n

    \n
    • \n
\n
\n
.it
\n
\n
    \n
  • \n

    \n IT_NATIONALITY\n

    \n
    • \n
  • \n

    \n IT_PIN\n

    \n
    • \n
  • \n

    \n IT_REGISTRANT_ENTITY_TYPE\n

    \n

    Valid values include the following:

    \n
      \n
    • \n

      \n FOREIGNERS\n

      \n
      • \n
    • \n

      \n FREELANCE_WORKERS (Freelance workers and\n\t\t\t\t\t\t\t\t\t\tprofessionals)

      \n
      • \n
    • \n

      \n ITALIAN_COMPANIES (Italian companies and\n\t\t\t\t\t\t\t\t\t\tone-person companies)

      \n
      • \n
    • \n

      \n NON_PROFIT_ORGANIZATIONS\n

      \n
      • \n
    • \n

      \n OTHER_SUBJECTS\n

      \n
      • \n
    • \n

      \n PUBLIC_ORGANIZATIONS\n

      \n
      • \n
    \n
    • \n
\n
\n
.ru
\n
\n
    \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
    • \n
  • \n

    \n RU_PASSPORT_DATA\n

    \n
    • \n
\n
\n
.se
\n
\n
    \n
  • \n

    \n BIRTH_COUNTRY\n

    \n
    • \n
  • \n

    \n SE_ID_NUMBER\n

    \n
    • \n
\n
\n
.sg
\n
\n
    \n
  • \n

    \n SG_ID_NUMBER\n

    \n
    • \n
\n
\n
.uk, .co.uk, .me.uk, and .org.uk
\n
\n
    \n
  • \n

    \n UK_CONTACT_TYPE\n

    \n

    Valid values include the following:

    \n
      \n
    • \n

      \n CRC (UK Corporation by Royal Charter)

      \n
      • \n
    • \n

      \n FCORP (Non-UK Corporation)

      \n
      • \n
    • \n

      \n FIND (Non-UK Individual, representing\n\t\t\t\t\t\t\t\t\t\tself)

      \n
      • \n
    • \n

      \n FOTHER (Non-UK Entity that does not fit into\n\t\t\t\t\t\t\t\t\t\tany other category)

      \n
      • \n
    • \n

      \n GOV (UK Government Body)

      \n
      • \n
    • \n

      \n IND (UK Individual (representing\n\t\t\t\t\t\t\t\t\t\tself))

      \n
      • \n
    • \n

      \n IP (UK Industrial/Provident Registered\n\t\t\t\t\t\t\t\t\t\tCompany)

      \n
      • \n
    • \n

      \n LLP (UK Limited Liability Partnership)

      \n
      • \n
    • \n

      \n LTD (UK Limited Company)

      \n
      • \n
    • \n

      \n OTHER (UK Entity that does not fit into any\n\t\t\t\t\t\t\t\t\t\tother category)

      \n
      • \n
    • \n

      \n PLC (UK Public Limited Company)

      \n
      • \n
    • \n

      \n PTNR (UK Partnership)

      \n
      • \n
    • \n

      \n RCHAR (UK Registered Charity)

      \n
      • \n
    • \n

      \n SCH (UK School)

      \n
      • \n
    • \n

      \n STAT (UK Statutory Body)

      \n
      • \n
    • \n

      \n STRA (UK Sole Trader)

      \n
      • \n
    \n
    • \n
  • \n

    \n UK_COMPANY_NUMBER\n

    \n
    • \n
\n
\n
\n

In addition, many TLDs require a VAT_NUMBER.

", "smithy.api#required": {} } }, @@ -2073,130 +2838,194 @@ } }, "com.amazonaws.route53domains#ExtraParamName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DUNS_NUMBER", - "name": "DUNS_NUMBER" - }, - { - "value": "BRAND_NUMBER", - "name": "BRAND_NUMBER" - }, - { - "value": "BIRTH_DEPARTMENT", - "name": "BIRTH_DEPARTMENT" - }, - { - "value": "BIRTH_DATE_IN_YYYY_MM_DD", - "name": "BIRTH_DATE_IN_YYYY_MM_DD" - }, - { - "value": "BIRTH_COUNTRY", - "name": "BIRTH_COUNTRY" - }, - { - "value": "BIRTH_CITY", - "name": "BIRTH_CITY" - }, - { - "value": "DOCUMENT_NUMBER", - "name": "DOCUMENT_NUMBER" - }, - { - "value": "AU_ID_NUMBER", - "name": "AU_ID_NUMBER" - }, - { - "value": "AU_ID_TYPE", - "name": "AU_ID_TYPE" - }, - { - "value": "CA_LEGAL_TYPE", - "name": "CA_LEGAL_TYPE" - }, - { - "value": "CA_BUSINESS_ENTITY_TYPE", - "name": "CA_BUSINESS_ENTITY_TYPE" - }, - { - "value": "CA_LEGAL_REPRESENTATIVE", - "name": "CA_LEGAL_REPRESENTATIVE" - }, - { - "value": "CA_LEGAL_REPRESENTATIVE_CAPACITY", - "name": "CA_LEGAL_REPRESENTATIVE_CAPACITY" - }, - { - "value": "ES_IDENTIFICATION", - "name": "ES_IDENTIFICATION" - }, - { - "value": "ES_IDENTIFICATION_TYPE", - "name": "ES_IDENTIFICATION_TYPE" - }, - { - "value": "ES_LEGAL_FORM", - "name": "ES_LEGAL_FORM" - }, - { - "value": "FI_BUSINESS_NUMBER", - "name": "FI_BUSINESS_NUMBER" - }, - { - "value": "FI_ID_NUMBER", - "name": "ONWER_FI_ID_NUMBER" - }, - { - "value": "FI_NATIONALITY", - "name": "FI_NATIONALITY" - }, - { - "value": "FI_ORGANIZATION_TYPE", - "name": "FI_ORGANIZATION_TYPE" - }, - { - "value": "IT_NATIONALITY", - "name": "IT_NATIONALITY" - }, - { - "value": "IT_PIN", - "name": "IT_PIN" - }, - { - "value": "IT_REGISTRANT_ENTITY_TYPE", - "name": "IT_REGISTRANT_ENTITY_TYPE" - }, - { - "value": "RU_PASSPORT_DATA", - "name": "RU_PASSPORT_DATA" - }, - { - "value": "SE_ID_NUMBER", - "name": "SE_ID_NUMBER" - }, - { - "value": "SG_ID_NUMBER", - "name": "SG_ID_NUMBER" - }, - { - "value": "VAT_NUMBER", - "name": "VAT_NUMBER" - }, - { - "value": "UK_CONTACT_TYPE", - "name": "UK_CONTACT_TYPE" - }, - { - "value": "UK_COMPANY_NUMBER", - "name": "UK_COMPANY_NUMBER" - }, - { - "value": "EU_COUNTRY_OF_CITIZENSHIP", - "name": "EU_COUNTRY_OF_CITIZENSHIP" + "type": "enum", + "members": { + "DUNS_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUNS_NUMBER" + } + }, + "BRAND_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BRAND_NUMBER" + } + }, + "BIRTH_DEPARTMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTH_DEPARTMENT" + } + }, + "BIRTH_DATE_IN_YYYY_MM_DD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTH_DATE_IN_YYYY_MM_DD" + } + }, + "BIRTH_COUNTRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTH_COUNTRY" + } + }, + "BIRTH_CITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTH_CITY" + } + }, + "DOCUMENT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_NUMBER" + } + }, + "AU_ID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_ID_NUMBER" + } + }, + "AU_ID_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_ID_TYPE" + } + }, + "CA_LEGAL_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_LEGAL_TYPE" + } + }, + "CA_BUSINESS_ENTITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_BUSINESS_ENTITY_TYPE" + } + }, + "CA_LEGAL_REPRESENTATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_LEGAL_REPRESENTATIVE" + } + }, + "CA_LEGAL_REPRESENTATIVE_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_LEGAL_REPRESENTATIVE_CAPACITY" + } + }, + "ES_IDENTIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES_IDENTIFICATION" + } + }, + "ES_IDENTIFICATION_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES_IDENTIFICATION_TYPE" + } + }, + "ES_LEGAL_FORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES_LEGAL_FORM" + } + }, + "FI_BUSINESS_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI_BUSINESS_NUMBER" + } + }, + "ONWER_FI_ID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI_ID_NUMBER" + } + }, + "FI_NATIONALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI_NATIONALITY" + } + }, + "FI_ORGANIZATION_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI_ORGANIZATION_TYPE" + } + }, + "IT_NATIONALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT_NATIONALITY" + } + }, + "IT_PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT_PIN" + } + }, + "IT_REGISTRANT_ENTITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT_REGISTRANT_ENTITY_TYPE" + } + }, + "RU_PASSPORT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RU_PASSPORT_DATA" + } + }, + "SE_ID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SE_ID_NUMBER" + } + }, + "SG_ID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SG_ID_NUMBER" + } + }, + "VAT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAT_NUMBER" + } + }, + "UK_CONTACT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_CONTACT_TYPE" + } + }, + "UK_COMPANY_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_COMPANY_NUMBER" + } + }, + "EU_COUNTRY_OF_CITIZENSHIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EU_COUNTRY_OF_CITIZENSHIP" + } + }, + "AU_PRIORITY_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_PRIORITY_TOKEN" } - ] + } } }, "com.amazonaws.route53domains#ExtraParamValue": { @@ -2232,20 +3061,20 @@ "Operator": { "target": "com.amazonaws.route53domains#Operator", "traits": { - "smithy.api#documentation": "

The operator values for filtering domain names. The values can be:

\n\t\t
    \n
  • \n

    \n LE: Less than, or equal to

    \n
    • \n
  • \n

    \n GE: Greater than, or equal to

    \n
    • \n
  • \n

    \n BEGINS_WITH: Begins with

    \n
    • \n
", + "smithy.api#documentation": "

The operator values for filtering domain names. The values can be:

\n
    \n
  • \n

    \n LE: Less than, or equal to

    \n
    • \n
  • \n

    \n GE: Greater than, or equal to

    \n
    • \n
  • \n

    \n BEGINS_WITH: Begins with

    \n
    • \n
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.route53domains#Values", "traits": { - "smithy.api#documentation": "

An array of strings presenting values to compare. Only 1 item in the list is currently supported.

", + "smithy.api#documentation": "

An array of strings presenting values to compare. Only 1 item in the list is\n\t\t\tcurrently supported.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Information for the filtering of a list of domains returned by \n\t\t\tListDomains.

" + "smithy.api#documentation": "

Information for the filtering of a list of domains returned by ListDomains.

" } }, "com.amazonaws.route53domains#FilterConditions": { @@ -2274,7 +3103,7 @@ } ], "traits": { - "smithy.api#documentation": "

For operations that require confirmation that the email address for the registrant contact is valid, \n\t\t\tsuch as registering a new domain, this operation returns information about whether the registrant contact has responded.

\n\t\t

If you want us to resend the email, use the ResendContactReachabilityEmail operation.

" + "smithy.api#documentation": "

For operations that require confirmation that the email address for the registrant\n\t\t\tcontact is valid, such as registering a new domain, this operation returns information\n\t\t\tabout whether the registrant contact has responded.

\n

If you want us to resend the email, use the\n\t\t\t\tResendContactReachabilityEmail operation.

" } }, "com.amazonaws.route53domains#GetContactReachabilityStatusRequest": { @@ -2283,7 +3112,7 @@ "domainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.

" + "smithy.api#documentation": "

The name of the domain for which you want to know whether the registrant contact has\n\t\t\tconfirmed that the email address is valid.

" } } } @@ -2300,7 +3129,7 @@ "status": { "target": "com.amazonaws.route53domains#ReachabilityStatus", "traits": { - "smithy.api#documentation": "

Whether the registrant contact has responded. Values include the following:

\n\t\t
\n
PENDING
\n
\n

We sent the confirmation email and haven't received a response yet.

\n
\n
DONE
\n
\n

We sent the email and got confirmation from the registrant contact.

\n
\n
EXPIRED
\n
\n

The time limit expired before the registrant contact responded.

\n
\n
" + "smithy.api#documentation": "

Whether the registrant contact has responded. Values include the following:

\n
\n
PENDING
\n
\n

We sent the confirmation email and haven't received a response yet.

\n
\n
DONE
\n
\n

We sent the email and got confirmation from the registrant contact.

\n
\n
EXPIRED
\n
\n

The time limit expired before the registrant contact responded.

\n
\n
" } } } @@ -2322,7 +3151,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. \n\t\t\tContact information for the domain is also returned as part of the output.

" + "smithy.api#documentation": "

This operation returns detailed information about a specified domain that is\n\t\t\tassociated with the current Amazon Web Services account. Contact information for the\n\t\t\tdomain is also returned as part of the output.

" } }, "com.amazonaws.route53domains#GetDomainDetailRequest": { @@ -2346,15 +3175,13 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of a domain.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of a domain.

" } }, "Nameservers": { "target": "com.amazonaws.route53domains#NameserverList", "traits": { - "smithy.api#documentation": "

The\n\t\t\tname of the domain.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name servers of the domain.

" } }, "AutoRenew": { @@ -2366,52 +3193,49 @@ "AdminContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

Provides details about the domain administrative contact.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Provides details about the domain administrative contact.

" } }, "RegistrantContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

Provides details about the domain registrant.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Provides details about the domain registrant.

" } }, "TechContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

Provides details about the domain technical contact.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Provides details about the domain technical contact.

" } }, "AdminPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS\n\t\t\tqueries. If the value is true, WHOIS (\"who is\") queries return contact\n\t\t\tinformation either for Amazon Registrar (for .com, .net, and .org domains) or for our\n\t\t\tregistrar associate, Gandi (for all other TLDs). If the value is false,\n\t\t\tWHOIS queries return the information that you entered for the admin contact.

" + "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

" } }, "RegistrantPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

" + "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

" } }, "TechPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

" + "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

" } }, "RegistrarName": { "target": "com.amazonaws.route53domains#RegistrarName", "traits": { - "smithy.api#documentation": "

Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are registered by \n\t\t\tAmazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for domains that are registered by \n\t\t\tGandi is \"GANDI SAS\".

" + "smithy.api#documentation": "

Name of the registrar of the domain as identified in the registry. Domains with a\n\t\t\t.com, .net, or .org TLD are registered by Amazon Registrar. All other domains are\n\t\t\tregistered by our registrar associate, Gandi. The value for domains that are registered\n\t\t\tby Gandi is \"GANDI SAS\".

" } }, "WhoIsServer": { "target": "com.amazonaws.route53domains#RegistrarWhoIsServer", "traits": { - "smithy.api#documentation": "

The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

" + "smithy.api#documentation": "

The fully qualified name of the WHOIS server that can answer the WHOIS query for the\n\t\t\tdomain.

" } }, "RegistrarUrl": { @@ -2423,7 +3247,7 @@ "AbuseContactEmail": { "target": "com.amazonaws.route53domains#Email", "traits": { - "smithy.api#documentation": "

Email address to contact to report incorrect contact information for a domain, to report that the domain \n\t\t\tis being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

" + "smithy.api#documentation": "

Email address to contact to report incorrect contact information for a domain, to\n\t\t\treport that the domain is being used to send spam, to report that someone is\n\t\t\tcybersquatting on a domain name, or report some other type of abuse.

" } }, "AbuseContactPhone": { @@ -2441,25 +3265,25 @@ "CreationDate": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

The date when the domain was created as found in the response to a WHOIS query. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

" + "smithy.api#documentation": "

The date when the domain was created as found in the response to a WHOIS query. The\n\t\t\tdate and time is in Unix time format and Coordinated Universal time (UTC).

" } }, "UpdatedDate": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

The last updated date of the domain as found in the response to a WHOIS query. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

" + "smithy.api#documentation": "

The last updated date of the domain as found in the response to a WHOIS query. The\n\t\t\tdate and time is in Unix time format and Coordinated Universal time (UTC).

" } }, "ExpirationDate": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

The date when the registration for the domain is set to expire. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).

" + "smithy.api#documentation": "

The date when the registration for the domain is set to expire. The date and time is\n\t\t\tin Unix time format and Coordinated Universal time (UTC).

" } }, "Reseller": { "target": "com.amazonaws.route53domains#Reseller", "traits": { - "smithy.api#documentation": "

Reseller of the domain. Domains registered or transferred using Route 53 domains will have \"Amazon\" \n\t\t\tas the reseller.

" + "smithy.api#documentation": "

Reseller of the domain. Domains registered or transferred using Route 53 domains will\n\t\t\thave \"Amazon\" as the reseller.

" } }, "DnsSec": { @@ -2471,7 +3295,13 @@ "StatusList": { "target": "com.amazonaws.route53domains#DomainStatusList", "traits": { - "smithy.api#documentation": "

An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

\n\t\t

ICANN, the organization that maintains a central database of domain names, has developed a set of domain name \n\t\t\tstatus codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, \n\t\t\ttransferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars \n\t\t\tuse this same set of status codes.

\n\t\t

For a current list of domain name status codes and an explanation of what each code means, go to the\n\t\t\tICANN website and search for epp status codes.\n\t\t\t(Search on the ICANN website; web searches sometimes return an old version of the document.)

" + "smithy.api#documentation": "

An array of domain name status codes, also known as Extensible Provisioning Protocol\n\t\t\t(EPP) status codes.

\n

ICANN, the organization that maintains a central database of domain names, has\n\t\t\tdeveloped a set of domain name status codes that tell you the status of a variety of\n\t\t\toperations on a domain name, for example, registering a domain name, transferring a\n\t\t\tdomain name to another registrar, renewing the registration for a domain name, and so\n\t\t\ton. All registrars use this same set of status codes.

\n

For a current list of domain name status codes and an explanation of what each code\n\t\t\tmeans, go to the ICANN website and search\n\t\t\tfor epp status codes. (Search on the ICANN website; web searches sometimes\n\t\t\treturn an old version of the document.)

" + } + }, + "DnssecKeys": { + "target": "com.amazonaws.route53domains#DnssecKeyList", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the DNSSEC configuration.

" } } }, @@ -2505,7 +3335,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, \n\t\t\tmust be a TLD that Route 53 supports. For a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

The domain name can contain only the following characters:

\n\t\t
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in example.com.

    \n
    • \n
\n\t\t

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use \n\t\t\tsupports internationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\t

", + "smithy.api#documentation": "

A domain name that you want to use as the basis for a list of possible domain names.\n\t\t\tThe top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a\n\t\t\tlist of supported TLDs, see Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

The domain name can contain only the following characters:

\n
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.

    \n
    • \n
\n

Internationalized domain names are not supported for some top-level domains. To\n\t\t\tdetermine whether the TLD that you want to use supports internationalized domain names,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53.

", "smithy.api#required": {} } }, @@ -2513,14 +3343,14 @@ "target": "com.amazonaws.route53domains#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.

", + "smithy.api#documentation": "

The number of suggested domain names that you want Route 53 to return. Specify a value\n\t\t\tbetween 1 and 50.

", "smithy.api#required": {} } }, "OnlyAvailable": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

If OnlyAvailable is true, Route 53 returns only domain names that are available. \n\t\t\tIf OnlyAvailable is false, Route 53 returns domain names without checking whether they're \n\t\t\tavailable to be registered. To determine whether the domain is available, you can call checkDomainAvailability \n\t\t\tfor each suggestion.

", + "smithy.api#documentation": "

If OnlyAvailable is true, Route 53 returns only domain names\n\t\t\tthat are available. If OnlyAvailable is false, Route 53\n\t\t\treturns domain names without checking whether they're available to be registered. To\n\t\t\tdetermine whether the domain is available, you can call\n\t\t\t\tcheckDomainAvailability for each suggestion.

", "smithy.api#required": {} } } @@ -2532,7 +3362,7 @@ "SuggestionsList": { "target": "com.amazonaws.route53domains#DomainSuggestionsList", "traits": { - "smithy.api#documentation": "

A list of possible domain names. If you specified true for OnlyAvailable in the request, \n\t\t\tthe list contains only domains that are available for registration.

" + "smithy.api#documentation": "

A list of possible domain names. If you specified true for\n\t\t\t\tOnlyAvailable in the request, the list contains only domains that are\n\t\t\tavailable for registration.

" } } } @@ -2551,7 +3381,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns the current status of an operation that is not completed.

" + "smithy.api#documentation": "

This operation returns the current status of an operation that is not\n\t\t\tcompleted.

" } }, "com.amazonaws.route53domains#GetOperationDetailRequest": { @@ -2560,13 +3390,13 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

The identifier for the operation for which you want to get the status. Route 53 returned the identifier \n\t\t\tin the response to the original request.

", + "smithy.api#documentation": "

The identifier for the operation for which you want to get the status. Route 53\n\t\t\treturned the identifier in the response to the original request.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The \n\t\t\tGetOperationDetail \n\t\t\trequest includes the following element.

" + "smithy.api#documentation": "

The GetOperationDetail request includes the following element.

" } }, "com.amazonaws.route53domains#GetOperationDetailResponse": { @@ -2607,6 +3437,18 @@ "traits": { "smithy.api#documentation": "

The date when the request was submitted.

" } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.route53domains#Timestamp", + "traits": { + "smithy.api#documentation": "

The date when the operation was last updated.

" + } + }, + "StatusFlag": { + "target": "com.amazonaws.route53domains#StatusFlag", + "traits": { + "smithy.api#documentation": "

Lists any outstanding operations that require customer action. Valid values\n\t\t\tare:

\n
    \n
  • \n

    \n PENDING_ACCEPTANCE: The operation is waiting for acceptance from\n\t\t\t\t\tthe account that is receiving the domain.

    \n
    • \n
  • \n

    \n PENDING_CUSTOMER_ACTION: The operation is waiting for customer\n\t\t\t\t\taction, for example, returning an email.

    \n
    • \n
  • \n

    \n PENDING_AUTHORIZATION: The operation is waiting for the form of\n\t\t\t\t\tauthorization. For more information, see ResendOperationAuthorization.

    \n
    • \n
  • \n

    \n PENDING_PAYMENT_VERIFICATION: The operation is waiting for the\n\t\t\t\t\tpayment method to validate.

    \n
    • \n
  • \n

    \n PENDING_SUPPORT_CASE: The operation includes a support case and\n\t\t\t\t\tis waiting for its resolution.

    \n
    • \n
" + } } }, "traits": { @@ -2650,12 +3492,12 @@ "message": { "target": "com.amazonaws.route53domains#ErrorMessage", "traits": { - "smithy.api#documentation": "

The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation \n\t\t\tthat is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

" + "smithy.api#documentation": "

The requested item is not acceptable. For example, for an OperationId it might refer\n\t\t\tto the ID of an operation that is already completed. For a domain name, it might not be\n\t\t\ta valid domain name or belong to the requester account.

" } } }, "traits": { - "smithy.api#documentation": "

The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name \n\t\t\tthat doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, \n\t\t\tthe password might be invalid.

", + "smithy.api#documentation": "

The requested item is not acceptable. For example, for APIs that accept a domain name,\n\t\t\tthe request might specify a domain name that doesn't belong to the account that\n\t\t\tsubmitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the\n\t\t\tpassword might be invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2663,6 +3505,15 @@ "com.amazonaws.route53domains#InvoiceId": { "type": "string" }, + "com.amazonaws.route53domains#Label": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.route53domains#LangCode": { "type": "string", "traits": { @@ -2686,7 +3537,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account\n\t\t\t if no filtering conditions are used.

", + "smithy.api#documentation": "

This operation returns all the domain names registered with Amazon Route 53 for the\n\t\t\tcurrent Amazon Web Services account if no filtering conditions are used.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2696,18 +3547,20 @@ } }, "com.amazonaws.route53domains#ListDomainsAttributeName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DomainName", - "name": "DomainName" - }, - { - "value": "Expiry", - "name": "Expiry" + "type": "enum", + "members": { + "DomainName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DomainName" + } + }, + "Expiry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expiry" } - ] + } } }, "com.amazonaws.route53domains#ListDomainsRequest": { @@ -2716,25 +3569,25 @@ "FilterConditions": { "target": "com.amazonaws.route53domains#FilterConditions", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can\n\t\t\tinclude domain name and domain expiration.

" + "smithy.api#documentation": "

A complex type that contains information about the filters applied during the\n\t\t\t\tListDomains request. The filter conditions can include domain name and\n\t\t\tdomain expiration.

" } }, "SortCondition": { "target": "com.amazonaws.route53domains#SortCondition", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the requested ordering of domains in the returned list.

" + "smithy.api#documentation": "

A complex type that contains information about the requested ordering of domains in\n\t\t\tthe returned list.

" } }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

For an initial request for a list of domains, omit this element. If the number of domains\n\t\t\tthat are associated with the current Amazon Web Services account is greater than the value that you specified for\n\t\t\tMaxItems, you can use Marker to return additional domains. Get the value of\n\t\t\tNextPageMarker from the previous response, and submit another request that includes the\n\t\t\tvalue of NextPageMarker in the Marker element.

\n\t\t

Constraints: The marker must match the value specified in the previous request.

" + "smithy.api#documentation": "

For an initial request for a list of domains, omit this element. If the number of\n\t\t\tdomains that are associated with the current Amazon Web Services account is greater than\n\t\t\tthe value that you specified for MaxItems, you can use Marker\n\t\t\tto return additional domains. Get the value of NextPageMarker from the\n\t\t\tprevious response, and submit another request that includes the value of\n\t\t\t\tNextPageMarker in the Marker element.

\n

Constraints: The marker must match the value specified in the previous request.

" } }, "MaxItems": { "target": "com.amazonaws.route53domains#PageMaxItems", "traits": { - "smithy.api#documentation": "

Number of domains to be returned.

\n\t\t

Default: 20

" + "smithy.api#documentation": "

Number of domains to be returned.

\n

Default: 20

" } } }, @@ -2748,14 +3601,13 @@ "Domains": { "target": "com.amazonaws.route53domains#DomainSummaryList", "traits": { - "smithy.api#documentation": "

A list of domains.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of domains.

" } }, "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

If there are more domains than you specified for MaxItems in the request, submit another\n\t\t\trequest and include the value of NextPageMarker in the value of Marker.

" + "smithy.api#documentation": "

If there are more domains than you specified for MaxItems in the request,\n\t\t\tsubmit another request and include the value of NextPageMarker in the value\n\t\t\tof Marker.

" } } }, @@ -2777,7 +3629,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about all of the operations that return an operation ID and that have ever been \n\t\t\tperformed on domains that were registered by the current account.

\n\t\t

This command runs only in the us-east-1 Region.

", + "smithy.api#documentation": "

Returns information about all of the operations that return an operation ID and that\n\t\t\thave ever been performed on domains that were registered by the current account.

\n

This command runs only in the us-east-1 Region.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2792,19 +3644,43 @@ "SubmittedSince": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. \n\t\t\tSpecify the date and time in Unix time format and Coordinated Universal time (UTC).

" + "smithy.api#documentation": "

An optional parameter that lets you get information about all the operations that you\n\t\t\tsubmitted after a specified date and time. Specify the date and time in Unix time format\n\t\t\tand Coordinated Universal time (UTC).

" } }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

For an initial request for a list of operations, omit this element. If the number of operations that are\n\t\t\tnot yet complete is greater than the value that you specified for MaxItems, you can use Marker\n\t\t\tto return additional operations. Get the value of NextPageMarker from the previous response,\n\t\t\tand submit another request that includes the value of NextPageMarker in the Marker element.

" + "smithy.api#documentation": "

For an initial request for a list of operations, omit this element. If the number of\n\t\t\toperations that are not yet complete is greater than the value that you specified for\n\t\t\t\tMaxItems, you can use Marker to return additional\n\t\t\toperations. Get the value of NextPageMarker from the previous response, and\n\t\t\tsubmit another request that includes the value of NextPageMarker in the\n\t\t\t\tMarker element.

" } }, "MaxItems": { "target": "com.amazonaws.route53domains#PageMaxItems", "traits": { - "smithy.api#documentation": "

Number of domains to be returned.

\n\t\t

Default: 20

" + "smithy.api#documentation": "

Number of domains to be returned.

\n

Default: 20

" + } + }, + "Status": { + "target": "com.amazonaws.route53domains#OperationStatusList", + "traits": { + "smithy.api#documentation": "

The status of the operations.

" + } + }, + "Type": { + "target": "com.amazonaws.route53domains#OperationTypeList", + "traits": { + "smithy.api#documentation": "

An arrays of the domains operation types.

" + } + }, + "SortBy": { + "target": "com.amazonaws.route53domains#ListOperationsSortAttributeName", + "traits": { + "smithy.api#documentation": "

The sort type for returned values.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.route53domains#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order ofr returned values, either ascending or descending.

" } } }, @@ -2818,14 +3694,13 @@ "Operations": { "target": "com.amazonaws.route53domains#OperationSummaryList", "traits": { - "smithy.api#documentation": "

Lists summaries of the operations.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Lists summaries of the operations.

" } }, "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

If there are more operations than you specified for MaxItems in the request, submit another\n\t\t\trequest and include the value of NextPageMarker in the value of Marker.

" + "smithy.api#documentation": "

If there are more operations than you specified for MaxItems in the\n\t\t\trequest, submit another request and include the value of NextPageMarker in\n\t\t\tthe value of Marker.

" } } }, @@ -2833,6 +3708,17 @@ "smithy.api#documentation": "

The ListOperations response includes the following elements.

" } }, + "com.amazonaws.route53domains#ListOperationsSortAttributeName": { + "type": "enum", + "members": { + "SubmittedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubmittedDate" + } + } + } + }, "com.amazonaws.route53domains#ListPrices": { "type": "operation", "input": { @@ -2850,7 +3736,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:

\n\t\t
    \n
  • \n

    Registration

    \n
    • \n
  • \n

    Transfer

    \n
    • \n
  • \n

    Owner change

    \n
    • \n
  • \n

    Domain renewal

    \n
    • \n
  • \n

    Domain restoration

    \n
    • \n
", + "smithy.api#documentation": "

Lists the following prices for either all the TLDs supported by Route 53, or\n\t\t\tthe specified TLD:

\n
    \n
  • \n

    Registration

    \n
    • \n
  • \n

    Transfer

    \n
    • \n
  • \n

    Owner change

    \n
    • \n
  • \n

    Domain renewal

    \n
    • \n
  • \n

    Domain restoration

    \n
    • \n
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2865,19 +3751,19 @@ "Tld": { "target": "com.amazonaws.route53domains#TldName", "traits": { - "smithy.api#documentation": "

The TLD for which you want to receive the pricing information. For example.\n\t\t\t\t.net.

\n\t\t

If a Tld value is not provided, a list of prices for all TLDs supported by Route 53\n\t\tis returned.

" + "smithy.api#documentation": "

The TLD for which you want to receive the pricing information. For example.\n\t\t\t\t.net.

\n

If a Tld value is not provided, a list of prices for all TLDs supported\n\t\t\tby Route 53 is returned.

" } }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

For an initial request for a list of prices, omit this element. \n\t\t\tIf the number of prices that are not yet complete is greater than the value that you specified for MaxItems, \n\t\t\tyou can use Marker to return additional prices. Get the value of NextPageMarker from the previous response, \n\t\t\tand submit another request that includes the value of NextPageMarker in the Marker element.

\n\t\t

Used only for all TLDs. If you specify a TLD, don't specify a Marker.

" + "smithy.api#documentation": "

For an initial request for a list of prices, omit this element. If the number of\n\t\t\tprices that are not yet complete is greater than the value that you specified for\n\t\t\t\tMaxItems, you can use Marker to return additional prices.\n\t\t\tGet the value of NextPageMarker from the previous response, and submit\n\t\t\tanother request that includes the value of NextPageMarker in the\n\t\t\t\tMarker element.

\n

Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tMarker.

" } }, "MaxItems": { "target": "com.amazonaws.route53domains#PageMaxItems", "traits": { - "smithy.api#documentation": "

Number of Prices to be returned.

\n\t\t

Used only for all TLDs. If you specify a TLD, don't specify a MaxItems.

" + "smithy.api#documentation": "

Number of Prices to be returned.

\n

Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tMaxItems.

" } } } @@ -2888,14 +3774,13 @@ "Prices": { "target": "com.amazonaws.route53domains#DomainPriceList", "traits": { - "smithy.api#documentation": "

A complex type that includes all the pricing information. If you specify a TLD, this array\n\t\t\tcontains only the pricing for that TLD.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A complex type that includes all the pricing information. If you specify a TLD, this\n\t\t\tarray contains only the pricing for that TLD.

" } }, "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

If there are more prices than you specified for MaxItems in the request, submit another request and include the value of \n\t\t\tNextPageMarker in the value of Marker.

\n\t\t

Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tNextPageMarker.

" + "smithy.api#documentation": "

If there are more prices than you specified for MaxItems in the request,\n\t\t\tsubmit another request and include the value of NextPageMarker in the value\n\t\t\tof Marker.

\n

Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\t\tNextPageMarker.

" } } } @@ -2920,7 +3805,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns all of the tags that are associated with the specified domain.

\n\t\t

All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

" + "smithy.api#documentation": "

This operation returns all of the tags that are associated with the specified\n\t\t\tdomain.

\n

All tag operations are eventually consistent; subsequent operations might not\n\t\t\timmediately represent all issued operations.

" } }, "com.amazonaws.route53domains#ListTagsForDomainRequest": { @@ -2944,8 +3829,7 @@ "TagList": { "target": "com.amazonaws.route53domains#TagList", "traits": { - "smithy.api#documentation": "

A list of the tags that are associated with the specified domain.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of the tags that are associated with the specified domain.

" } } }, @@ -2959,217 +3843,310 @@ "Name": { "target": "com.amazonaws.route53domains#HostName", "traits": { - "smithy.api#documentation": "

The fully qualified host name of the name server.

\n\t\t

Constraint: Maximum 255 characters

", + "smithy.api#documentation": "

The fully qualified host name of the name server.

\n

Constraint: Maximum 255 characters

", "smithy.api#required": {} } }, - "GlueIps": { - "target": "com.amazonaws.route53domains#GlueIpList", + "GlueIps": { + "target": "com.amazonaws.route53domains#GlueIpList", + "traits": { + "smithy.api#documentation": "

Glue IP address of a name server entry. Glue IP addresses are required only when the\n\t\t\tname of the name server is a subdomain of the domain. For example, if your domain is\n\t\t\texample.com and the name server for the domain is ns.example.com, you need to specify\n\t\t\tthe IP address for ns.example.com.

\n

Constraints: The list can contain only one IPv4 and one IPv6 address.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Name server includes the following elements.

" + } + }, + "com.amazonaws.route53domains#NameserverList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#Nameserver" + } + }, + "com.amazonaws.route53domains#NullableInteger": { + "type": "integer" + }, + "com.amazonaws.route53domains#OperationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53domains#OperationLimitExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53domains#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The number of operations or jobs running exceeded the allowed threshold for the\n\t\t\taccount.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of operations or jobs running exceeded the allowed threshold for the\n\t\t\taccount.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53domains#OperationStatus": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.route53domains#OperationStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#OperationStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.route53domains#OperationSummary": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "

Identifier returned to track the requested action.

" + } + }, + "Status": { + "target": "com.amazonaws.route53domains#OperationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the requested operation in the system.

" + } + }, + "Type": { + "target": "com.amazonaws.route53domains#OperationType", + "traits": { + "smithy.api#documentation": "

Type of the action requested.

" + } + }, + "SubmittedDate": { + "target": "com.amazonaws.route53domains#Timestamp", + "traits": { + "smithy.api#documentation": "

The date when the request was submitted.

" + } + }, + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "

Name of the domain.

" + } + }, + "Message": { + "target": "com.amazonaws.route53domains#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Message about the operation.

" + } + }, + "StatusFlag": { + "target": "com.amazonaws.route53domains#StatusFlag", + "traits": { + "smithy.api#documentation": "

Automatically checks whether there are no outstanding operations on domains that need\n\t\t\tcustomer attention.

\n

Valid values are:

\n
    \n
  • \n

    \n PENDING_ACCEPTANCE: The operation is waiting for acceptance from\n\t\t\t\t\tthe account that is receiving the domain.

    \n
    • \n
  • \n

    \n PENDING_CUSTOMER_ACTION: The operation is waiting for customer\n\t\t\t\t\taction, for example, returning an email.

    \n
    • \n
  • \n

    \n PENDING_AUTHORIZATION: The operation is waiting for the form of\n\t\t\t\t\tauthorization. For more information, see ResendOperationAuthorization.

    \n
    • \n
  • \n

    \n PENDING_PAYMENT_VERIFICATION: The operation is waiting for the\n\t\t\t\t\tpayment method to validate.

    \n
    • \n
  • \n

    \n PENDING_SUPPORT_CASE: The operation includes a support case and\n\t\t\t\t\tis waiting for its resolution.

    \n
    • \n
" + } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.route53domains#Timestamp", + "traits": { + "smithy.api#documentation": "

The date when the last change was made in Unix time format and Coordinated Universal\n\t\t\tTime (UTC).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

OperationSummary includes the following elements.

" + } + }, + "com.amazonaws.route53domains#OperationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#OperationSummary" + } + }, + "com.amazonaws.route53domains#OperationType": { + "type": "enum", + "members": { + "REGISTER_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTER_DOMAIN" + } + }, + "DELETE_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_DOMAIN" + } + }, + "TRANSFER_IN_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFER_IN_DOMAIN" + } + }, + "UPDATE_DOMAIN_CONTACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_DOMAIN_CONTACT" + } + }, + "UPDATE_NAMESERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_NAMESERVER" + } + }, + "CHANGE_PRIVACY_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHANGE_PRIVACY_PROTECTION" + } + }, + "DOMAIN_LOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_LOCK" + } + }, + "ENABLE_AUTORENEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_AUTORENEW" + } + }, + "DISABLE_AUTORENEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_AUTORENEW" + } + }, + "ADD_DNSSEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_DNSSEC" + } + }, + "REMOVE_DNSSEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_DNSSEC" + } + }, + "EXPIRE_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRE_DOMAIN" + } + }, + "TRANSFER_OUT_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFER_OUT_DOMAIN" + } + }, + "CHANGE_DOMAIN_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHANGE_DOMAIN_OWNER" + } + }, + "RENEW_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RENEW_DOMAIN" + } + }, + "PUSH_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUSH_DOMAIN" + } + }, + "INTERNAL_TRANSFER_OUT_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_TRANSFER_OUT_DOMAIN" + } + }, + "INTERNAL_TRANSFER_IN_DOMAIN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server \n\t\t\tis a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is \n\t\t\tns.example.com, you need to specify the IP address for ns.example.com.

\n\t\t

Constraints: The list can contain only one IPv4 and one IPv6 address.

" + "smithy.api#enumValue": "INTERNAL_TRANSFER_IN_DOMAIN" } } - }, - "traits": { - "smithy.api#documentation": "

Nameserver includes the following elements.

" } }, - "com.amazonaws.route53domains#NameserverList": { + "com.amazonaws.route53domains#OperationTypeList": { "type": "list", "member": { - "target": "com.amazonaws.route53domains#Nameserver" - } - }, - "com.amazonaws.route53domains#OperationId": { - "type": "string", + "target": "com.amazonaws.route53domains#OperationType" + }, "traits": { "smithy.api#length": { "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53domains#OperationLimitExceeded": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53domains#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The number of operations or jobs running exceeded the allowed threshold for the account.

" - } + "max": 18 } - }, - "traits": { - "smithy.api#documentation": "

The number of operations or jobs running exceeded the allowed threshold for the account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53domains#OperationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUBMITTED", - "name": "SUBMITTED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "SUCCESSFUL", - "name": "SUCCESSFUL" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] } }, - "com.amazonaws.route53domains#OperationSummary": { - "type": "structure", + "com.amazonaws.route53domains#Operator": { + "type": "enum", "members": { - "OperationId": { - "target": "com.amazonaws.route53domains#OperationId", - "traits": { - "smithy.api#documentation": "

Identifier returned to track the requested action.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.route53domains#OperationStatus", + "LE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The current status of the requested operation in the system.

", - "smithy.api#required": {} + "smithy.api#enumValue": "LE" } }, - "Type": { - "target": "com.amazonaws.route53domains#OperationType", + "GE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Type of the action requested.

", - "smithy.api#required": {} + "smithy.api#enumValue": "GE" } }, - "SubmittedDate": { - "target": "com.amazonaws.route53domains#Timestamp", + "BEGINS_WITH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The date when the request was submitted.

", - "smithy.api#required": {} + "smithy.api#enumValue": "BEGINS_WITH" } } - }, - "traits": { - "smithy.api#documentation": "

OperationSummary includes the following elements.

" - } - }, - "com.amazonaws.route53domains#OperationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53domains#OperationSummary" - } - }, - "com.amazonaws.route53domains#OperationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REGISTER_DOMAIN", - "name": "REGISTER_DOMAIN" - }, - { - "value": "DELETE_DOMAIN", - "name": "DELETE_DOMAIN" - }, - { - "value": "TRANSFER_IN_DOMAIN", - "name": "TRANSFER_IN_DOMAIN" - }, - { - "value": "UPDATE_DOMAIN_CONTACT", - "name": "UPDATE_DOMAIN_CONTACT" - }, - { - "value": "UPDATE_NAMESERVER", - "name": "UPDATE_NAMESERVER" - }, - { - "value": "CHANGE_PRIVACY_PROTECTION", - "name": "CHANGE_PRIVACY_PROTECTION" - }, - { - "value": "DOMAIN_LOCK", - "name": "DOMAIN_LOCK" - }, - { - "value": "ENABLE_AUTORENEW", - "name": "ENABLE_AUTORENEW" - }, - { - "value": "DISABLE_AUTORENEW", - "name": "DISABLE_AUTORENEW" - }, - { - "value": "ADD_DNSSEC", - "name": "ADD_DNSSEC" - }, - { - "value": "REMOVE_DNSSEC", - "name": "REMOVE_DNSSEC" - }, - { - "value": "EXPIRE_DOMAIN", - "name": "EXPIRE_DOMAIN" - }, - { - "value": "TRANSFER_OUT_DOMAIN", - "name": "TRANSFER_OUT_DOMAIN" - }, - { - "value": "CHANGE_DOMAIN_OWNER", - "name": "CHANGE_DOMAIN_OWNER" - }, - { - "value": "RENEW_DOMAIN", - "name": "RENEW_DOMAIN" - }, - { - "value": "PUSH_DOMAIN", - "name": "PUSH_DOMAIN" - }, - { - "value": "INTERNAL_TRANSFER_OUT_DOMAIN", - "name": "INTERNAL_TRANSFER_OUT_DOMAIN" - }, - { - "value": "INTERNAL_TRANSFER_IN_DOMAIN", - "name": "INTERNAL_TRANSFER_IN_DOMAIN" - } - ] - } - }, - "com.amazonaws.route53domains#Operator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LE", - "name": "LE" - }, - { - "value": "GE", - "name": "GE" - }, - { - "value": "BEGINS_WITH", - "name": "BEGINS_WITH" - } - ] } }, "com.amazonaws.route53domains#PageMarker": { @@ -3218,23 +4195,69 @@ "smithy.api#documentation": "

Currency-specific price information.

" } }, - "com.amazonaws.route53domains#ReachabilityStatus": { - "type": "string", + "com.amazonaws.route53domains#PushDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#PushDomainRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "DONE", - "name": "DONE" - }, - { - "value": "EXPIRED", - "name": "EXPIRED" + "smithy.api#documentation": "

Moves a domain from Amazon Web Services to another registrar.

\n

Supported actions:

\n
    \n
  • \n

    Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means\n\t\t\t\t\tthat the domain is ready to be transferred to another registrar.

    \n
    • \n
" + } + }, + "com.amazonaws.route53domains#PushDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "

Name of the domain.

", + "smithy.api#required": {} + } + }, + "Target": { + "target": "com.amazonaws.route53domains#Label", + "traits": { + "smithy.api#documentation": "

New IPS tag for the domain.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53domains#ReachabilityStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "DONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DONE" } - ] + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + } } }, "com.amazonaws.route53domains#RegisterDomain": { @@ -3266,7 +4289,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by \n\t\t\tour registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.

\n\t\t

When you register a domain, Amazon Route 53 does the following:

\n\t\t\t
    \n
  • \n

    Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers \n\t\t\t\t\tto your hosted zone and automatically updates your domain registration with the names of these name servers.

    \n
    • \n
  • \n

    Enables autorenew, so your domain registration will renew automatically each year. We'll notify you \n\t\t\t\t\tin advance of the renewal date so you can choose whether to renew the registration.

    \n
    • \n
  • \n

    Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar \n\t\t\t\t\t(for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy \n\t\t\t\t\tprotection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.

    \n\t\t\t\t\t \n\t\t\t\t\t\t

    You must specify the same privacy setting for the administrative, registrant, and technical contacts.

    \n\t\t\t\t\t     \n\t\t\t\t
    • \n
  • \n

    If registration is successful, returns an operation ID that you can use to track the progress and \n\t\t\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant is notified by email.

    \n
    • \n
  • \n

    Charges your Amazon Web Services account an amount based on the top-level domain. For more information, see \n\t\t\t\t\tAmazon Route 53 Pricing.

    \n
    • \n
" + "smithy.api#documentation": "

This operation registers a domain. Domains are registered either by Amazon Registrar\n\t\t\t(for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other\n\t\t\tdomains). For some top-level domains (TLDs), this operation requires extra\n\t\t\tparameters.

\n

When you register a domain, Amazon Route 53 does the following:

\n
    \n
  • \n

    Creates a Route 53 hosted zone that has the same name as the domain. Route 53\n\t\t\t\t\tassigns four name servers to your hosted zone and automatically updates your\n\t\t\t\t\tdomain registration with the names of these name servers.

    \n
    • \n
  • \n

    Enables auto renew, so your domain registration will renew automatically each\n\t\t\t\t\tyear. We'll notify you in advance of the renewal date so you can choose whether\n\t\t\t\t\tto renew the registration.

    \n
    • \n
  • \n

    Optionally enables privacy protection, so WHOIS queries return contact\n\t\t\t\t\tinformation either for Amazon Registrar (for .com, .net, and .org domains) or\n\t\t\t\t\tfor our registrar associate, Gandi (for all other TLDs). If you don't enable\n\t\t\t\t\tprivacy protection, WHOIS queries return the information that you entered for\n\t\t\t\t\tthe administrative, registrant, and technical contacts.

    \n \n

    You must specify the same privacy setting for the administrative,\n\t\t\t\t\t\tregistrant, and technical contacts.

    \n     \n
    • \n
  • \n

    If registration is successful, returns an operation ID that you can use to\n\t\t\t\t\ttrack the progress and completion of the action. If the request is not completed\n\t\t\t\t\tsuccessfully, the domain registrant is notified by email.

    \n
    • \n
  • \n

    Charges your Amazon Web Services account an amount based on the top-level\n\t\t\t\t\tdomain. For more information, see Amazon Route 53 Pricing.

    \n
    • \n
" } }, "com.amazonaws.route53domains#RegisterDomainRequest": { @@ -3275,7 +4298,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The domain name that you want to register. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

The domain name can contain only the following characters:

\n\t\t
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in example.com.

    \n
    • \n
\n\t\t

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports \n\t\t\tinternationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\tFor more information, see \n\t\t\tFormatting Internationalized Domain Names.\n\t\t

", + "smithy.api#documentation": "

The domain name that you want to register. The top-level domain (TLD), such as .com,\n\t\t\tmust be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon\n\t\t\t\tRoute 53 Developer Guide.

\n

The domain name can contain only the following characters:

\n
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.

    \n
    • \n
\n

Internationalized domain names are not supported for some top-level domains. To\n\t\t\tdetermine whether the TLD that you want to use supports internationalized domain names,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

", "smithy.api#required": {} } }, @@ -3288,53 +4311,53 @@ "DurationInYears": { "target": "com.amazonaws.route53domains#DurationInYears", "traits": { - "smithy.api#documentation": "

The number of years that you want to register the domain for. Domains are registered for a minimum of one year. \n\t\t\tThe maximum period depends on the top-level domain. For the range of valid values for your domain, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

Default: 1

", + "smithy.api#documentation": "

The number of years that you want to register the domain for. Domains are registered\n\t\t\tfor a minimum of one year. The maximum period depends on the top-level domain. For the\n\t\t\trange of valid values for your domain, see Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

Default: 1

", "smithy.api#required": {} } }, "AutoRenew": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the domain will be automatically renewed (true) or not (false). \n\t\t\tAutorenewal only takes effect after the account is charged.

\n\t\t

Default: true\n

" + "smithy.api#documentation": "

Indicates whether the domain will be automatically renewed (true) or not\n\t\t\t\t(false). Auto renewal only takes effect after the account is\n\t\t\tcharged.

\n

Default: true\n

" } }, "AdminContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.

", + "smithy.api#documentation": "

Provides detailed contact information. For information about the values that you\n\t\t\tspecify for each element, see ContactDetail.

", "smithy.api#required": {} } }, "RegistrantContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.

", + "smithy.api#documentation": "

Provides detailed contact information. For information about the values that you\n\t\t\tspecify for each element, see ContactDetail.

", "smithy.api#required": {} } }, "TechContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "

Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.

", + "smithy.api#documentation": "

Provides detailed contact information. For information about the values that you\n\t\t\tspecify for each element, see ContactDetail.

", "smithy.api#required": {} } }, "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t \n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" } }, "PrivacyProtectRegistrantContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (the domain owner).

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t \n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (the domain owner).

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" } }, "PrivacyProtectTechContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t \n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" } } }, @@ -3348,8 +4371,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } } }, @@ -3389,7 +4411,7 @@ } ], "traits": { - "smithy.api#documentation": "

Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t

\n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" + "smithy.api#documentation": "

Rejects the transfer of a domain from another Amazon Web Services account to the\n\t\t\tcurrent Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.

\n

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,\n\t\t\t\tDomain Transfer from Aws Account 111122223333 has been cancelled.

" } }, "com.amazonaws.route53domains#RejectDomainTransferFromAnotherAwsAccountRequest": { @@ -3398,13 +4420,13 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that was specified when another Amazon Web Services account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t

", + "smithy.api#documentation": "

The name of the domain that was specified when another Amazon Web Services account\n\t\t\tsubmitted a TransferDomainToAnotherAwsAccount request.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The RejectDomainTransferFromAnotherAwsAccount request includes the following element.

" + "smithy.api#documentation": "

The RejectDomainTransferFromAnotherAwsAccount request includes the following\n\t\t\telement.

" } }, "com.amazonaws.route53domains#RejectDomainTransferFromAnotherAwsAccountResponse": { @@ -3413,12 +4435,12 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. \n\t\t\tBecause the transfer request was rejected, the value is no longer valid, and you can't use GetOperationDetail \n\t\t\tto query the operation status.

" + "smithy.api#documentation": "

The identifier that TransferDomainToAnotherAwsAccount returned to track\n\t\t\tthe progress of the request. Because the transfer request was rejected, the value is no\n\t\t\tlonger valid, and you can't use GetOperationDetail to query the operation\n\t\t\tstatus.

" } } }, "traits": { - "smithy.api#documentation": "

The RejectDomainTransferFromAnotherAwsAccount response includes the following element.

" + "smithy.api#documentation": "

The RejectDomainTransferFromAnotherAwsAccount response includes the following\n\t\t\telement.

" } }, "com.amazonaws.route53domains#RenewDomain": { @@ -3447,7 +4469,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services account.

\n\t\t

We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the \n\t\t\texpiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see \n\t\t\tRenewing Registration for a Domain \n\t\t\tin the Amazon Route 53 Developer Guide.

" + "smithy.api#documentation": "

This operation renews a domain for the specified number of years. The cost of renewing\n\t\t\tyour domain is billed to your Amazon Web Services account.

\n

We recommend that you renew your domain several weeks before the expiration date. Some\n\t\t\tTLD registries delete domains before the expiration date if you haven't renewed far\n\t\t\tenough in advance. For more information about renewing domain registration, see Renewing\n\t\t\t\tRegistration for a Domain in the Amazon Route 53 Developer\n\t\t\t\tGuide.

" } }, "com.amazonaws.route53domains#RenewDomainRequest": { @@ -3463,20 +4485,20 @@ "DurationInYears": { "target": "com.amazonaws.route53domains#DurationInYears", "traits": { - "smithy.api#documentation": "

The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. \n\t\t\tFor the range of valid values for your domain, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

Default: 1

" + "smithy.api#documentation": "

The number of years that you want to renew the domain for. The maximum number of years\n\t\t\tdepends on the top-level domain. For the range of valid values for your domain, see\n\t\t\t\tDomains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

Default: 1

" } }, "CurrentExpiryYear": { "target": "com.amazonaws.route53domains#CurrentExpiryYear", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.

", + "smithy.api#documentation": "

The year when the registration for the domain is set to expire. This value must match\n\t\t\tthe current expiration date for the domain.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A RenewDomain request includes the number of years that you want to renew for and the current expiration year.

" + "smithy.api#documentation": "

A RenewDomain request includes the number of years that you want to renew\n\t\t\tfor and the current expiration year.

" } }, "com.amazonaws.route53domains#RenewDomainResponse": { @@ -3485,8 +4507,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } } } @@ -3514,7 +4535,7 @@ } ], "traits": { - "smithy.api#documentation": "

For operations that require confirmation that the email address for the registrant contact is valid, \n\t\t\tsuch as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.

" + "smithy.api#documentation": "

For operations that require confirmation that the email address for the registrant\n\t\t\tcontact is valid, such as registering a new domain, this operation resends the\n\t\t\tconfirmation email to the current email address for the registrant contact.

" } }, "com.amazonaws.route53domains#ResendContactReachabilityEmailRequest": { @@ -3523,7 +4544,7 @@ "domainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain for which you want Route 53 to resend a confirmation email to the registrant contact.

" + "smithy.api#documentation": "

The name of the domain for which you want Route 53 to resend a confirmation email to\n\t\t\tthe registrant contact.

" } } } @@ -3540,13 +4561,42 @@ "emailAddress": { "target": "com.amazonaws.route53domains#Email", "traits": { - "smithy.api#documentation": "

The email address for the registrant contact at the time that we sent the verification email.

" + "smithy.api#documentation": "

The email address for the registrant contact at the time that we sent the verification\n\t\t\temail.

" } }, "isAlreadyVerified": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

\n True if the email address for the registrant contact has already been verified, and false otherwise. \n\t\t\tIf the email address has already been verified, we don't send another confirmation email.

" + "smithy.api#documentation": "

\n True if the email address for the registrant contact has already been\n\t\t\tverified, and false otherwise. If the email address has already been\n\t\t\tverified, we don't send another confirmation email.

" + } + } + } + }, + "com.amazonaws.route53domains#ResendOperationAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#ResendOperationAuthorizationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Resend the form of authorization email for this operation.

" + } + }, + "com.amazonaws.route53domains#ResendOperationAuthorizationRequest": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "

Operation ID.

", + "smithy.api#required": {} } } } @@ -3568,7 +4618,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

" + "smithy.api#documentation": "

This operation returns the authorization code for the domain. To transfer a domain to\n\t\t\tanother registrar, you provide this value to the new registrar.

" } }, "com.amazonaws.route53domains#RetrieveDomainAuthCodeRequest": { @@ -3583,7 +4633,7 @@ } }, "traits": { - "smithy.api#documentation": "

A request for the authorization code for the specified domain. To transfer a domain to another registrar, you provide \n\t\t\tthis value to the new registrar.

" + "smithy.api#documentation": "

A request for the authorization code for the specified domain. To transfer a domain to\n\t\t\tanother registrar, you provide this value to the new registrar.

" } }, "com.amazonaws.route53domains#RetrieveDomainAuthCodeResponse": { @@ -3592,8 +4642,7 @@ "AuthCode": { "target": "com.amazonaws.route53domains#DomainAuthCode", "traits": { - "smithy.api#documentation": "

The authorization code for the domain.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The authorization code for the domain.

" } } }, @@ -3608,6 +4657,9 @@ { "target": "com.amazonaws.route53domains#AcceptDomainTransferFromAnotherAwsAccount" }, + { + "target": "com.amazonaws.route53domains#AssociateDelegationSignerToDomain" + }, { "target": "com.amazonaws.route53domains#CancelDomainTransferToAnotherAwsAccount" }, @@ -3629,6 +4681,9 @@ { "target": "com.amazonaws.route53domains#DisableDomainTransferLock" }, + { + "target": "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomain" + }, { "target": "com.amazonaws.route53domains#EnableDomainAutoRenew" }, @@ -3659,6 +4714,9 @@ { "target": "com.amazonaws.route53domains#ListTagsForDomain" }, + { + "target": "com.amazonaws.route53domains#PushDomain" + }, { "target": "com.amazonaws.route53domains#RegisterDomain" }, @@ -3671,6 +4729,9 @@ { "target": "com.amazonaws.route53domains#ResendContactReachabilityEmail" }, + { + "target": "com.amazonaws.route53domains#ResendOperationAuthorization" + }, { "target": "com.amazonaws.route53domains#RetrieveDomainAuthCode" }, @@ -3708,7 +4769,7 @@ "name": "route53domains" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Route 53 API actions let you register domain names and perform related operations.

", + "smithy.api#documentation": "

Amazon Route 53 API actions let you register domain names and perform related\n\t\t\toperations.

", "smithy.api#title": "Amazon Route 53 Domains", "smithy.api#xmlNamespace": { "uri": "https://route53domains.amazonaws.com/doc/2014-05-15/" @@ -3718,7 +4779,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -3767,15 +4828,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -4038,9 +5090,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseDualStack": true } }, { @@ -4051,9 +5103,9 @@ } }, "params": { + "UseFIPS": true, "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseDualStack": false } }, { @@ -4064,9 +5116,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseDualStack": true } }, { @@ -4077,9 +5129,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseDualStack": false } }, { @@ -4090,9 +5142,9 @@ } }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -4102,9 +5154,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseFIPS": true, "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -4114,9 +5166,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseFIPS": false, "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, "Endpoint": "https://example.com" } } @@ -4131,14 +5183,14 @@ "Name": { "target": "com.amazonaws.route53domains#ListDomainsAttributeName", "traits": { - "smithy.api#documentation": "

Field to be used for sorting the list of domains. It can be either the name or the expiration for a domain. Note that if \n\t\t\tfilterCondition is used in the same \n\t\t\tListDomains\n\t\t\t call, the field used for sorting has to be the same as the field used for filtering.

", + "smithy.api#documentation": "

Field to be used for sorting the list of domains. It can be either the name or the\n\t\t\texpiration for a domain. Note that if filterCondition is used in the same\n\t\t\t\tListDomains\n\t\t\tcall, the field used for sorting has to be the same as the field used for\n\t\t\tfiltering.

", "smithy.api#required": {} } }, "SortOrder": { "target": "com.amazonaws.route53domains#SortOrder", "traits": { - "smithy.api#documentation": "

The sort order for a list of domains. Either ascending (ASC) or descending (DES).

", + "smithy.api#documentation": "

The sort order for a list of domains. Either ascending (ASC) or descending\n\t\t\t(DES).

", "smithy.api#required": {} } } @@ -4148,18 +5200,20 @@ } }, "com.amazonaws.route53domains#SortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASC", - "name": "ASC" - }, - { - "value": "DESC", - "name": "DESC" + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" } - ] + } } }, "com.amazonaws.route53domains#State": { @@ -4171,6 +5225,41 @@ } } }, + "com.amazonaws.route53domains#StatusFlag": { + "type": "enum", + "members": { + "PENDING_ACCEPTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ACCEPTANCE" + } + }, + "PENDING_CUSTOMER_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CUSTOMER_ACTION" + } + }, + "PENDING_AUTHORIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_AUTHORIZATION" + } + }, + "PENDING_PAYMENT_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_PAYMENT_VERIFICATION" + } + }, + "PENDING_SUPPORT_CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_SUPPORT_CASE" + } + } + } + }, "com.amazonaws.route53domains#String": { "type": "string" }, @@ -4196,13 +5285,13 @@ "Key": { "target": "com.amazonaws.route53domains#TagKey", "traits": { - "smithy.api#documentation": "

The key (name) of a tag.

\n\t\t

Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"

\n\t\t

Constraints: Each key can be 1-128 characters long.

" + "smithy.api#documentation": "

The key (name) of a tag.

\n

Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"

\n

Constraints: Each key can be 1-128 characters long.

" } }, "Value": { "target": "com.amazonaws.route53domains#TagValue", "traits": { - "smithy.api#documentation": "

The value of a tag.

\n\t\t

Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"

\n\t\t

Constraints: Each value can be 0-256 characters long.

" + "smithy.api#documentation": "

The value of a tag.

\n

Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"

\n

Constraints: Each value can be 0-256 characters long.

" } } }, @@ -4247,7 +5336,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 2, "max": 255 } } @@ -4281,7 +5370,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with \n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).

\n\t\t

For more information about transferring domains, see the following topics:

\n\t\t \n\t\t

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you \n\t\t\ttransfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars \n\t\t\tprovide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar \n\t\t\twill not renew your domain registration and could end your DNS service at any time.

\n\t\t\n\t\t\t \n\t\t\t\t

If the registrar for your domain is also the DNS service provider for the domain and you don't \n\t\t\t\t\ttransfer DNS service to another provider, your website, email, and the web applications associated with the domain \n\t\t\t\t\tmight become unavailable.

\n\t\t\t \n\t\t\n\t\t

If the transfer is successful, this method returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

" + "smithy.api#documentation": "

Transfers a domain from another registrar to Amazon Route 53. When the transfer is\n\t\t\tcomplete, the domain is registered either with Amazon Registrar (for .com, .net, and\n\t\t\t.org domains) or with our registrar associate, Gandi (for all other TLDs).

\n

For more information about transferring domains, see the following topics:

\n \n

If the registrar for your domain is also the DNS service provider for the domain, we\n\t\t\thighly recommend that you transfer your DNS service to Route 53 or to another DNS\n\t\t\tservice provider before you transfer your registration. Some registrars provide free DNS\n\t\t\tservice when you purchase a domain registration. When you transfer the registration, the\n\t\t\tprevious registrar will not renew your domain registration and could end your DNS\n\t\t\tservice at any time.

\n \n

If the registrar for your domain is also the DNS service provider for the domain\n\t\t\t\tand you don't transfer DNS service to another provider, your website, email, and the\n\t\t\t\tweb applications associated with the domain might become unavailable.

\n \n

If the transfer is successful, this method returns an operation ID that you can use to\n\t\t\ttrack the progress and completion of the action. If the transfer doesn't complete\n\t\t\tsuccessfully, the domain registrant will be notified by email.

" } }, "com.amazonaws.route53domains#TransferDomainRequest": { @@ -4290,7 +5379,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

The domain name can contain only the following characters:

\n\t\t
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in example.com.

    \n
    • \n
", + "smithy.api#documentation": "

The name of the domain that you want to transfer to Route 53. The top-level domain\n\t\t\t(TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

The domain name can contain only the following characters:

\n
    \n
  • \n

    Letters a through z. Domain names are not case sensitive.

    \n
    • \n
  • \n

    Numbers 0 through 9.

    \n
    • \n
  • \n

    Hyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t

    \n
    • \n
  • \n

    Period (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -4303,7 +5392,7 @@ "DurationInYears": { "target": "com.amazonaws.route53domains#DurationInYears", "traits": { - "smithy.api#documentation": "

The number of years that you want to register the domain for. Domains are registered for a minimum of one year. \n\t\t\tThe maximum period depends on the top-level domain.

\n\t\t

Default: 1

", + "smithy.api#documentation": "

The number of years that you want to register the domain for. Domains are registered\n\t\t\tfor a minimum of one year. The maximum period depends on the top-level domain.

\n

Default: 1

", "smithy.api#required": {} } }, @@ -4316,13 +5405,13 @@ "AuthCode": { "target": "com.amazonaws.route53domains#DomainAuthCode", "traits": { - "smithy.api#documentation": "

The authorization code for the domain. You get this value from the current registrar.

" + "smithy.api#documentation": "

The authorization code for the domain. You get this value from the current\n\t\t\tregistrar.

" } }, "AutoRenew": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect \n\t\t\tafter the account is charged.

\n\t\t

Default: true

" + "smithy.api#documentation": "

Indicates whether the domain will be automatically renewed (true) or not (false). Auto\n\t\t\trenewal only takes effect after the account is charged.

\n

Default: true

" } }, "AdminContact": { @@ -4349,19 +5438,19 @@ "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t \n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" } }, "PrivacyProtectRegistrantContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t \n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" } }, "PrivacyProtectTechContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t \n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" } } }, @@ -4375,8 +5464,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } } }, @@ -4407,7 +5495,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:

\n\t\t \n\t\t\n\t\t \n\t\t\t

When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated \n\t\t\t\twith the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, \n\t\t\t\tso transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see \n\t\t\t\tMigrating a Hosted Zone to a \n\t\t\t\t\tDifferent Amazon Web Services Account in the Amazon Route 53 Developer Guide.

\n\t\t \n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" + "smithy.api#documentation": "

Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:

\n \n \n

When you transfer a domain from one Amazon Web Services account to another, Route\n\t\t\t\t53 doesn't transfer the hosted zone that is associated with the domain. DNS\n\t\t\t\tresolution isn't affected if the domain and the hosted zone are owned by separate\n\t\t\t\taccounts, so transferring the hosted zone is optional. For information about\n\t\t\t\ttransferring the hosted zone to another Amazon Web Services account, see Migrating a\n\t\t\t\t\tHosted Zone to a Different Amazon Web Services Account in the\n\t\t\t\t\tAmazon Route 53 Developer Guide.

\n \n

Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,\n\t\t\t\tDomain Transfer from Aws Account 111122223333 has been cancelled.

" } }, "com.amazonaws.route53domains#TransferDomainToAnotherAwsAccountRequest": { @@ -4423,7 +5511,7 @@ "AccountId": { "target": "com.amazonaws.route53domains#AccountId", "traits": { - "smithy.api#documentation": "

The account ID of the Amazon Web Services account that you want to transfer the domain to, for example, 111122223333.

", + "smithy.api#documentation": "

The account ID of the Amazon Web Services account that you want to transfer the domain\n\t\t\tto, for example, 111122223333.

", "smithy.api#required": {} } } @@ -4438,38 +5526,62 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.

" + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } }, "Password": { "target": "com.amazonaws.route53domains#String", "traits": { - "smithy.api#documentation": "

To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an \n\t\t\tAcceptDomainTransferFromAnotherAwsAccount\n\t\t\trequest. The request must include the value of the Password element that was returned in the \n\t\t\tTransferDomainToAnotherAwsAccount response.

" + "smithy.api#documentation": "

To finish transferring a domain to another Amazon Web Services account, the account\n\t\t\tthat the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include\n\t\t\tthe value of the Password element that was returned in the\n\t\t\t\tTransferDomainToAnotherAwsAccount response.

" } } }, "traits": { - "smithy.api#documentation": "

The TransferDomainToAnotherAwsAccount response includes the following elements.

" + "smithy.api#documentation": "

The TransferDomainToAnotherAwsAccount response includes the following\n\t\t\telements.

" } }, "com.amazonaws.route53domains#Transferable": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Whether the domain name can be transferred to Route 53.

\n\t\t \n

You can transfer only domains that have a value of TRANSFERABLE for Transferable.

\n \n\t\t\n\t\t

Valid values:

\n\t\t
\n
TRANSFERABLE
\n
\n

The domain name can be transferred to Route 53.

\n
\n
UNTRANSFERRABLE
\n
\n

The domain name can't be transferred to Route 53.

\n
\n
DONT_KNOW
\n
\n

Reserved for future use.

\n
\n
", - "smithy.api#enum": [ - { - "value": "TRANSFERABLE", - "name": "TRANSFERABLE" - }, - { - "value": "UNTRANSFERABLE", - "name": "UNTRANSFERABLE" - }, - { - "value": "DONT_KNOW", - "name": "DONT_KNOW" + "type": "enum", + "members": { + "TRANSFERABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFERABLE" + } + }, + "UNTRANSFERABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNTRANSFERABLE" + } + }, + "DONT_KNOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DONT_KNOW" + } + }, + "DOMAIN_IN_OWN_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_IN_OWN_ACCOUNT" + } + }, + "DOMAIN_IN_ANOTHER_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_IN_ANOTHER_ACCOUNT" } - ] + }, + "PREMIUM_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREMIUM_DOMAIN" + } + } + }, + "traits": { + "smithy.api#documentation": "

Whether the domain name can be transferred to Route 53.

\n \n

You can transfer only domains that have a value of TRANSFERABLE or\n\t\t\t\t\tTransferable.

\n \n

Valid values:

\n
\n
TRANSFERABLE
\n
\n

The domain name can be transferred to Route 53.

\n
\n
UNTRANSFERRABLE
\n
\n

The domain name can't be transferred to Route 53.

\n
\n
DONT_KNOW
\n
\n

Reserved for future use.

\n
\n
DOMAIN_IN_OWN_ACCOUNT
\n
\n

The domain already exists in the current Amazon Web Services account.

\n
\n
DOMAIN_IN_ANOTHER_ACCOUNT
\n
\n

the domain exists in another Amazon Web Services account.

\n
\n
PREMIUM_DOMAIN
\n
\n

Premium domain transfer is not supported.

\n
\n
" } }, "com.amazonaws.route53domains#UnsupportedTLD": { @@ -4514,7 +5626,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation updates the contact information for a particular domain. You must specify information for at least one contact: \n\t\t\tregistrant, administrator, or technical.

\n\t\t

If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. \n\t\t\tIf the request is not completed successfully, the domain registrant will be notified by email.

" + "smithy.api#documentation": "

This operation updates the contact information for a particular domain. You must\n\t\t\tspecify information for at least one contact: registrant, administrator, or\n\t\t\ttechnical.

\n

If the update is successful, this method returns an operation ID that you can use to\n\t\t\ttrack the progress and completion of the operation. If the request is not completed\n\t\t\tsuccessfully, the domain registrant will be notified by email.

" } }, "com.amazonaws.route53domains#UpdateDomainContactPrivacy": { @@ -4543,7 +5655,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, \n\t\t\tcontact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org \n\t\t\tdomains) or with contact information for our registrar associate, Gandi.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t \n\t\t

This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). \n\t\t\tIf the request succeeds, Amazon Route 53 returns an operation ID that you can use with \n\t\t\tGetOperationDetail\n\t\t\tto track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.

\n\t\t \n

By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain \n\t\t\tvia the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. \n\t\t\tYou may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the \n\t\t\tRoute 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. \n\t\t\tFor more information on our privacy practices, see \n\t\t\thttps://aws.amazon.com/privacy/.

\n " + "smithy.api#documentation": "

This operation updates the specified domain contact's privacy setting. When privacy\n\t\t\tprotection is enabled, contact information such as email address is replaced either with\n\t\t\tcontact information for Amazon Registrar (for .com, .net, and .org domains) or with\n\t\t\tcontact information for our registrar associate, Gandi.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

This operation affects only the contact information for the specified contact type\n\t\t\t(administrative, registrant, or technical). If the request succeeds, Amazon Route 53\n\t\t\treturns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If\n\t\t\tthe request doesn't complete successfully, the domain registrant will be notified by\n\t\t\temail.

\n \n

By disabling the privacy service via API, you consent to the publication of the\n\t\t\t\tcontact information provided for this domain via the public WHOIS database. You\n\t\t\t\tcertify that you are the registrant of this domain name and have the authority to\n\t\t\t\tmake this decision. You may withdraw your consent at any time by enabling privacy\n\t\t\t\tprotection using either UpdateDomainContactPrivacy or the Route 53\n\t\t\t\tconsole. Enabling privacy protection removes the contact information provided for\n\t\t\t\tthis domain from the WHOIS database. For more information on our privacy practices,\n\t\t\t\tsee https://aws.amazon.com/privacy/.

\n " } }, "com.amazonaws.route53domains#UpdateDomainContactPrivacyRequest": { @@ -4559,19 +5671,19 @@ "AdminPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t " + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n " } }, "RegistrantPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t " + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n " } }, "TechPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t " + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n " } } }, @@ -4585,8 +5697,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To use this ID to query the\n\t\t\toperation status, use GetOperationDetail.

" } } }, @@ -4621,6 +5732,12 @@ "traits": { "smithy.api#documentation": "

Provides detailed contact information.

" } + }, + "Consent": { + "target": "com.amazonaws.route53domains#Consent", + "traits": { + "smithy.api#documentation": "

Customer's consent for the owner change request.

" + } } }, "traits": { @@ -4633,8 +5750,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } } }, @@ -4668,7 +5784,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation replaces the current set of name servers for the domain with the specified set of name servers. \n\t\t\tIf you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

\n\t\t

If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. \n\t\t\tIf the request is not completed successfully, the domain registrant will be notified by email.

" + "smithy.api#documentation": "

This operation replaces the current set of name servers for the domain with the\n\t\t\tspecified set of name servers. If you use Amazon Route 53 as your DNS service, specify\n\t\t\tthe four name servers in the delegation set for the hosted zone for the domain.

\n

If successful, this operation returns an operation ID that you can use to track the\n\t\t\tprogress and completion of the action. If the request is not completed successfully, the\n\t\t\tdomain registrant will be notified by email.

" } }, "com.amazonaws.route53domains#UpdateDomainNameserversRequest": { @@ -4697,7 +5813,7 @@ } }, "traits": { - "smithy.api#documentation": "

Replaces the current set of name servers for the domain with the specified set of name servers. \n\t\t\tIf you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

\n\t\t

If successful, this operation returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" + "smithy.api#documentation": "

Replaces the current set of name servers for the domain with the specified set of name\n\t\t\tservers. If you use Amazon Route 53 as your DNS service, specify the four name servers\n\t\t\tin the delegation set for the hosted zone for the domain.

\n

If successful, this operation returns an operation ID that you can use to track the\n\t\t\tprogress and completion of the action. If the request is not completed successfully, the\n\t\t\tdomain registrant will be notified by email.

" } }, "com.amazonaws.route53domains#UpdateDomainNameserversResponse": { @@ -4706,8 +5822,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.

" } } }, @@ -4735,7 +5850,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation adds or updates tags for a specified domain.

\n\t\t

All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

" + "smithy.api#documentation": "

This operation adds or updates tags for a specified domain.

\n

All tag operations are eventually consistent; subsequent operations might not\n\t\t\timmediately represent all issued operations.

" } }, "com.amazonaws.route53domains#UpdateTagsForDomainRequest": { @@ -4751,7 +5866,7 @@ "TagsToUpdate": { "target": "com.amazonaws.route53domains#TagList", "traits": { - "smithy.api#documentation": "

A list of the tag keys and values that you want to add or update. If you specify a key \n\t\t\tthat already exists, the corresponding value will be replaced.

" + "smithy.api#documentation": "

A list of the tag keys and values that you want to add or update. If you specify a key\n\t\t\tthat already exists, the corresponding value will be replaced.

" } } }, @@ -4813,25 +5928,25 @@ "Start": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

The beginning date and time for the time period for which you want a list of billing records. Specify the date and time \n\t\t\tin Unix time format and Coordinated Universal time (UTC).

" + "smithy.api#documentation": "

The beginning date and time for the time period for which you want a list of billing\n\t\t\trecords. Specify the date and time in Unix time format and Coordinated Universal time\n\t\t\t(UTC).

" } }, "End": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "

The end date and time for the time period for which you want a list of billing records. Specify the date and time \n\t\t\tin Unix time format and Coordinated Universal time (UTC).

" + "smithy.api#documentation": "

The end date and time for the time period for which you want a list of billing\n\t\t\trecords. Specify the date and time in Unix time format and Coordinated Universal time\n\t\t\t(UTC).

" } }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

For an initial request for a list of billing records, omit this element. If the number of billing records \n\t\t\tthat are associated with the current Amazon Web Services account during the specified period is greater than the value that \n\t\t\tyou specified for MaxItems, you can use Marker to return additional billing records. \n\t\t\tGet the value of NextPageMarker from the previous response, and submit another request that includes \n\t\t\tthe value of NextPageMarker in the Marker element.\n\t\t

\n\t\t

Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.

" + "smithy.api#documentation": "

For an initial request for a list of billing records, omit this element. If the number\n\t\t\tof billing records that are associated with the current Amazon Web Services account\n\t\t\tduring the specified period is greater than the value that you specified for\n\t\t\t\tMaxItems, you can use Marker to return additional billing\n\t\t\trecords. Get the value of NextPageMarker from the previous response, and\n\t\t\tsubmit another request that includes the value of NextPageMarker in the\n\t\t\t\tMarker element.

\n

Constraints: The marker must match the value of NextPageMarker that was\n\t\t\treturned in the previous response.

" } }, "MaxItems": { "target": "com.amazonaws.route53domains#PageMaxItems", "traits": { - "smithy.api#documentation": "

The number of billing records to be returned.

\n\t\t

Default: 20

" + "smithy.api#documentation": "

The number of billing records to be returned.

\n

Default: 20

" } } }, @@ -4845,7 +5960,7 @@ "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

If there are more billing records than you specified for MaxItems in the request, submit another \n\t\t\trequest and include the value of NextPageMarker in the value of Marker.

" + "smithy.api#documentation": "

If there are more billing records than you specified for MaxItems in the\n\t\t\trequest, submit another request and include the value of NextPageMarker in\n\t\t\tthe value of Marker.

" } }, "BillingRecords": { diff --git a/codegen/sdk-codegen/aws-models/rum.2018-05-10.json b/codegen/sdk-codegen/aws-models/rum.2018-05-10.json index cedee74aa05..73425a00abd 100644 --- a/codegen/sdk-codegen/aws-models/rum.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/rum.2018-05-10.json @@ -3415,4 +3415,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/sagemaker-featurestore-runtime.2020-07-01.json b/codegen/sdk-codegen/aws-models/sagemaker-featurestore-runtime.2020-07-01.json index 5be10a78aeb..b3f126b13e2 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker-featurestore-runtime.2020-07-01.json +++ b/codegen/sdk-codegen/aws-models/sagemaker-featurestore-runtime.2020-07-01.json @@ -78,7 +78,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -392,9 +392,9 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, "UseFIPS": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -404,9 +404,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": false, "UseFIPS": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -416,9 +416,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": true, "UseFIPS": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -478,7 +478,7 @@ "ErrorCode": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#ValueAsString", "traits": { - "smithy.api#documentation": "

The error code of an error that has occured when attempting to retrieve a batch of Records. For more information on errors, see Errors.

", + "smithy.api#documentation": "

The error code of an error that has occured when attempting to retrieve a batch of\n Records. For more information on errors, see Errors.

", "smithy.api#required": {} } }, @@ -570,7 +570,7 @@ "Errors": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#BatchGetRecordErrors", "traits": { - "smithy.api#documentation": "

A list of errors that have occured when retrieving a batch of Records.

", + "smithy.api#documentation": "

A list of errors that have occurred when retrieving a batch of Records.

", "smithy.api#required": {} } }, @@ -646,7 +646,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Record from a FeatureGroup. A new record will show\n up in the OfflineStore when the DeleteRecord API is called. This\n record will have a value of True in the is_deleted column.

", + "smithy.api#documentation": "

Deletes a Record from a FeatureGroup. When the DeleteRecord API is called a new record will be added to the OfflineStore and the Record will be removed from the OnlineStore. This\n record will have a value of True in the is_deleted column.

", "smithy.api#http": { "method": "DELETE", "uri": "/FeatureGroup/{FeatureGroupName}", @@ -680,6 +680,13 @@ "smithy.api#httpQuery": "EventTime", "smithy.api#required": {} } + }, + "TargetStores": { + "target": "com.amazonaws.sagemakerfeaturestoreruntime#TargetStores", + "traits": { + "smithy.api#documentation": "

A list of stores from which you're deleting the record. By default, Feature Store deletes the record from all of the stores that you're using for the FeatureGroup.

", + "smithy.api#httpQuery": "TargetStores" + } } } }, @@ -690,7 +697,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" } }, "com.amazonaws.sagemakerfeaturestoreruntime#FeatureName": { @@ -700,7 +707,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9])*$" + "smithy.api#pattern": "^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}$" } }, "com.amazonaws.sagemakerfeaturestoreruntime#FeatureNames": { @@ -776,7 +783,7 @@ "FeatureGroupName": { "target": "com.amazonaws.sagemakerfeaturestoreruntime#FeatureGroupName", "traits": { - "smithy.api#documentation": "

The name of the feature group in which you want to put the records.

", + "smithy.api#documentation": "

The name of the feature group from which you want to retrieve a record.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -817,7 +824,7 @@ } }, "traits": { - "smithy.api#documentation": "

An internal failure occurred. Try your request again. If the problem \n persists, contact AWS customer support.

", + "smithy.api#documentation": "

An internal failure occurred. Try your request again. If the problem \n persists, contact Amazon Web Services customer support.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -879,6 +886,12 @@ "smithy.api#documentation": "

List of FeatureValues to be inserted. This will be a full over-write. If you only want\n to update few of the feature values, do the following:

\n
    \n
  • \n

    Use GetRecord to retrieve the latest record.

    \n
    • \n
  • \n

    Update the record returned from GetRecord.

    \n
    • \n
  • \n

    Use PutRecord to update feature values.

    \n
    • \n
", "smithy.api#required": {} } + }, + "TargetStores": { + "target": "com.amazonaws.sagemakerfeaturestoreruntime#TargetStores", + "traits": { + "smithy.api#documentation": "

A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the FeatureGroup.

" + } } } }, @@ -931,6 +944,35 @@ "smithy.api#httpError": 503 } }, + "com.amazonaws.sagemakerfeaturestoreruntime#TargetStore": { + "type": "enum", + "members": { + "ONLINE_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnlineStore" + } + }, + "OFFLINE_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OfflineStore" + } + } + } + }, + "com.amazonaws.sagemakerfeaturestoreruntime#TargetStores": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemakerfeaturestoreruntime#TargetStore" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.sagemakerfeaturestoreruntime#UnprocessedIdentifiers": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker-geospatial.2020-05-27.json b/codegen/sdk-codegen/aws-models/sagemaker-geospatial.2020-05-27.json index f03d66271cd..25d0b5d8c8d 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker-geospatial.2020-05-27.json +++ b/codegen/sdk-codegen/aws-models/sagemaker-geospatial.2020-05-27.json @@ -5132,4 +5132,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/sagemaker-metrics.2022-09-30.json b/codegen/sdk-codegen/aws-models/sagemaker-metrics.2022-09-30.json new file mode 100644 index 00000000000..b9df50f7926 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/sagemaker-metrics.2022-09-30.json @@ -0,0 +1,852 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.sagemakermetrics#BatchPutMetrics": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsRequest" + }, + "output": { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsResponse" + }, + "traits": { + "smithy.api#documentation": "

Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and\n retrieved with the GetMetrics API.\n

", + "smithy.api#http": { + "method": "PUT", + "uri": "/BatchPutMetrics", + "code": 200 + } + } + }, + "com.amazonaws.sagemakermetrics#BatchPutMetricsError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.sagemakermetrics#PutMetricsErrorCode", + "traits": { + "smithy.api#documentation": "

The error code of an error that occured when attempting to put metrics.

\n
    \n
  • \n

    \n METRIC_LIMIT_EXCEEDED: The maximum amount of metrics per resource is\n exceeded.

    \n
    • \n
  • \n

    \n INTERNAL_ERROR: An internal error occured.

    \n
    • \n
  • \n

    \n VALIDATION_ERROR: The metric data failed validation.

    \n
    • \n
  • \n

    \n CONFLICT_ERROR: Multiple requests attempted to modify the same data\n simultaneously.

    \n
    • \n
" + } + }, + "MetricIndex": { + "target": "com.amazonaws.sagemakermetrics#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An index that corresponds to the metric in the request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An error that occured when putting the metric data.

" + } + }, + "com.amazonaws.sagemakermetrics#BatchPutMetricsErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsError" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemakermetrics#BatchPutMetricsRequest": { + "type": "structure", + "members": { + "TrialComponentName": { + "target": "com.amazonaws.sagemakermetrics#ExperimentEntityName", + "traits": { + "smithy.api#documentation": "

The name of the Trial Component to associate with the metrics.

", + "smithy.api#required": {} + } + }, + "MetricData": { + "target": "com.amazonaws.sagemakermetrics#RawMetricDataList", + "traits": { + "smithy.api#documentation": "

A list of raw metric values to put.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sagemakermetrics#BatchPutMetricsResponse": { + "type": "structure", + "members": { + "Errors": { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsErrorList", + "traits": { + "smithy.api#documentation": "

Lists any errors that occur when inserting metric data.

" + } + } + } + }, + "com.amazonaws.sagemakermetrics#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sagemakermetrics#ExperimentEntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 120 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$" + } + }, + "com.amazonaws.sagemakermetrics#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sagemakermetrics#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemakermetrics#PutMetricsErrorCode": { + "type": "enum", + "members": { + "METRIC_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METRIC_LIMIT_EXCEEDED" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_ERROR" + } + }, + "CONFLICT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT_ERROR" + } + } + } + }, + "com.amazonaws.sagemakermetrics#RawMetricData": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemakermetrics#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric.

", + "smithy.api#required": {} + } + }, + "Timestamp": { + "target": "com.amazonaws.sagemakermetrics#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the metric was recorded.

", + "smithy.api#required": {} + } + }, + "Step": { + "target": "com.amazonaws.sagemakermetrics#Step", + "traits": { + "smithy.api#documentation": "

The metric step (epoch).\n

" + } + }, + "Value": { + "target": "com.amazonaws.sagemakermetrics#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The metric value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The raw metric data to associate with the resource.

" + } + }, + "com.amazonaws.sagemakermetrics#RawMetricDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemakermetrics#RawMetricData" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sagemakermetrics#SageMakerMetricsService": { + "type": "service", + "version": "2022-09-30", + "operations": [ + { + "target": "com.amazonaws.sagemakermetrics#BatchPutMetrics" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SageMaker Metrics", + "arnNamespace": "sagemaker", + "cloudFormationName": "SageMakerMetrics", + "cloudTrailEventSource": "sagemakermetrics.amazonaws.com", + "endpointPrefix": "metrics.sagemaker" + }, + "aws.auth#sigv4": { + "name": "sagemaker" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Contains all data plane API operations and data types for Amazon SageMaker Metrics. \n Use these APIs to put and retrieve (get) features related to your training run.

\n ", + "smithy.api#title": "Amazon SageMaker Metrics Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.sagemakermetrics#Step": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.sagemakermetrics#Timestamp": { + "type": "timestamp" + } + } +} diff --git a/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json b/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json index 6746f41d9b6..06b5b8794f7 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json @@ -250,7 +250,7 @@ "target": "com.amazonaws.sagemaker#AddTagsOutput" }, "traits": { - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.

\n " + "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.

\n " } }, "com.amazonaws.sagemaker#AddTagsInput": { @@ -467,13 +467,13 @@ "TrainingImage": { "target": "com.amazonaws.sagemaker#AlgorithmImage", "traits": { - "smithy.api#documentation": "

The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry\n Paths and Example Code in the Amazon SageMaker developer guide.\n SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information\n about using your custom training container, see Using Your Own Algorithms with\n Amazon SageMaker.

\n \n

You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.

\n

For more information, see the note in the AlgorithmName parameter\n description.

\n " + "smithy.api#documentation": "

The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry\n Paths and Example Code in the Amazon SageMaker developer guide.\n SageMaker supports both registry/repository[:tag] and\n registry/repository[@digest] image path formats. For more information\n about using your custom training container, see Using Your Own Algorithms with\n Amazon SageMaker.

\n \n

You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.

\n

For more information, see the note in the AlgorithmName parameter\n description.

\n " } }, "AlgorithmName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "

The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services\n Marketplace.

\n \n

You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.

\n

Note that the AlgorithmName parameter is mutually exclusive with the\n TrainingImage parameter. If you specify a value for the\n AlgorithmName parameter, you can't specify a value for\n TrainingImage, and vice versa.

\n

If you specify values for both parameters, the training job might break; if you\n don't specify any value for both parameters, the training job might raise a\n null error.

\n " + "smithy.api#documentation": "

The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services\n Marketplace.

\n \n

You must specify either the algorithm name to the AlgorithmName\n parameter or the image URI of the algorithm container to the\n TrainingImage parameter.

\n

Note that the AlgorithmName parameter is mutually exclusive with the\n TrainingImage parameter. If you specify a value for the\n AlgorithmName parameter, you can't specify a value for\n TrainingImage, and vice versa.

\n

If you specify values for both parameters, the training job might break; if you\n don't specify any value for both parameters, the training job might raise a\n null error.

\n " } }, "TrainingInputMode": { @@ -492,7 +492,7 @@ "target": "com.amazonaws.sagemaker#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:

\n
    \n
  • \n

    You use one of the SageMaker built-in algorithms

    \n
    • \n
  • \n

    You use one of the following Prebuilt SageMaker Docker Images:

    \n
      \n
    • \n

      Tensorflow (version >= 1.15)

      \n
      • \n
    • \n

      MXNet (version >= 1.6)

      \n
      • \n
    • \n

      PyTorch (version >= 1.3)

      \n
      • \n
    \n
    • \n
  • \n

    You specify at least one MetricDefinition\n

    \n
    • \n
" + "smithy.api#documentation": "

To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:

\n
    \n
  • \n

    You use one of the SageMaker built-in algorithms

    \n
    • \n
  • \n

    You use one of the following Prebuilt SageMaker Docker Images:

    \n
      \n
    • \n

      Tensorflow (version >= 1.15)

      \n
      • \n
    • \n

      MXNet (version >= 1.6)

      \n
      • \n
    • \n

      PyTorch (version >= 1.3)

      \n
      • \n
    \n
    • \n
  • \n

    You specify at least one MetricDefinition\n

    \n
    • \n
" } }, "ContainerEntrypoint": { @@ -509,7 +509,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the training algorithm to use in a CreateTrainingJob\n request.

\n

For more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with Amazon\n SageMaker.

" + "smithy.api#documentation": "

Specifies the training algorithm to use in a CreateTrainingJob\n request.

\n

For more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with Amazon\n SageMaker.

" } }, "com.amazonaws.sagemaker#AlgorithmStatus": { @@ -674,7 +674,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.

" + "smithy.api#documentation": "

Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.

" } }, "com.amazonaws.sagemaker#AlgorithmValidationProfiles": { @@ -717,7 +717,7 @@ "AnnotationConsolidationLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

\n

This parameter is required for all labeling jobs. For built-in task types, use one\n of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n AnnotationConsolidationLambdaArn. For custom labeling workflows, see\n Post-annotation Lambda.

\n\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image\n as a multi-class classification and treats pixel annotations from workers as \"votes\" for\n the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections\n and calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition\n

    \n
    • \n
\n \n \n \n \n \n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking\n

    \n
    • \n
\n \n \n

\n 3D Point Cloud Object Detection - Use this task type\n when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids\n around objects. For example, you can use this task type to ask workers to identify\n different types of objects in a point cloud, such as cars, bikes, and\n pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - Use this task type\n when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D\n point cloud frames. For example, you can use this task type to ask workers to track the\n movement of vehicles across multiple point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - Use this task\n type when you want workers to create a point-level semantic segmentation masks by\n painting objects in a 3D point cloud using different colors where each color is assigned\n to one of the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n \n \n\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n \n

\n Semantic Segmentation Adjustment - Treats each pixel\n in an image as a multi-class classification and treats pixel adjusted annotations from\n workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n \n

\n Semantic Segmentation Verification - Uses a variant\n of the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
\n \n

\n Bounding Box Adjustment - Finds the most similar\n boxes from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Bounding Box Verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification judgement\n for bounding box labels based on annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox\n

    \n
    • \n
\n \n \n \n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n \n \n \n

\n 3D Point Cloud Object Detection Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects that appear in a\n sequence of 3D point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation Adjustment - Use this task\n type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

\n

This parameter is required for all labeling jobs. For built-in task types, use one\n of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n AnnotationConsolidationLambdaArn. For custom labeling workflows, see\n Post-annotation Lambda.

\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image\n as a multi-class classification and treats pixel annotations from workers as \"votes\" for\n the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections\n and calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition\n

    \n
    • \n
\n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Object Detection - Use this task type\n when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids\n around objects. For example, you can use this task type to ask workers to identify\n different types of objects in a point cloud, such as cars, bikes, and\n pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - Use this task type\n when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D\n point cloud frames. For example, you can use this task type to ask workers to track the\n movement of vehicles across multiple point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - Use this task\n type when you want workers to create a point-level semantic segmentation masks by\n painting objects in a 3D point cloud using different colors where each color is assigned\n to one of the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n

\n Semantic Segmentation Adjustment - Treats each pixel\n in an image as a multi-class classification and treats pixel adjusted annotations from\n workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n

\n Semantic Segmentation Verification - Uses a variant\n of the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
\n

\n Bounding Box Adjustment - Finds the most similar\n boxes from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Bounding Box Verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification judgement\n for bounding box labels based on annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox\n

    \n
    • \n
\n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Object Detection Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects that appear in a\n sequence of 3D point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation Adjustment - Use this task\n type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
", "smithy.api#required": {} } } @@ -1786,7 +1786,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the asynchronous inference output in Amazon S3.

\n

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the asynchronous inference output in Amazon S3.

\n

" } }, "S3OutputPath": { @@ -2394,7 +2394,7 @@ "MetricName": { "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", "traits": { - "smithy.api#documentation": "

The name of the objective metric used to measure the predictive quality of a machine\n learning system. This metric is optimized during training to provide the best estimate for\n model parameter values from data.

\n

Here are the options:

\n
    \n
  • \n

    \n MSE: The mean squared error (MSE) is the average of the squared\n differences between the predicted and actual values. It is used for regression. MSE\n values are always positive: the better a model is at predicting the actual values,\n the smaller the MSE value is. When the data contains outliers, they tend to dominate\n the MSE, which might cause subpar prediction performance.

    \n
    • \n
  • \n

    \n Accuracy: The ratio of the number of correctly classified items to\n the total number of (correctly and incorrectly) classified items. It is used for\n binary and multiclass classification. It measures how close the predicted class\n values are to the actual values. Accuracy values vary between zero and one: one\n indicates perfect accuracy and zero indicates perfect inaccuracy.

    \n
    • \n
  • \n

    \n F1: The F1 score is the harmonic mean of the precision and recall. It\n is used for binary classification into classes traditionally referred to as positive\n and negative. Predictions are said to be true when they match their actual (correct)\n class and false when they do not. Precision is the ratio of the true positive\n predictions to all positive predictions (including the false positives) in a data set\n and measures the quality of the prediction when it predicts the positive class.\n Recall (or sensitivity) is the ratio of the true positive predictions to all actual\n positive instances and measures how completely a model predicts the actual class\n members in a data set. The standard F1 score weighs precision and recall equally. But\n which metric is paramount typically depends on specific aspects of a problem. F1\n scores vary between zero and one: one indicates the best possible performance and\n zero the worst.

    \n
    • \n
  • \n

    \n AUC: The area under the curve (AUC) metric is used to compare and\n evaluate binary classification by algorithms such as logistic regression that return\n probabilities. A threshold is needed to map the probabilities into classifications.\n The relevant curve is the receiver operating characteristic curve that plots the true\n positive rate (TPR) of predictions (or recall) against the false positive rate (FPR)\n as a function of the threshold value, above which a prediction is considered\n positive. Increasing the threshold results in fewer false positives but more false\n negatives. AUC is the area under this receiver operating characteristic curve and so\n provides an aggregated measure of the model performance across all possible\n classification thresholds. The AUC score can also be interpreted as the probability\n that a randomly selected positive data point is more likely to be predicted positive\n than a randomly selected negative example. AUC scores vary between zero and one: a\n score of one indicates perfect accuracy and a score of one half indicates that the\n prediction is not better than a random classifier. Values under one half predict less\n accurately than a random predictor. But such consistently bad predictors can simply\n be inverted to obtain better than random predictors.

    \n
    • \n
  • \n

    \n F1macro: The F1macro score applies F1 scoring to multiclass\n classification. In this context, you have multiple classes to predict. You just\n calculate the precision and recall for each class as you did for the positive class\n in binary classification. Then, use these values to calculate the F1 score for each\n class and average them to obtain the F1macro score. F1macro scores vary between zero\n and one: one indicates the best possible performance and zero the worst.

    \n
    • \n
\n

If you do not specify a metric explicitly, the default behavior is to automatically\n use:

\n
    \n
  • \n

    \n MSE: for regression.

    \n
    • \n
  • \n

    \n F1: for binary classification

    \n
    • \n
  • \n

    \n Accuracy: for multiclass classification.

    \n
    • \n
", + "smithy.api#documentation": "

The name of the objective metric used to measure the predictive quality of a machine\n learning system. This metric is optimized during training to provide the best estimate for\n model parameter values from data.

\n

Here are the options:

\n
\n
Accuracy
\n
\n

The ratio of the number of correctly classified items to the total number of\n (correctly and incorrectly) classified items. It is used for both binary and\n multiclass classification. Accuracy measures how close the predicted class values\n are to the actual values. Values for accuracy metrics vary between zero (0) and\n one (1). A value of 1 indicates perfect accuracy, and 0 indicates perfect\n inaccuracy.

\n
\n
AUC
\n
\n

The area under the curve (AUC) metric is used to compare and evaluate binary\n classification by algorithms that return probabilities, such as logistic\n regression. To map the probabilities into classifications, these are compared\n against a threshold value.

\n

The relevant curve is the receiver operating characteristic curve (ROC curve).\n The ROC curve plots the true positive rate (TPR) of predictions (or recall)\n against the false positive rate (FPR) as a function of the threshold value, above\n which a prediction is considered positive. Increasing the threshold results in\n fewer false positives, but more false negatives.

\n

AUC is the area under this ROC curve. Therefore, AUC provides an aggregated\n measure of the model performance across all possible classification thresholds.\n AUC scores vary between 0 and 1. A score of 1 indicates perfect accuracy, and a\n score of one half (0.5) indicates that the prediction is not better than a random\n classifier.

\n
\n
BalancedAccuracy
\n
\n

\n BalancedAccuracy is a metric that measures the ratio of accurate\n predictions to all predictions. This ratio is calculated after normalizing true\n positives (TP) and true negatives (TN) by the total number of positive (P) and\n negative (N) values. It is used in both binary and multiclass classification and\n is defined as follows: 0.5*((TP/P)+(TN/N)), with values ranging from 0 to 1.\n BalancedAccuracy gives a better measure of accuracy when the\n number of positives or negatives differ greatly from each other in an imbalanced\n dataset. For example, when only 1% of email is spam.

\n
\n
F1
\n
\n

The F1 score is the harmonic mean of the precision and recall,\n defined as follows: F1 = 2 * (precision * recall) / (precision + recall). It is\n used for binary classification into classes traditionally referred to as positive\n and negative. Predictions are said to be true when they match their actual\n (correct) class, and false when they do not.

\n

Precision is the ratio of the true positive predictions to all positive\n predictions, and it includes the false positives in a dataset. Precision measures\n the quality of the prediction when it predicts the positive class.

\n

Recall (or sensitivity) is the ratio of the true positive predictions to all\n actual positive instances. Recall measures how completely a model predicts the\n actual class members in a dataset.

\n

F1 scores vary between 0 and 1. A score of 1 indicates the best possible\n performance, and 0 indicates the worst.

\n
\n
F1macro
\n
\n

The F1macro score applies F1 scoring to multiclass classification\n problems. It does this by calculating the precision and recall, and then taking\n their harmonic mean to calculate the F1 score for each class. Lastly, the F1macro\n averages the individual scores to obtain the F1macro score.\n F1macro scores vary between 0 and 1. A score of 1 indicates the\n best possible performance, and 0 indicates the worst.

\n
\n
MAE
\n
\n

The mean absolute error (MAE) is a measure of how different the predicted and\n actual values are, when they're averaged over all values. MAE is commonly used in\n regression analysis to understand model prediction error. If there is linear\n regression, MAE represents the average distance from a predicted line to the\n actual value. MAE is defined as the sum of absolute errors divided by the number\n of observations. Values range from 0 to infinity, with smaller numbers indicating\n a better model fit to the data.

\n
\n
MSE
\n
\n

The mean squared error (MSE) is the average of the squared differences between\n the predicted and actual values. It is used for regression. MSE values are always\n positive. The better a model is at predicting the actual values, the smaller the\n MSE value is

\n
\n
Precision
\n
\n

Precision measures how well an algorithm predicts the true positives (TP) out\n of all of the positives that it identifies. It is defined as follows: Precision =\n TP/(TP+FP), with values ranging from zero (0) to one (1), and is used in binary\n classification. Precision is an important metric when the cost of a false positive\n is high. For example, the cost of a false positive is very high if an airplane\n safety system is falsely deemed safe to fly. A false positive (FP) reflects a\n positive prediction that is actually negative in the data.

\n
\n
PrecisionMacro
\n
\n

The precision macro computes precision for multiclass classification problems.\n It does this by calculating precision for each class and averaging scores to\n obtain precision for several classes. PrecisionMacro scores range\n from zero (0) to one (1). Higher scores reflect the model's ability to predict\n true positives (TP) out of all of the positives that it identifies, averaged\n across multiple classes.

\n
\n
R2
\n
\n

R2, also known as the coefficient of determination, is used in regression to\n quantify how much a model can explain the variance of a dependent variable. Values\n range from one (1) to negative one (-1). Higher numbers indicate a higher fraction\n of explained variability. R2 values close to zero (0) indicate that\n very little of the dependent variable can be explained by the model. Negative\n values indicate a poor fit and that the model is outperformed by a constant\n function. For linear regression, this is a horizontal line.

\n
\n
Recall
\n
\n

Recall measures how well an algorithm correctly predicts all of the true\n positives (TP) in a dataset. A true positive is a positive prediction that is also\n an actual positive value in the data. Recall is defined as follows: Recall =\n TP/(TP+FN), with values ranging from 0 to 1. Higher scores reflect a better\n ability of the model to predict true positives (TP) in the data, and is used in\n binary classification.

\n

Recall is important when testing for cancer because it's used to find all of\n the true positives. A false positive (FP) reflects a positive prediction that is\n actually negative in the data. It is often insufficient to measure only recall,\n because predicting every output as a true positive will yield a perfect recall\n score.

\n
\n
RecallMacro
\n
\n

The RecallMacro computes recall for multiclass classification problems by\n calculating recall for each class and averaging scores to obtain recall for\n several classes. RecallMacro scores range from 0 to 1. Higher scores reflect the\n model's ability to predict true positives (TP) in a dataset. Whereas, a true\n positive reflects a positive prediction that is also an actual positive value in\n the data. It is often insufficient to measure only recall, because predicting\n every output as a true positive will yield a perfect recall score.

\n
\n
RMSE
\n
\n

Root mean squared error (RMSE) measures the square root of the squared\n difference between predicted and actual values, and it's averaged over all values.\n It is used in regression analysis to understand model prediction error. It's an\n important metric to indicate the presence of large model errors and outliers.\n Values range from zero (0) to infinity, with smaller numbers indicating a better\n model fit to the data. RMSE is dependent on scale, and should not be used to\n compare datasets of different sizes.

\n
\n
\n

If you do not specify a metric explicitly, the default behavior is to automatically\n use:

\n
    \n
  • \n

    \n MSE: for regression.

    \n
    • \n
  • \n

    \n F1: for binary classification

    \n
    • \n
  • \n

    \n Accuracy: for multiclass classification.

    \n
    • \n
", "smithy.api#required": {} } } @@ -2692,6 +2692,54 @@ "traits": { "smithy.api#enumValue": "AUC" } + }, + "RMSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RMSE" + } + }, + "MAE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAE" + } + }, + "R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "R2" + } + }, + "BALANCED_ACCURACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BalancedAccuracy" + } + }, + "PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Precision" + } + }, + "PRECISION_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PrecisionMacro" + } + }, + "RECALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Recall" + } + }, + "RECALL_MACRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecallMacro" + } } } }, @@ -3020,7 +3068,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the batch transform job.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the batch transform job.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" } }, "GenerateInferenceId": { @@ -3608,7 +3656,7 @@ "Type": { "target": "com.amazonaws.sagemaker#CapacitySizeType", "traits": { - "smithy.api#documentation": "

Specifies the endpoint capacity type.

\n
    \n
  • \n

    \n INSTANCE_COUNT: The endpoint activates based on the number of\n instances.

    \n
    • \n
  • \n

    \n CAPACITY_PERCENT: The endpoint activates based on the specified\n percentage of capacity.

    \n
    • \n
", + "smithy.api#documentation": "

Specifies the endpoint capacity type.

\n
    \n
  • \n

    \n INSTANCE_COUNT: The endpoint activates based on the number of\n instances.

    \n
    • \n
  • \n

    \n CAPACITY_PERCENT: The endpoint activates based on the specified\n percentage of capacity.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -3883,19 +3931,19 @@ "RecordWrapperType": { "target": "com.amazonaws.sagemaker#RecordWrapper", "traits": { - "smithy.api#documentation": "

\n

Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.

\n

In File mode, leave this field unset or set it to None.

" + "smithy.api#documentation": "

\n

Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.

\n

In File mode, leave this field unset or set it to None.

" } }, "InputMode": { "target": "com.amazonaws.sagemaker#TrainingInputMode", "traits": { - "smithy.api#documentation": "

(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification\n request when you have a channel that needs a different input mode from the training\n job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML\n storage volume, and mount the directory to a Docker volume, use File input\n mode. To stream data directly from Amazon S3 to the container, choose Pipe input\n mode.

\n

To use a model for incremental training, choose File input model.

" + "smithy.api#documentation": "

(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification\n request when you have a channel that needs a different input mode from the training\n job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML\n storage volume, and mount the directory to a Docker volume, use File input\n mode. To stream data directly from Amazon S3 to the container, choose Pipe input\n mode.

\n

To use a model for incremental training, choose File input model.

" } }, "ShuffleConfig": { "target": "com.amazonaws.sagemaker#ShuffleConfig", "traits": { - "smithy.api#documentation": "

A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, this shuffles the results of the\n S3 key prefix matches. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.

\n

For Pipe input mode, shuffling is done at the start of every epoch. With large\n datasets this ensures that the order of the training data is different for each epoch,\n it helps reduce bias and possible overfitting. In a multi-node training job when\n ShuffleConfig is combined with S3DataDistributionType of\n ShardedByS3Key, the data is shuffled across nodes so that the content\n sent to a particular node on the first epoch might be sent to a different node on the\n second epoch.

" + "smithy.api#documentation": "

A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, this shuffles the results of the\n S3 key prefix matches. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.

\n

For Pipe input mode, shuffling is done at the start of every epoch. With large\n datasets this ensures that the order of the training data is different for each epoch,\n it helps reduce bias and possible overfitting. In a multi-node training job when\n ShuffleConfig is combined with S3DataDistributionType of\n ShardedByS3Key, the data is shuffled across nodes so that the content\n sent to a particular node on the first epoch might be sent to a different node on the\n second epoch.

" } } }, @@ -3952,7 +4000,7 @@ "SupportedInputModes": { "target": "com.amazonaws.sagemaker#InputModes", "traits": { - "smithy.api#documentation": "

The allowed input mode, either FILE or PIPE.

\n

In FILE mode, Amazon SageMaker copies the data from the input source onto the local\n Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm.\n This is the most commonly used input mode.

\n

In PIPE mode, Amazon SageMaker streams input data from the source directly to your\n algorithm without using the EBS volume.

", + "smithy.api#documentation": "

The allowed input mode, either FILE or PIPE.

\n

In FILE mode, Amazon SageMaker copies the data from the input source onto the local\n Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm.\n This is the most commonly used input mode.

\n

In PIPE mode, Amazon SageMaker streams input data from the source directly to your\n algorithm without using the EBS volume.

", "smithy.api#required": {} } } @@ -4094,7 +4142,7 @@ "EnableExplanations": { "target": "com.amazonaws.sagemaker#ClarifyEnableExplanations", "traits": { - "smithy.api#documentation": "

A JMESPath boolean expression used to filter which records to explain. Explanations\n are activated by default. See \n EnableExplanations\n for additional information.

" + "smithy.api#documentation": "

A JMESPath boolean expression used to filter which records to explain. Explanations\n are activated by default. See \n EnableExplanations\n for additional information.

" } }, "InferenceConfig": { @@ -4212,25 +4260,25 @@ "ProbabilityIndex": { "target": "com.amazonaws.sagemaker#ClarifyProbabilityIndex", "traits": { - "smithy.api#documentation": "

A zero-based index used to extract a probability value (score) or list from model\n container output in CSV format. If this value is not provided, the entire model\n container output will be treated as a probability value (score) or list.

\n

\n Example for a single class model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '1,0.6', set ProbabilityIndex to 1\n to select the probability value 0.6.

\n

\n Example for a multiclass model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n ProbabilityIndex to 1 to select the probability values\n [0.1,0.6,0.3].

" + "smithy.api#documentation": "

A zero-based index used to extract a probability value (score) or list from model\n container output in CSV format. If this value is not provided, the entire model\n container output will be treated as a probability value (score) or list.

\n

\n Example for a single class model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '1,0.6', set ProbabilityIndex to 1\n to select the probability value 0.6.

\n

\n Example for a multiclass model: If the model\n container output consists of a string-formatted prediction label followed by its\n probability: '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n ProbabilityIndex to 1 to select the probability values\n [0.1,0.6,0.3].

" } }, "LabelIndex": { "target": "com.amazonaws.sagemaker#ClarifyLabelIndex", "traits": { - "smithy.api#documentation": "

A zero-based index used to extract a label header or list of label headers from model\n container output in CSV format.

\n

\n Example for a multiclass model: If the model\n container output consists of label headers followed by probabilities:\n '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n LabelIndex to 0 to select the label headers\n ['cat','dog','fish'].

" + "smithy.api#documentation": "

A zero-based index used to extract a label header or list of label headers from model\n container output in CSV format.

\n

\n Example for a multiclass model: If the model\n container output consists of label headers followed by probabilities:\n '\"[\\'cat\\',\\'dog\\',\\'fish\\']\",\"[0.1,0.6,0.3]\"', set\n LabelIndex to 0 to select the label headers\n ['cat','dog','fish'].

" } }, "ProbabilityAttribute": { "target": "com.amazonaws.sagemaker#ClarifyProbabilityAttribute", "traits": { - "smithy.api#documentation": "

A JMESPath expression used to extract the probability (or score) from the model\n container output if the model container is in JSON Lines format.

\n

\n Example: If the model container output of a single\n request is '{\"predicted_label\":1,\"probability\":0.6}', then set\n ProbabilityAttribute to 'probability'.

" + "smithy.api#documentation": "

A JMESPath expression used to extract the probability (or score) from the model\n container output if the model container is in JSON Lines format.

\n

\n Example: If the model container output of a single\n request is '{\"predicted_label\":1,\"probability\":0.6}', then set\n ProbabilityAttribute to 'probability'.

" } }, "LabelAttribute": { "target": "com.amazonaws.sagemaker#ClarifyLabelAttribute", "traits": { - "smithy.api#documentation": "

A JMESPath expression used to locate the list of label headers in the model container\n output.

\n

\n Example: If the model container output of a batch\n request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}',\n then set LabelAttribute to 'labels' to extract the list of\n label headers [\"cat\",\"dog\",\"fish\"]\n

" + "smithy.api#documentation": "

A JMESPath expression used to locate the list of label headers in the model container\n output.

\n

\n Example: If the model container output of a batch\n request is '{\"labels\":[\"cat\",\"dog\",\"fish\"],\"probability\":[0.6,0.3,0.1]}',\n then set LabelAttribute to 'labels' to extract the list of\n label headers [\"cat\",\"dog\",\"fish\"]\n

" } }, "LabelHeaders": { @@ -4364,7 +4412,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for the SHAP\n baseline (also called the background or reference dataset) of the Kernal\n SHAP algorithm.

\n \n
    \n
  • \n

    The number of records in the baseline data determines the size of the\n synthetic dataset, which has an impact on latency of explainability\n requests. For more information, see the Synthetic\n data of Configure and create an endpoint.

    \n
    • \n
  • \n

    \n ShapBaseline and ShapBaselineUri are mutually\n exclusive parameters. One or the either is required to configure a SHAP\n baseline.

    \n
    • \n
\n " + "smithy.api#documentation": "

The configuration for the SHAP\n baseline (also called the background or reference dataset) of the Kernal\n SHAP algorithm.

\n \n
    \n
  • \n

    The number of records in the baseline data determines the size of the\n synthetic dataset, which has an impact on latency of explainability\n requests. For more information, see the Synthetic\n data of Configure and create an endpoint.

    \n
    • \n
  • \n

    \n ShapBaseline and ShapBaselineUri are mutually\n exclusive parameters. One or the either is required to configure a SHAP\n baseline.

    \n
    • \n
\n " } }, "com.amazonaws.sagemaker#ClarifyShapConfig": { @@ -4380,7 +4428,7 @@ "NumberOfSamples": { "target": "com.amazonaws.sagemaker#ClarifyShapNumberOfSamples", "traits": { - "smithy.api#documentation": "

The number of samples to be used for analysis by the Kernal SHAP algorithm.

\n \n

The number of samples determines the size of the synthetic dataset, which has an\n impact on latency of explainability requests. For more information, see the\n Synthetic data of Configure and create an endpoint.

\n " + "smithy.api#documentation": "

The number of samples to be used for analysis by the Kernal SHAP algorithm.

\n \n

The number of samples determines the size of the synthetic dataset, which has an\n impact on latency of explainability requests. For more information, see the\n Synthetic data of Configure and create an endpoint.

\n " } }, "UseLogit": { @@ -4426,7 +4474,7 @@ "Language": { "target": "com.amazonaws.sagemaker#ClarifyTextLanguage", "traits": { - "smithy.api#documentation": "

Specifies the language of the text features in ISO 639-1 or\n ISO 639-3 code of a\n supported language.

\n \n

For a mix of multiple languages, use code 'xx'.

\n ", + "smithy.api#documentation": "

Specifies the language of the text features in ISO 639-1 or\n ISO 639-3 code of a\n supported language.

\n \n

For a mix of multiple languages, use code 'xx'.

\n ", "smithy.api#required": {} } }, @@ -5403,19 +5451,19 @@ "ContainerHostname": { "target": "com.amazonaws.sagemaker#ContainerHostname", "traits": { - "smithy.api#documentation": "

This parameter is ignored for models that contain only a\n PrimaryContainer.

\n

When a ContainerDefinition is part of an inference pipeline, the value of\n the parameter uniquely identifies the container for the purposes of logging and metrics.\n For information, see Use Logs and Metrics\n to Monitor an Inference Pipeline. If you don't specify a value for this\n parameter for a ContainerDefinition that is part of an inference pipeline,\n a unique name is automatically assigned based on the position of the\n ContainerDefinition in the pipeline. If you specify a value for the\n ContainerHostName for any ContainerDefinition that is part\n of an inference pipeline, you must specify a value for the\n ContainerHostName parameter of every ContainerDefinition\n in that pipeline.

" + "smithy.api#documentation": "

This parameter is ignored for models that contain only a\n PrimaryContainer.

\n

When a ContainerDefinition is part of an inference pipeline, the value of\n the parameter uniquely identifies the container for the purposes of logging and metrics.\n For information, see Use Logs and Metrics\n to Monitor an Inference Pipeline. If you don't specify a value for this\n parameter for a ContainerDefinition that is part of an inference pipeline,\n a unique name is automatically assigned based on the position of the\n ContainerDefinition in the pipeline. If you specify a value for the\n ContainerHostName for any ContainerDefinition that is part\n of an inference pipeline, you must specify a value for the\n ContainerHostName parameter of every ContainerDefinition\n in that pipeline.

" } }, "Image": { "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { - "smithy.api#documentation": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker\n

" + "smithy.api#documentation": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker\n

" } }, "ImageConfig": { "target": "com.amazonaws.sagemaker#ImageConfig", "traits": { - "smithy.api#documentation": "

Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\n private Docker registry, see Use a\n Private Docker Registry for Real-Time Inference Containers\n

" + "smithy.api#documentation": "

Specifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\n private Docker registry, see Use a\n Private Docker Registry for Real-Time Inference Containers\n

" } }, "Mode": { @@ -5427,7 +5475,7 @@ "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token\n Service to download model artifacts from the S3 path you provide. Amazon Web Services STS\n is activated in your IAM user account by default. If you previously deactivated\n Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS\n for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

\n " + "smithy.api#documentation": "

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token\n Service to download model artifacts from the S3 path you provide. Amazon Web Services STS\n is activated in your IAM user account by default. If you previously deactivated\n Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS\n for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

\n " } }, "Environment": { @@ -5699,7 +5747,7 @@ "ScalingType": { "target": "com.amazonaws.sagemaker#HyperParameterScalingType", "traits": { - "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
ReverseLogarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.

\n

Reverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.

\n
\n
" + "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
ReverseLogarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.

\n

Reverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.

\n
\n
" } } }, @@ -5853,14 +5901,14 @@ "TrainingSpecification": { "target": "com.amazonaws.sagemaker#TrainingSpecification", "traits": { - "smithy.api#documentation": "

Specifies details about training jobs run by this algorithm, including the\n following:

\n
    \n
  • \n

    The Amazon ECR path of the container and the version digest of the\n algorithm.

    \n
    • \n
  • \n

    The hyperparameters that the algorithm supports.

    \n
    • \n
  • \n

    The instance types that the algorithm supports for training.

    \n
    • \n
  • \n

    Whether the algorithm supports distributed training.

    \n
    • \n
  • \n

    The metrics that the algorithm emits to Amazon CloudWatch.

    \n
    • \n
  • \n

    Which metrics that the algorithm emits can be used as the objective metric for\n hyperparameter tuning jobs.

    \n
    • \n
  • \n

    The input channels that the algorithm supports for training data. For example,\n an algorithm might support train, validation, and\n test channels.

    \n
    • \n
", + "smithy.api#documentation": "

Specifies details about training jobs run by this algorithm, including the\n following:

\n
    \n
  • \n

    The Amazon ECR path of the container and the version digest of the\n algorithm.

    \n
    • \n
  • \n

    The hyperparameters that the algorithm supports.

    \n
    • \n
  • \n

    The instance types that the algorithm supports for training.

    \n
    • \n
  • \n

    Whether the algorithm supports distributed training.

    \n
    • \n
  • \n

    The metrics that the algorithm emits to Amazon CloudWatch.

    \n
    • \n
  • \n

    Which metrics that the algorithm emits can be used as the objective metric for\n hyperparameter tuning jobs.

    \n
    • \n
  • \n

    The input channels that the algorithm supports for training data. For example,\n an algorithm might support train, validation, and\n test channels.

    \n
    • \n
", "smithy.api#required": {} } }, "InferenceSpecification": { "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "

Specifies details about inference jobs that the algorithm runs, including the\n following:

\n
    \n
  • \n

    The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

    \n
    • \n
  • \n

    The instance types that the algorithm supports for transform jobs and\n real-time endpoints used for inference.

    \n
    • \n
  • \n

    The input and output content formats that the algorithm supports for\n inference.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies details about inference jobs that the algorithm runs, including the\n following:

\n
    \n
  • \n

    The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

    \n
    • \n
  • \n

    The instance types that the algorithm supports for transform jobs and\n real-time endpoints used for inference.

    \n
    • \n
  • \n

    The input and output content formats that the algorithm supports for\n inference.

    \n
    • \n
" } }, "ValidationSpecification": { @@ -5981,7 +6029,7 @@ "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

The user profile name.

" + "smithy.api#documentation": "

The user profile name. If this value is not set, then SpaceName must be set.

" } }, "AppType": { @@ -6013,7 +6061,7 @@ "SpaceName": { "target": "com.amazonaws.sagemaker#SpaceName", "traits": { - "smithy.api#documentation": "

The name of the space.

" + "smithy.api#documentation": "

The name of the space. If this value is not set, then UserProfileName must be set.

" } } } @@ -6208,7 +6256,7 @@ "target": "com.amazonaws.sagemaker#CreateCodeRepositoryOutput" }, "traits": { - "smithy.api#documentation": "

Creates a Git repository as a resource in your SageMaker account. You can associate the\n repository with notebook instances so that you can use Git source control for the\n notebooks you create. The Git repository is a resource in your SageMaker account, so it can\n be associated with more than one notebook instance, and it persists independently from\n the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in Amazon Web Services CodeCommit\n or in any other Git repository.

" + "smithy.api#documentation": "

Creates a Git repository as a resource in your SageMaker account. You can associate the\n repository with notebook instances so that you can use Git source control for the\n notebooks you create. The Git repository is a resource in your SageMaker account, so it can\n be associated with more than one notebook instance, and it persists independently from\n the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in Amazon Web Services CodeCommit\n or in any other Git repository.

" } }, "com.amazonaws.sagemaker#CreateCodeRepositoryInput": { @@ -6265,7 +6313,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the\n resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

\n

If\n you choose to host your model using Amazon SageMaker hosting services, you can use the resulting\n model artifacts as part of the model. You can also use the artifacts with\n Amazon Web Services\n IoT Greengrass. In that case, deploy them as an ML\n resource.

\n

In the request body, you provide the following:

\n
    \n
  • \n

    A name for the compilation job

    \n
    • \n
  • \n

    Information about the input model artifacts

    \n
    • \n
  • \n

    The output location for the compiled model and the device (target) that the\n model runs on

    \n
    • \n
  • \n

    The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform\n the model compilation job.

    \n
    • \n
\n

You can also provide a Tag to track the model compilation job's resource\n use and costs. The response body contains the\n CompilationJobArn\n for the compiled job.

\n

To stop a model compilation job, use StopCompilationJob. To get\n information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model\n compilation jobs, use ListCompilationJobs.

" + "smithy.api#documentation": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the\n resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

\n

If\n you choose to host your model using Amazon SageMaker hosting services, you can use the resulting\n model artifacts as part of the model. You can also use the artifacts with\n Amazon Web Services\n IoT Greengrass. In that case, deploy them as an ML\n resource.

\n

In the request body, you provide the following:

\n
    \n
  • \n

    A name for the compilation job

    \n
    • \n
  • \n

    Information about the input model artifacts

    \n
    • \n
  • \n

    The output location for the compiled model and the device (target) that the\n model runs on

    \n
    • \n
  • \n

    The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform\n the model compilation job.

    \n
    • \n
\n

You can also provide a Tag to track the model compilation job's resource\n use and costs. The response body contains the\n CompilationJobArn\n for the compiled job.

\n

To stop a model compilation job, use StopCompilationJob. To get\n information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model\n compilation jobs, use ListCompilationJobs.

" } }, "com.amazonaws.sagemaker#CreateCompilationJobRequest": { @@ -6281,7 +6329,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on\n your behalf.

\n

During model compilation, Amazon SageMaker needs your permission to:

\n
    \n
  • \n

    Read input data from an S3 bucket

    \n
    • \n
  • \n

    Write model artifacts to an S3 bucket

    \n
    • \n
  • \n

    Write logs to Amazon CloudWatch Logs

    \n
    • \n
  • \n

    Publish metrics to Amazon CloudWatch

    \n
    • \n
\n

You grant permissions for all of these tasks to an IAM role. To pass this role to\n Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For\n more information, see Amazon SageMaker\n Roles.\n

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on\n your behalf.

\n

During model compilation, Amazon SageMaker needs your permission to:

\n
    \n
  • \n

    Read input data from an S3 bucket

    \n
    • \n
  • \n

    Write model artifacts to an S3 bucket

    \n
    • \n
  • \n

    Write logs to Amazon CloudWatch Logs

    \n
    • \n
  • \n

    Publish metrics to Amazon CloudWatch

    \n
    • \n
\n

You grant permissions for all of these tasks to an IAM role. To pass this role to\n Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For\n more information, see Amazon SageMaker\n Roles.\n

", "smithy.api#required": {} } }, @@ -6331,7 +6379,7 @@ "CompilationJobArn": { "target": "com.amazonaws.sagemaker#CompilationJobArn", "traits": { - "smithy.api#documentation": "

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns\n the following data in JSON format:

\n
    \n
  • \n

    \n CompilationJobArn: The Amazon Resource Name (ARN) of the compiled\n job.

    \n
    • \n
", + "smithy.api#documentation": "

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns\n the following data in JSON format:

\n
    \n
  • \n

    \n CompilationJobArn: The Amazon Resource Name (ARN) of the compiled\n job.

    \n
    • \n
", "smithy.api#required": {} } } @@ -6587,7 +6635,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region.\n Users within a domain can share notebook files and other artifacts with each other.

\n\n

\n EFS storage\n

\n

When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

\n

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with\n an Amazon Web Services managed key by default. For more control, you can specify a\n customer managed key. For more information, see\n Protect Data at\n Rest Using Encryption.

\n\n

\n VPC configuration\n

\n

All SageMaker Studio traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to Studio. The following options are available:

\n
    \n
  • \n

    \n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker, which allows internet access. This is the default value.

    \n
    • \n
  • \n

    \n VpcOnly - All Studio traffic is through the specified VPC and subnets.\n Internet access is disabled by default. To allow internet access, you must specify a\n NAT gateway.

    \n

    When internet access is disabled, you won't be able to run a Studio notebook or to\n train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime\n or a NAT gateway and your security groups allow outbound connections.

    \n
    • \n
\n \n

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a SageMaker Studio app successfully.

\n \n

For more information, see\n Connect\n SageMaker Studio Notebooks to Resources in a VPC.

" + "smithy.api#documentation": "

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region.\n Users within a domain can share notebook files and other artifacts with each other.

\n

\n EFS storage\n

\n

When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

\n

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with\n an Amazon Web Services managed key by default. For more control, you can specify a\n customer managed key. For more information, see\n Protect Data at\n Rest Using Encryption.

\n

\n VPC configuration\n

\n

All SageMaker Studio traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to Studio. The following options are available:

\n
    \n
  • \n

    \n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker, which allows internet access. This is the default value.

    \n
    • \n
  • \n

    \n VpcOnly - All Studio traffic is through the specified VPC and subnets.\n Internet access is disabled by default. To allow internet access, you must specify a\n NAT gateway.

    \n

    When internet access is disabled, you won't be able to run a Studio notebook or to\n train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime\n or a NAT gateway and your security groups allow outbound connections.

    \n
    • \n
\n \n

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a SageMaker Studio app successfully.

\n \n

For more information, see\n Connect\n SageMaker Studio Notebooks to Resources in a VPC.

" } }, "com.amazonaws.sagemaker#CreateDomainRequest": { @@ -6885,7 +6933,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using SageMaker hosting services.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see the Create Endpoint example notebook.\n

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.

\n

When it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n \n

When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your IAM user account by\n default. If you previously deactivated Amazon Web Services STS for a region, you need to\n reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.

\n
    \n
  • \n

    Option 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.

    \n
    • \n
  • \n

    Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:

    \n

    \n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n

    \n

    \n \"Resource\": [\n

    \n

    \n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n

    \n

    \n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n

    \n

    \n ]\n

    \n

    For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.

    \n
    • \n
\n\n " + "smithy.api#documentation": "

Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using SageMaker hosting services.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see the Create Endpoint example notebook.\n

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.

\n

When it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n \n

When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your IAM user account by\n default. If you previously deactivated Amazon Web Services STS for a region, you need to\n reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.

\n
    \n
  • \n

    Option 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.

    \n
    • \n
  • \n

    Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:

    \n

    \n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n

    \n

    \n \"Resource\": [\n

    \n

    \n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n

    \n

    \n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n

    \n

    \n ]\n

    \n

    For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.

    \n
    • \n
\n " } }, "com.amazonaws.sagemaker#CreateEndpointConfig": { @@ -6902,7 +6950,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint API.

\n \n

Use this API if you want to use SageMaker hosting services to deploy models into\n production.

\n \n

In the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.

\n

If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n " + "smithy.api#documentation": "

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint API.

\n \n

Use this API if you want to use SageMaker hosting services to deploy models into\n production.

\n \n

In the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.

\n

If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n " } }, "com.amazonaws.sagemaker#CreateEndpointConfigInput": { @@ -6918,7 +6966,7 @@ "ProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantList", "traits": { - "smithy.api#documentation": "

An list of ProductionVariant objects, one for each model that you want\n to host at this endpoint.

", + "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint.

", "smithy.api#required": {} } }, @@ -6934,7 +6982,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that\n hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that\n SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that\n hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " } }, "AsyncInferenceConfig": { @@ -6952,7 +7000,7 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantList", "traits": { - "smithy.api#documentation": "

\n Array of ProductionVariant objects. There is one for each model that you want to host at this\n endpoint in shadow mode with production traffic replicated from the model specified on\n ProductionVariants.If you use this field, you can only specify one variant for\n ProductionVariants and one variant for ShadowProductionVariants.\n

" + "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants. If you use this field, you can only\n specify one variant for ProductionVariants and one variant for\n ShadowProductionVariants.

" } } } @@ -7023,7 +7071,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.

\n

The goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

\n

To add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.

\n

To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials\n API. To create a trial call the CreateTrial API.

" + "smithy.api#documentation": "

Creates a SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.

\n \n

In the Studio UI, trials are referred to as run groups and trial\n components are referred to as runs.

\n \n

The goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

\n

To add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.

\n

To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials\n API. To create a trial call the CreateTrial API.

" } }, "com.amazonaws.sagemaker#CreateExperimentRequest": { @@ -7127,7 +7175,7 @@ "OfflineStoreConfig": { "target": "com.amazonaws.sagemaker#OfflineStoreConfig", "traits": { - "smithy.api#documentation": "

Use this to configure an OfflineFeatureStore. This parameter allows you to\n specify:

\n
    \n
  • \n

    The Amazon Simple Storage Service (Amazon S3) location of an\n OfflineStore.

    \n
    • \n
  • \n

    A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

    \n
    • \n
  • \n

    An KMS encryption key to encrypt the Amazon S3 location used for\n OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using \n Amazon Web Services KMS key. By defining your bucket-level key for SSE, \n you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

    \n
    • \n
\n

To learn more about this parameter, see OfflineStoreConfig.

" + "smithy.api#documentation": "

Use this to configure an OfflineFeatureStore. This parameter allows you to\n specify:

\n
    \n
  • \n

    The Amazon Simple Storage Service (Amazon S3) location of an\n OfflineStore.

    \n
    • \n
  • \n

    A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.

    \n
    • \n
  • \n

    An KMS encryption key to encrypt the Amazon S3 location used for\n OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using \n Amazon Web Services KMS key. By defining your bucket-level key for SSE, \n you can reduce Amazon Web Services KMS requests costs by up to 99 percent.

    \n
    • \n
  • \n

    Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

    \n
    • \n
\n

To learn more about this parameter, see OfflineStoreConfig.

" } }, "RoleArn": { @@ -7393,7 +7441,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version\n of a model by running many training jobs on your dataset using the algorithm you choose\n and values for hyperparameters within ranges that you specify. It then chooses the\n hyperparameter values that result in a model that performs the best, as measured by an\n objective metric that you choose.

\n

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and\n trial components for each training job that it runs. You can view these entities in\n Amazon SageMaker Studio. For more information, see View\n Experiments, Trials, and Trial Components.

\n \n

Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.

\n " + "smithy.api#documentation": "

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version\n of a model by running many training jobs on your dataset using the algorithm you choose\n and values for hyperparameters within ranges that you specify. It then chooses the\n hyperparameter values that result in a model that performs the best, as measured by an\n objective metric that you choose.

\n

A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and\n trial components for each training job that it runs. You can view these entities in\n Amazon SageMaker Studio. For more information, see View\n Experiments, Trials, and Trial Components.

\n \n

Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.

\n " } }, "com.amazonaws.sagemaker#CreateHyperParameterTuningJobRequest": { @@ -7428,13 +7476,13 @@ "WarmStartConfig": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartConfig", "traits": { - "smithy.api#documentation": "

Specifies the configuration for starting the hyperparameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.

\n

All training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the\n WarmStartType value for the warm start configuration, the training job\n that performs the best in the new tuning job is compared to the best training jobs from\n the parent tuning jobs. From these, the training job that performs the best as measured\n by the objective metric is returned as the overall best training job.

\n \n

All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.

\n " + "smithy.api#documentation": "

Specifies the configuration for starting the hyperparameter tuning job using one or\n more previous tuning jobs as a starting point. The results of previous tuning jobs are\n used to inform which combinations of hyperparameters to search over in the new tuning\n job.

\n

All training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the\n WarmStartType value for the warm start configuration, the training job\n that performs the best in the new tuning job is compared to the best training jobs from\n the parent tuning jobs. From these, the training job that performs the best as measured\n by the objective metric is returned as the overall best training job.

\n \n

All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.

\n " } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

\n

Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.

\n

Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

" } } } @@ -7496,7 +7544,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", + "smithy.api#documentation": "

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", "smithy.api#required": {} } }, @@ -7514,7 +7562,7 @@ "ImageArn": { "target": "com.amazonaws.sagemaker#ImageArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

" + "smithy.api#documentation": "

The ARN of the image.

" } } } @@ -7566,6 +7614,55 @@ "smithy.api#documentation": "

The ImageName of the Image to create a version of.

", "smithy.api#required": {} } + }, + "Aliases": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "

A list of aliases created with the image version.

" + } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "

The stability of the image version, specified by the maintainer.

\n
    \n
  • \n

    \n NOT_PROVIDED: The maintainers did not provide a status for image version stability.

    \n
    • \n
  • \n

    \n STABLE: The image version is stable.

    \n
    • \n
  • \n

    \n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

    \n
    • \n
  • \n

    \n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

    \n
    • \n
" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#JobType", + "traits": { + "smithy.api#documentation": "

Indicates SageMaker job type compatibility.

\n
    \n
  • \n

    \n TRAINING: The image version is compatible with SageMaker training jobs.

    \n
    • \n
  • \n

    \n INFERENCE: The image version is compatible with SageMaker inference jobs.

    \n
    • \n
  • \n

    \n NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

    \n
    • \n
" + } + }, + "MLFramework": { + "target": "com.amazonaws.sagemaker#MLFramework", + "traits": { + "smithy.api#documentation": "

The machine learning framework vended in the image version.

" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "

The supported programming language and its version.

" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "

Indicates CPU or GPU compatibility.

\n
    \n
  • \n

    \n CPU: The image version is compatible with CPU.

    \n
    • \n
  • \n

    \n GPU: The image version is compatible with GPU.

    \n
    • \n
" + } + }, + "Horovod": { + "target": "com.amazonaws.sagemaker#Horovod", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates Horovod compatibility.

" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "

The maintainer description of the image version.

" + } } } }, @@ -7575,7 +7672,7 @@ "ImageVersionArn": { "target": "com.amazonaws.sagemaker#ImageVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image version.

" + "smithy.api#documentation": "

The ARN of the image version.

" } } } @@ -7597,7 +7694,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Creates an inference experiment using the configurations specified in the request.\n

\n

\n Use this API to schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more\n information about inference experiments, see Shadow tests.\n

\n

\n Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based\n on your specified configuration.\n

\n

\n While the experiment is in progress or after it has concluded, you can view metrics that compare your model\n variants. For more information, see View, monitor, and edit shadow tests.\n

" + "smithy.api#documentation": "

\n Creates an inference experiment using the configurations specified in the request.\n

\n

\n Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For\n more information about inference experiments, see Shadow tests.\n

\n

\n Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based\n on your specified configuration.\n

\n

\n While the experiment is in progress or after it has concluded, you can view metrics that compare your model\n variants. For more information, see View, monitor, and edit shadow tests.\n

" } }, "com.amazonaws.sagemaker#CreateInferenceExperimentRequest": { @@ -7613,14 +7710,14 @@ "Type": { "target": "com.amazonaws.sagemaker#InferenceExperimentType", "traits": { - "smithy.api#documentation": "

\n The type of the inference experiment that you want to run. The following types of experiments are possible:\n

\n
    \n
  • \n

    \n ShadowMode: You can use this type to validate a shadow variant. For more information,\n see Shadow tests.\n

    \n
    • \n
", + "smithy.api#documentation": "

\n The type of the inference experiment that you want to run. The following types of experiments are possible:\n

\n
    \n
  • \n

    \n ShadowMode: You can use this type to validate a shadow variant. For more information,\n see Shadow tests.\n

    \n
    • \n
", "smithy.api#required": {} } }, "Schedule": { "target": "com.amazonaws.sagemaker#InferenceExperimentSchedule", "traits": { - "smithy.api#documentation": "

\n The duration for which you want the inference experiment to run. If you don't specify this field, the\n experiment automatically concludes after 7 days.\n

" + "smithy.api#documentation": "

\n The duration for which you want the inference experiment to run. If you don't specify this field, the\n experiment automatically starts immediately upon creation and concludes after 7 days.\n

" } }, "Description": { @@ -7632,7 +7729,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images.\n

", + "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n

", "smithy.api#required": {} } }, @@ -7646,27 +7743,27 @@ "ModelVariants": { "target": "com.amazonaws.sagemaker#ModelVariantConfigList", "traits": { - "smithy.api#documentation": "

\n Array of ModelVariantConfigSummary objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure\n configuration for the corresponding variant.\n

", + "smithy.api#documentation": "

\n An array of ModelVariantConfig objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfig object in the array describes the infrastructure\n configuration for the corresponding variant.\n

", "smithy.api#required": {} } }, "DataStorageConfig": { "target": "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig", "traits": { - "smithy.api#documentation": "

\n The storage configuration for the inference experiment. This is an optional parameter that you can use for\n data capture. For more information, see Capture data.\n

" + "smithy.api#documentation": "

\n The Amazon S3 location and configuration for storing inference request and response data.\n

\n

\n This is an optional parameter that you can use for data capture. For more information, see Capture data.\n

" } }, "ShadowModeConfig": { "target": "com.amazonaws.sagemaker#ShadowModeConfig", "traits": { - "smithy.api#documentation": "

\n Shows which variant is the production variant and which variant is the shadow variant. For the shadow\n variant, also shows the sampling percentage.\n

", + "smithy.api#documentation": "

\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n

", "smithy.api#required": {} } }, "KmsKey": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt\n data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey\n can be any of the following formats:\n

\n
    \n
  • \n

    KMS key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    KMS key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

\n If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to\n call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for\n your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for\n OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that\n only allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys\n in the Amazon Simple Storage Service Developer Guide.\n

\n

\n The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.\n

" + "smithy.api#documentation": "

\n The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can\n be any of the following formats:\n

\n
    \n
  • \n

    KMS key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    KMS key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

\n If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to\n call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for\n your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for\n OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that\n only allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS managed Encryption Keys\n in the Amazon Simple Storage Service Developer Guide.\n

\n

\n The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.\n

" } }, "Tags": { @@ -7795,7 +7892,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a job that uses workers to label the data objects in your input dataset. You\n can use the labeled data to train machine learning models.

\n

You can select your workforce from one of three providers:

\n
    \n
  • \n

    A private workforce that you create. It can include employees, contractors,\n and outside experts. Use a private workforce when want the data to stay within\n your organization or when a specific set of skills is required.

    \n
    • \n
  • \n

    One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide\n expertise in specific areas.

    \n
    • \n
  • \n

    The Amazon Mechanical Turk workforce. This is the largest workforce, but it\n should only be used for public data or data that has been stripped of any\n personally identifiable information.

    \n
    • \n
\n

You can also use automated data labeling to reduce the number of\n data objects that need to be labeled by a human. Automated data labeling uses\n active learning to determine if a data object can be labeled by\n machine or if it needs to be sent to a human worker. For more information, see Using\n Automated Data Labeling.

\n

The data objects to be labeled are contained in an Amazon S3 bucket. You create a\n manifest file that describes the location of each object. For\n more information, see Using Input and Output Data.

\n

The output can be used as the manifest file for another labeling job or as training\n data for your machine learning models.

\n

You can use this operation to create a static labeling job or a streaming labeling\n job. A static labeling job stops if all data objects in the input manifest file\n identified in ManifestS3Uri have been labeled. A streaming labeling job\n runs perpetually until it is manually stopped, or remains idle for 10 days. You can send\n new data objects to an active (InProgress) streaming labeling job in real\n time. To learn how to create a static labeling job, see Create a Labeling Job\n (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming\n labeling job, see Create a Streaming Labeling\n Job.

" + "smithy.api#documentation": "

Creates a job that uses workers to label the data objects in your input dataset. You\n can use the labeled data to train machine learning models.

\n

You can select your workforce from one of three providers:

\n
    \n
  • \n

    A private workforce that you create. It can include employees, contractors,\n and outside experts. Use a private workforce when want the data to stay within\n your organization or when a specific set of skills is required.

    \n
    • \n
  • \n

    One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide\n expertise in specific areas.

    \n
    • \n
  • \n

    The Amazon Mechanical Turk workforce. This is the largest workforce, but it\n should only be used for public data or data that has been stripped of any\n personally identifiable information.

    \n
    • \n
\n

You can also use automated data labeling to reduce the number of\n data objects that need to be labeled by a human. Automated data labeling uses\n active learning to determine if a data object can be labeled by\n machine or if it needs to be sent to a human worker. For more information, see Using\n Automated Data Labeling.

\n

The data objects to be labeled are contained in an Amazon S3 bucket. You create a\n manifest file that describes the location of each object. For\n more information, see Using Input and Output Data.

\n

The output can be used as the manifest file for another labeling job or as training\n data for your machine learning models.

\n

You can use this operation to create a static labeling job or a streaming labeling\n job. A static labeling job stops if all data objects in the input manifest file\n identified in ManifestS3Uri have been labeled. A streaming labeling job\n runs perpetually until it is manually stopped, or remains idle for 10 days. You can send\n new data objects to an active (InProgress) streaming labeling job in real\n time. To learn how to create a static labeling job, see Create a Labeling Job\n (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming\n labeling job, see Create a Streaming Labeling\n Job.

" } }, "com.amazonaws.sagemaker#CreateLabelingJobRequest": { @@ -7811,14 +7908,14 @@ "LabelAttributeName": { "target": "com.amazonaws.sagemaker#LabelAttributeName", "traits": { - "smithy.api#documentation": "

The attribute name to use for the label in the output manifest file. This is the key\n for the key/value pair formed with the label that a worker assigns to the object. The\n LabelAttributeName must meet the following requirements.

\n
    \n
  • \n

    The name can't end with \"-metadata\".

    \n
    • \n
  • \n

    If you are using one of the following built-in task types,\n the attribute name must end with \"-ref\". If the task type\n you are using is not listed below, the attribute name must\n not end with \"-ref\".

    \n
      \n
    • \n

      Image semantic segmentation (SemanticSegmentation), and\n adjustment (AdjustmentSemanticSegmentation) and\n verification (VerificationSemanticSegmentation) labeling\n jobs for this task type.

      \n
      • \n
    • \n

      Video frame object detection (VideoObjectDetection), and\n adjustment and verification\n (AdjustmentVideoObjectDetection) labeling jobs for this\n task type.

      \n
      • \n
    • \n

      Video frame object tracking (VideoObjectTracking), and\n adjustment and verification (AdjustmentVideoObjectTracking)\n labeling jobs for this task type.

      \n
      • \n
    • \n

      3D point cloud semantic segmentation\n (3DPointCloudSemanticSegmentation), and adjustment and\n verification (Adjustment3DPointCloudSemanticSegmentation)\n labeling jobs for this task type.

      \n
      • \n
    • \n

      3D point cloud object tracking\n (3DPointCloudObjectTracking), and adjustment and\n verification (Adjustment3DPointCloudObjectTracking)\n labeling jobs for this task type.

      \n
      • \n
    \n
    • \n
\n

\n \n

If you are creating an adjustment or verification labeling job, you must use a\n different\n LabelAttributeName than the one used in the original labeling job. The\n original labeling job is the Ground Truth labeling job that produced the labels that you\n want verified or adjusted. To learn more about adjustment and verification labeling\n jobs, see Verify and Adjust\n Labels.

\n ", + "smithy.api#documentation": "

The attribute name to use for the label in the output manifest file. This is the key\n for the key/value pair formed with the label that a worker assigns to the object. The\n LabelAttributeName must meet the following requirements.

\n
    \n
  • \n

    The name can't end with \"-metadata\".

    \n
    • \n
  • \n

    If you are using one of the following built-in task types,\n the attribute name must end with \"-ref\". If the task type\n you are using is not listed below, the attribute name must\n not end with \"-ref\".

    \n
      \n
    • \n

      Image semantic segmentation (SemanticSegmentation), and\n adjustment (AdjustmentSemanticSegmentation) and\n verification (VerificationSemanticSegmentation) labeling\n jobs for this task type.

      \n
      • \n
    • \n

      Video frame object detection (VideoObjectDetection), and\n adjustment and verification\n (AdjustmentVideoObjectDetection) labeling jobs for this\n task type.

      \n
      • \n
    • \n

      Video frame object tracking (VideoObjectTracking), and\n adjustment and verification (AdjustmentVideoObjectTracking)\n labeling jobs for this task type.

      \n
      • \n
    • \n

      3D point cloud semantic segmentation\n (3DPointCloudSemanticSegmentation), and adjustment and\n verification (Adjustment3DPointCloudSemanticSegmentation)\n labeling jobs for this task type.

      \n
      • \n
    • \n

      3D point cloud object tracking\n (3DPointCloudObjectTracking), and adjustment and\n verification (Adjustment3DPointCloudObjectTracking)\n labeling jobs for this task type.

      \n
      • \n
    \n
    • \n
\n

\n \n

If you are creating an adjustment or verification labeling job, you must use a\n different\n LabelAttributeName than the one used in the original labeling job. The\n original labeling job is the Ground Truth labeling job that produced the labels that you\n want verified or adjusted. To learn more about adjustment and verification labeling\n jobs, see Verify and Adjust\n Labels.

\n ", "smithy.api#required": {} } }, "InputConfig": { "target": "com.amazonaws.sagemaker#LabelingJobInputConfig", "traits": { - "smithy.api#documentation": "

Input data for the labeling job, such as the Amazon S3 location of the data objects and the\n location of the manifest file that describes the data objects.

\n

You must specify at least one of the following: S3DataSource or\n SnsDataSource.

\n
    \n
  • \n

    Use SnsDataSource to specify an SNS input topic for a streaming\n labeling job. If you do not specify and SNS input topic ARN, Ground Truth will\n create a one-time labeling job that stops after all data objects in the input\n manifest file have been labeled.

    \n
    • \n
  • \n

    Use S3DataSource to specify an input manifest file for both\n streaming and one-time labeling jobs. Adding an S3DataSource is\n optional if you use SnsDataSource to create a streaming labeling\n job.

    \n
    • \n
\n

If you use the Amazon Mechanical Turk workforce, your input data should not include\n confidential information, personal information or protected health information. Use\n ContentClassifiers to specify that your data is free of personally\n identifiable information and adult content.

", + "smithy.api#documentation": "

Input data for the labeling job, such as the Amazon S3 location of the data objects and the\n location of the manifest file that describes the data objects.

\n

You must specify at least one of the following: S3DataSource or\n SnsDataSource.

\n
    \n
  • \n

    Use SnsDataSource to specify an SNS input topic for a streaming\n labeling job. If you do not specify and SNS input topic ARN, Ground Truth will\n create a one-time labeling job that stops after all data objects in the input\n manifest file have been labeled.

    \n
    • \n
  • \n

    Use S3DataSource to specify an input manifest file for both\n streaming and one-time labeling jobs. Adding an S3DataSource is\n optional if you use SnsDataSource to create a streaming labeling\n job.

    \n
    • \n
\n

If you use the Amazon Mechanical Turk workforce, your input data should not include\n confidential information, personal information or protected health information. Use\n ContentClassifiers to specify that your data is free of personally\n identifiable information and adult content.

", "smithy.api#required": {} } }, @@ -7839,7 +7936,7 @@ "LabelCategoryConfigS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

The S3 URI of the file, referred to as a label category configuration\n file, that defines the categories used to label the data objects.

\n

For 3D point cloud and video frame task types, you can add label category attributes\n and frame attributes to your label category configuration file. To learn how, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

\n

For named entity recognition jobs, in addition to \"labels\", you must\n provide worker instructions in the label category configuration file using the\n \"instructions\" parameter: \"instructions\":\n {\"shortInstruction\":\"

Add header

Add Instructions

\",\n \"fullInstruction\":\"

Add additional instructions.

\"}. For details\n and an example, see Create a\n Named Entity Recognition Labeling Job (API) .

\n

For all other built-in task types and custom\n tasks, your label category configuration file must be a JSON file in the\n following format. Identify the labels you want to use by replacing label_1,\n label_2,...,label_n with your label\n categories.

\n

\n { \n

\n

\n \"document-version\": \"2018-11-28\",\n

\n

\n \"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\":\n \"label_n\"}]\n

\n

\n }\n

\n

Note the following about the label category configuration file:

\n
    \n
  • \n

    For image classification and text classification (single and multi-label) you\n must specify at least two label categories. For all other task types, the\n minimum number of label categories required is one.

    \n
    • \n
  • \n

    Each label category must be unique, you cannot specify duplicate label\n categories.

    \n
    • \n
  • \n

    If you create a 3D point cloud or video frame adjustment or verification\n labeling job, you must include auditLabelAttributeName in the label\n category configuration. Use this parameter to enter the \n LabelAttributeName\n of the labeling job you want to\n adjust or verify annotations of.

    \n
    • \n
" + "smithy.api#documentation": "

The S3 URI of the file, referred to as a label category configuration\n file, that defines the categories used to label the data objects.

\n

For 3D point cloud and video frame task types, you can add label category attributes\n and frame attributes to your label category configuration file. To learn how, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

\n

For named entity recognition jobs, in addition to \"labels\", you must\n provide worker instructions in the label category configuration file using the\n \"instructions\" parameter: \"instructions\":\n {\"shortInstruction\":\"

Add header

Add Instructions

\",\n \"fullInstruction\":\"

Add additional instructions.

\"}. For details\n and an example, see Create a\n Named Entity Recognition Labeling Job (API) .

\n

For all other built-in task types and custom\n tasks, your label category configuration file must be a JSON file in the\n following format. Identify the labels you want to use by replacing label_1,\n label_2,...,label_n with your label\n categories.

\n

\n { \n

\n

\n \"document-version\": \"2018-11-28\",\n

\n

\n \"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\":\n \"label_n\"}]\n

\n

\n }\n

\n

Note the following about the label category configuration file:

\n
    \n
  • \n

    For image classification and text classification (single and multi-label) you\n must specify at least two label categories. For all other task types, the\n minimum number of label categories required is one.

    \n
    • \n
  • \n

    Each label category must be unique, you cannot specify duplicate label\n categories.

    \n
    • \n
  • \n

    If you create a 3D point cloud or video frame adjustment or verification\n labeling job, you must include auditLabelAttributeName in the label\n category configuration. Use this parameter to enter the \n LabelAttributeName\n of the labeling job you want to\n adjust or verify annotations of.

    \n
    • \n
" } }, "StoppingConditions": { @@ -7895,7 +7992,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see Create a Model (Amazon Web Services SDK for Python (Boto 3)).\n

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

" + "smithy.api#documentation": "

Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see Create a Model (Amazon Web Services SDK for Python (Boto 3)).\n

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

" } }, "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { @@ -8263,7 +8360,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", "smithy.api#required": {} } }, @@ -8317,7 +8414,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

\n

To create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.

\n \n

There are two types of model packages:

\n
    \n
  • \n

    Versioned - a model that is part of a model group in the model\n registry.

    \n
    • \n
  • \n

    Unversioned - a model package that is not part of a model group.

    \n
    • \n
\n " + "smithy.api#documentation": "

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

\n

To create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.

\n \n

There are two types of model packages:

\n
    \n
  • \n

    Versioned - a model that is part of a model group in the model\n registry.

    \n
    • \n
  • \n

    Unversioned - a model package that is not part of a model group.

    \n
    • \n
\n " } }, "com.amazonaws.sagemaker#CreateModelPackageGroup": { @@ -8379,13 +8476,13 @@ "ModelPackageName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

The name of the model package. The name must have 1 to 63 characters. Valid characters\n are a-z, A-Z, 0-9, and - (hyphen).

\n

This parameter is required for unversioned models. It is not applicable to versioned\n models.

" + "smithy.api#documentation": "

The name of the model package. The name must have 1 to 63 characters. Valid characters\n are a-z, A-Z, 0-9, and - (hyphen).

\n

This parameter is required for unversioned models. It is not applicable to versioned\n models.

" } }, "ModelPackageGroupName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

\n

This parameter is required for versioned models, and does not apply to unversioned\n models.

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

\n

This parameter is required for versioned models, and does not apply to unversioned\n models.

" } }, "ModelPackageDescription": { @@ -8397,7 +8494,7 @@ "InferenceSpecification": { "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "

Specifies details about inference jobs that can be run with models based on this model\n package, including the following:

\n
    \n
  • \n

    The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

    \n
    • \n
  • \n

    The instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.

    \n
    • \n
  • \n

    The input and output content formats that the model package supports for\n inference.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies details about inference jobs that can be run with models based on this model\n package, including the following:

\n
    \n
  • \n

    The Amazon ECR paths of containers that contain the inference code and model\n artifacts.

    \n
    • \n
  • \n

    The instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.

    \n
    • \n
  • \n

    The input and output content formats that the model package supports for\n inference.

    \n
    • \n
" } }, "ValidationSpecification": { @@ -8416,7 +8513,7 @@ "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Whether to certify the model package for listing on Amazon Web Services Marketplace.

\n

This parameter is optional for unversioned models, and does not apply to versioned\n models.

" + "smithy.api#documentation": "

Whether to certify the model package for listing on Amazon Web Services Marketplace.

\n

This parameter is optional for unversioned models, and does not apply to versioned\n models.

" } }, "Tags": { @@ -8428,7 +8525,7 @@ "ModelApprovalStatus": { "target": "com.amazonaws.sagemaker#ModelApprovalStatus", "traits": { - "smithy.api#documentation": "

Whether the model is approved for deployment.

\n

This parameter is optional for versioned models, and does not apply to unversioned\n models.

\n

For versioned models, the value of this parameter must be set to Approved\n to deploy the model.

" + "smithy.api#documentation": "

Whether the model is approved for deployment.

\n

This parameter is optional for versioned models, and does not apply to unversioned\n models.

\n

For versioned models, the value of this parameter must be set to Approved\n to deploy the model.

" } }, "MetadataProperties": { @@ -8666,7 +8763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML)\n compute instance running on a Jupyter notebook.

\n

In a CreateNotebookInstance request, specify the type of ML compute\n instance that you want to run. SageMaker launches the instance, installs common libraries\n that you can use to explore datasets for model training, and attaches an ML storage\n volume to the notebook instance.

\n

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to\n use SageMaker with a specific algorithm or with a machine learning framework.

\n

After receiving the request, SageMaker does the following:

\n
    \n
  1. \n

    Creates a network interface in the SageMaker VPC.

    \n
    2. \n
  2. \n

    (Option) If you specified SubnetId, SageMaker creates a network\n interface in your own VPC, which is inferred from the subnet ID that you provide\n in the input. When creating this network interface, SageMaker attaches the security\n group that you specified in the request to the network interface that it creates\n in your VPC.

    \n \n
    3. \n
  3. \n

    Launches an EC2 instance of the type specified in the request in the SageMaker\n VPC. If you specified SubnetId of your VPC, SageMaker specifies both\n network interfaces when launching this instance. This enables inbound traffic\n from your own VPC to the notebook instance, assuming that the security groups\n allow it.

    \n
    4. \n
\n \n

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN).\n You can't change the name of a notebook instance after you create it.

\n

After SageMaker creates the notebook instance, you can connect to the Jupyter server and\n work in Jupyter notebooks. For example, you can write code to explore a dataset that you\n can use for model training, train a model, host models by creating SageMaker endpoints, and\n validate hosted models.

\n

For more information, see How It Works.

" + "smithy.api#documentation": "

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML)\n compute instance running on a Jupyter notebook.

\n

In a CreateNotebookInstance request, specify the type of ML compute\n instance that you want to run. SageMaker launches the instance, installs common libraries\n that you can use to explore datasets for model training, and attaches an ML storage\n volume to the notebook instance.

\n

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to\n use SageMaker with a specific algorithm or with a machine learning framework.

\n

After receiving the request, SageMaker does the following:

\n
    \n
  1. \n

    Creates a network interface in the SageMaker VPC.

    \n
    2. \n
  2. \n

    (Option) If you specified SubnetId, SageMaker creates a network\n interface in your own VPC, which is inferred from the subnet ID that you provide\n in the input. When creating this network interface, SageMaker attaches the security\n group that you specified in the request to the network interface that it creates\n in your VPC.

    \n
    3. \n
  3. \n

    Launches an EC2 instance of the type specified in the request in the SageMaker\n VPC. If you specified SubnetId of your VPC, SageMaker specifies both\n network interfaces when launching this instance. This enables inbound traffic\n from your own VPC to the notebook instance, assuming that the security groups\n allow it.

    \n
    4. \n
\n

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN).\n You can't change the name of a notebook instance after you create it.

\n

After SageMaker creates the notebook instance, you can connect to the Jupyter server and\n work in Jupyter notebooks. For example, you can write code to explore a dataset that you\n can use for model training, train a model, host models by creating SageMaker endpoints, and\n validate hosted models.

\n

For more information, see How It Works.

" } }, "com.amazonaws.sagemaker#CreateNotebookInstanceInput": { @@ -8701,7 +8798,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

When you send any requests to Amazon Web Services resources from the notebook\n instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this\n role necessary permissions so SageMaker can perform these tasks. The policy must allow the\n SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For\n more information, see SageMaker Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", + "smithy.api#documentation": "

When you send any requests to Amazon Web Services resources from the notebook\n instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this\n role necessary permissions so SageMaker can perform these tasks. The policy must allow the\n SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For\n more information, see SageMaker Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", "smithy.api#required": {} } }, @@ -8726,7 +8823,7 @@ "DirectInternetAccess": { "target": "com.amazonaws.sagemaker#DirectInternetAccess", "traits": { - "smithy.api#documentation": "

Sets whether SageMaker provides internet access to the notebook instance. If you set this\n to Disabled this notebook instance is able to access resources only in your\n VPC, and is not be able to connect to SageMaker training and endpoint services unless you\n configure a NAT Gateway in your VPC.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.

" + "smithy.api#documentation": "

Sets whether SageMaker provides internet access to the notebook instance. If you set this\n to Disabled this notebook instance is able to access resources only in your\n VPC, and is not be able to connect to SageMaker training and endpoint services unless you\n configure a NAT Gateway in your VPC.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.

" } }, "VolumeSizeInGB": { @@ -8756,7 +8853,7 @@ "RootAccess": { "target": "com.amazonaws.sagemaker#RootAccess", "traits": { - "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

\n \n

Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

\n " + "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

\n \n

Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

\n " } }, "PlatformIdentifier": { @@ -8787,7 +8884,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a lifecycle configuration that you can associate with a notebook instance. A\n lifecycle configuration is a collection of shell scripts that\n run when you create or start a notebook instance.

\n

Each lifecycle configuration script has a limit of 16384 characters.

\n

The value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.

\n

View CloudWatch Logs for notebook instance lifecycle configurations in log group\n /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].

\n

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" + "smithy.api#documentation": "

Creates a lifecycle configuration that you can associate with a notebook instance. A\n lifecycle configuration is a collection of shell scripts that\n run when you create or start a notebook instance.

\n

Each lifecycle configuration script has a limit of 16384 characters.

\n

The value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.

\n

View CloudWatch Logs for notebook instance lifecycle configurations in log group\n /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].

\n

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" } }, "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfigInput": { @@ -9004,7 +9101,7 @@ "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput" }, "traits": { - "smithy.api#documentation": "

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker console, when you choose Open next to a notebook\n instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.

\n

The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n Amazon Web Services console sign-in page.

\n " + "smithy.api#documentation": "

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker console, when you choose Open next to a notebook\n instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.

\n

The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n Amazon Web Services console sign-in page.

\n " } }, "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput": { @@ -9352,7 +9449,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.

\n

If you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n

\n

In the request body, you provide the following:

\n
    \n
  • \n

    \n AlgorithmSpecification - Identifies the training algorithm to\n use.\n

    \n
    • \n
  • \n

    \n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.

    \n \n

    Do not include any security-sensitive information including account access\n IDs, secrets or tokens in any hyperparameter field. If the use of\n security-sensitive credentials are detected, SageMaker will reject your training\n job request and return an exception error.

    \n     \n
    • \n
  • \n

    \n InputDataConfig - Describes the input required by the training job and the Amazon S3,\n EFS, or FSx location where it is stored.

    \n
    • \n
  • \n

    \n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.

    \n
    • \n
  • \n

    \n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.

    \n \n
    • \n
  • \n

    \n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.

    \n
    • \n
  • \n

    \n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.

    \n
    • \n
  • \n

    \n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.

    \n
    • \n
  • \n

    \n Environment - The environment variables to set in the Docker\n container.

    \n
    • \n
  • \n

    \n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.

    \n
    • \n
\n

For more information about SageMaker, see How It Works.

" + "smithy.api#documentation": "

Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.

\n

If you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n

\n

In the request body, you provide the following:

\n
    \n
  • \n

    \n AlgorithmSpecification - Identifies the training algorithm to\n use.\n

    \n
    • \n
  • \n

    \n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.

    \n \n

    Do not include any security-sensitive information including account access\n IDs, secrets or tokens in any hyperparameter field. If the use of\n security-sensitive credentials are detected, SageMaker will reject your training\n job request and return an exception error.

    \n     \n
    • \n
  • \n

    \n InputDataConfig - Describes the input required by the training\n job and the Amazon S3, EFS, or FSx location where it is stored.

    \n
    • \n
  • \n

    \n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.

    \n
    • \n
  • \n

    \n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.

    \n
    • \n
  • \n

    \n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.

    \n
    • \n
  • \n

    \n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.

    \n
    • \n
  • \n

    \n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.

    \n
    • \n
  • \n

    \n Environment - The environment variables to set in the Docker\n container.

    \n
    • \n
  • \n

    \n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.

    \n
    • \n
\n

For more information about SageMaker, see How It Works.

" } }, "com.amazonaws.sagemaker#CreateTrainingJobRequest": { @@ -9368,7 +9465,7 @@ "HyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "

Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.

\n

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.

\n \n

Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.

\n " + "smithy.api#documentation": "

Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.

\n

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.

\n \n

Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.

\n " } }, "AlgorithmSpecification": { @@ -9381,14 +9478,14 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform\n tasks on your behalf.

\n

During model training, SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform\n tasks on your behalf.

\n

During model training, SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", "smithy.api#required": {} } }, "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.

" + "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.

" } }, "OutputDataConfig": { @@ -9401,7 +9498,7 @@ "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "

The resources, including the ML compute instances and ML storage volumes, to use\n for model training.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.

", + "smithy.api#documentation": "

The resources, including the ML compute instances and ML storage volumes, to use\n for model training.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.

", "smithy.api#required": {} } }, @@ -9414,7 +9511,7 @@ "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

", + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

", "smithy.api#required": {} } }, @@ -9442,7 +9539,7 @@ "target": "com.amazonaws.sagemaker#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.

\n

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.

" + "smithy.api#documentation": "

To train models using managed spot training, choose True. Managed spot\n training provides a fully managed and scalable infrastructure for training machine\n learning models. this option is useful when training jobs can be interrupted and when\n there is flexibility when the training job is run.

\n

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be\n used as a starting point to train models incrementally. Amazon SageMaker provides metrics and\n logs in CloudWatch. They can be used to see when managed spot training jobs are running,\n interrupted, resumed, or completed.

" } }, "CheckpointConfig": { @@ -9521,7 +9618,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.

\n

To perform batch transformations, you create a transform job and use the data that you\n have readily available.

\n

In the request body, you provide the following:

\n
    \n
  • \n

    \n TransformJobName - Identifies the transform job. The name must be\n unique within an Amazon Web Services Region in an Amazon Web Services account.

    \n
    • \n
  • \n

    \n ModelName - Identifies the model to use. ModelName\n must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services\n\t\t account. For information on creating a model, see CreateModel.

    \n
    • \n
  • \n

    \n TransformInput - Describes the dataset to be transformed and the\n Amazon S3 location where it is stored.

    \n
    • \n
  • \n

    \n TransformOutput - Identifies the Amazon S3 location where you want\n Amazon SageMaker to save the results from the transform job.

    \n
    • \n
  • \n

    \n TransformResources - Identifies the ML compute instances for the\n transform job.

    \n
    • \n
\n

For more information about how batch transformation works, see Batch\n Transform.

" + "smithy.api#documentation": "

Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.

\n

To perform batch transformations, you create a transform job and use the data that you\n have readily available.

\n

In the request body, you provide the following:

\n
    \n
  • \n

    \n TransformJobName - Identifies the transform job. The name must be\n unique within an Amazon Web Services Region in an Amazon Web Services account.

    \n
    • \n
  • \n

    \n ModelName - Identifies the model to use. ModelName\n must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services\n\t\t account. For information on creating a model, see CreateModel.

    \n
    • \n
  • \n

    \n TransformInput - Describes the dataset to be transformed and the\n Amazon S3 location where it is stored.

    \n
    • \n
  • \n

    \n TransformOutput - Identifies the Amazon S3 location where you want\n Amazon SageMaker to save the results from the transform job.

    \n
    • \n
  • \n

    \n TransformResources - Identifies the ML compute instances for the\n transform job.

    \n
    • \n
\n

For more information about how batch transformation works, see Batch\n Transform.

" } }, "com.amazonaws.sagemaker#CreateTransformJobRequest": { @@ -9556,13 +9653,13 @@ "MaxPayloadInMB": { "target": "com.amazonaws.sagemaker#MaxPayloadInMB", "traits": { - "smithy.api#documentation": "

The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n

\n

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\n the MaxConcurrentTransforms parameter, the value of\n (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100\n MB.

\n

For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.

" + "smithy.api#documentation": "

The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n

\n

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\n the MaxConcurrentTransforms parameter, the value of\n (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100\n MB.

\n

For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.

" } }, "BatchStrategy": { "target": "com.amazonaws.sagemaker#BatchStrategy", "traits": { - "smithy.api#documentation": "

Specifies the number of records to include in a mini-batch for an HTTP inference\n request. A record\n is a single unit of input data that\n inference can be made on. For example, a single line in a CSV file is a record.

\n

To enable the batch strategy, you must set the SplitType property to\n Line, RecordIO, or TFRecord.

\n

To use only one record when making an HTTP invocation request to a container, set\n BatchStrategy to SingleRecord and SplitType\n to Line.

\n

To fit as many records in a mini-batch as can fit within the\n MaxPayloadInMB limit, set BatchStrategy to\n MultiRecord and SplitType to Line.

" + "smithy.api#documentation": "

Specifies the number of records to include in a mini-batch for an HTTP inference\n request. A record\n is a single unit of input data that\n inference can be made on. For example, a single line in a CSV file is a record.

\n

To enable the batch strategy, you must set the SplitType property to\n Line, RecordIO, or TFRecord.

\n

To use only one record when making an HTTP invocation request to a container, set\n BatchStrategy to SingleRecord and SplitType\n to Line.

\n

To fit as many records in a mini-batch as can fit within the\n MaxPayloadInMB limit, set BatchStrategy to\n MultiRecord and SplitType to Line.

" } }, "Environment": { @@ -9866,7 +9963,7 @@ "target": "com.amazonaws.sagemaker#CreateWorkforceResponse" }, "traits": { - "smithy.api#documentation": "

Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the Amazon Web Services Region that you specify. You can only\n create one workforce in each Amazon Web Services Region per Amazon Web Services account.

\n\n

If you want to create a new workforce in an Amazon Web Services Region where \n a workforce already exists, use the API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.

\n\n

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).

\n\n

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).

" + "smithy.api#documentation": "

Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the Amazon Web Services Region that you specify. You can only\n create one workforce in each Amazon Web Services Region per Amazon Web Services account.

\n

If you want to create a new workforce in an Amazon Web Services Region where \n a workforce already exists, use the API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.

\n

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).

\n

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).

" } }, "com.amazonaws.sagemaker#CreateWorkforceRequest": { @@ -9875,7 +9972,7 @@ "CognitoConfig": { "target": "com.amazonaws.sagemaker#CognitoConfig", "traits": { - "smithy.api#documentation": "

Use this parameter to configure an Amazon Cognito private workforce.\n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.

\n \n

Do not use OidcConfig if you specify values for \n CognitoConfig.

" + "smithy.api#documentation": "

Use this parameter to configure an Amazon Cognito private workforce.\n A single Cognito workforce is created using and corresponds to a single\n \n Amazon Cognito user pool.

\n

Do not use OidcConfig if you specify values for \n CognitoConfig.

" } }, "OidcConfig": { @@ -9937,7 +10034,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new work team for labeling your data. A work team is defined by one or more\n Amazon Cognito user pools. You must first create the user pools before you can create a work\n team.

\n

You cannot create more than 25 work teams in an account and region.

" + "smithy.api#documentation": "

Creates a new work team for labeling your data. A work team is defined by one or more\n Amazon Cognito user pools. You must first create the user pools before you can create a work\n team.

\n

You cannot create more than 25 work teams in an account and region.

" } }, "com.amazonaws.sagemaker#CreateWorkteamRequest": { @@ -9959,7 +10056,7 @@ "MemberDefinitions": { "target": "com.amazonaws.sagemaker#MemberDefinitions", "traits": { - "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For\n private workforces created using Amazon Cognito use CognitoMemberDefinition. For\n workforces created using your own OIDC identity provider (IdP) use\n OidcMemberDefinition. Do not provide input for both of these parameters\n in a single request.

\n

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.

\n

For workforces created using your own OIDC IdP, specify the user groups that you want to \n include in your private work team in OidcMemberDefinition by listing those groups\n in Groups.

", + "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For\n private workforces created using Amazon Cognito use CognitoMemberDefinition. For\n workforces created using your own OIDC identity provider (IdP) use\n OidcMemberDefinition. Do not provide input for both of these parameters\n in a single request.

\n

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.

\n

For workforces created using your own OIDC IdP, specify the user groups that you want to \n include in your private work team in OidcMemberDefinition by listing those groups\n in Groups.

", "smithy.api#required": {} } }, @@ -9979,7 +10076,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs.

\n

For more information, see Resource\n Tag and Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

An array of key-value pairs.

\n

For more information, see Resource\n Tag and Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.

" } } } @@ -10128,7 +10225,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt the\n captured data at rest using Amazon S3 server-side encryption.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" } }, "CaptureOptions": { @@ -10263,19 +10360,19 @@ "InputFilter": { "target": "com.amazonaws.sagemaker#JsonPath", "traits": { - "smithy.api#documentation": "

A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.

\n

Examples: \"$\", \"$[1:]\", \"$.features\"\n

" + "smithy.api#documentation": "

A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.

\n

Examples: \"$\", \"$[1:]\", \"$.features\"\n

" } }, "OutputFilter": { "target": "com.amazonaws.sagemaker#JsonPath", "traits": { - "smithy.api#documentation": "

A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.

\n

Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n

" + "smithy.api#documentation": "

A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.

\n

Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n

" } }, "JoinSource": { "target": "com.amazonaws.sagemaker#JoinSource", "traits": { - "smithy.api#documentation": "

Specifies the source of the data to join with the transformed data. The valid values\n are None and Input. The default value is None,\n which specifies not to join the input with the transformed data. If you want the batch\n transform job to join the original input data with the transformed data, set\n JoinSource to Input. You can specify\n OutputFilter as an additional filter to select a portion of the joined\n dataset and store it in the output file.

\n

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to\n the input JSON object in an attribute called SageMakerOutput. The joined\n result for JSON must be a key-value pair object. If the input is not a key-value pair\n object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored\n under the SageMakerInput key and the results are stored in\n SageMakerOutput.

\n

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with\n the input by appending each transformed row to the end of the input. The joined data has\n the original input data followed by the transformed data and the output is a CSV\n file.

\n

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

" + "smithy.api#documentation": "

Specifies the source of the data to join with the transformed data. The valid values\n are None and Input. The default value is None,\n which specifies not to join the input with the transformed data. If you want the batch\n transform job to join the original input data with the transformed data, set\n JoinSource to Input. You can specify\n OutputFilter as an additional filter to select a portion of the joined\n dataset and store it in the output file.

\n

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to\n the input JSON object in an attribute called SageMakerOutput. The joined\n result for JSON must be a key-value pair object. If the input is not a key-value pair\n object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored\n under the SageMakerInput key and the results are stored in\n SageMakerOutput.

\n

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with\n the input by appending each transformed row to the end of the input. The joined data has\n the original input data followed by the transformed data and the output is a CSV\n file.

\n

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

" } } }, @@ -10747,7 +10844,7 @@ "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

The user profile name.

" + "smithy.api#documentation": "

The user profile name. If this value is not set, then SpaceName must be set.

" } }, "AppType": { @@ -10767,7 +10864,7 @@ "SpaceName": { "target": "com.amazonaws.sagemaker#SpaceName", "traits": { - "smithy.api#documentation": "

The name of the space.

" + "smithy.api#documentation": "

The name of the space. If this value is not set, then UserProfileName must be set.

" } } } @@ -11104,7 +11201,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.

\n

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.

\n

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint\n resources such as KMS key grants. You might still see these resources in your account\n for a few minutes after deleting your endpoint. Do not delete or revoke the permissions\n for your \n ExecutionRoleArn\n , otherwise SageMaker cannot delete these\n resources.

" + "smithy.api#documentation": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.

\n

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.

\n

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint\n resources such as KMS key grants. You might still see these resources in your account\n for a few minutes after deleting your endpoint. Do not delete or revoke the permissions\n for your \n ExecutionRoleArn\n , otherwise SageMaker cannot delete these\n resources.

" } }, "com.amazonaws.sagemaker#DeleteEndpointConfig": { @@ -11116,7 +11213,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes an endpoint configuration. The DeleteEndpointConfig API\n deletes only the specified configuration. It does not delete endpoints created using the\n configuration.

\n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint operations\n are being performed on the endpoint. If you delete the EndpointConfig of an\n endpoint that is active or being created or updated you may lose visibility into the\n instance type the endpoint is using. The endpoint must be deleted in order to stop\n incurring charges.

" + "smithy.api#documentation": "

Deletes an endpoint configuration. The DeleteEndpointConfig API\n deletes only the specified configuration. It does not delete endpoints created using the\n configuration.

\n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint operations\n are being performed on the endpoint. If you delete the EndpointConfig of an\n endpoint that is active or being created or updated you may lose visibility into the\n instance type the endpoint is using. The endpoint must be deleted in order to stop\n incurring charges.

" } }, "com.amazonaws.sagemaker#DeleteEndpointConfigInput": { @@ -11428,15 +11525,20 @@ "ImageName": { "target": "com.amazonaws.sagemaker#ImageName", "traits": { - "smithy.api#documentation": "

The name of the image.

", + "smithy.api#documentation": "

The name of the image to delete.

", "smithy.api#required": {} } }, "Version": { "target": "com.amazonaws.sagemaker#ImageVersionNumber", "traits": { - "smithy.api#documentation": "

The version to delete.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The version to delete.

" + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The alias of the image to delete.

" } } } @@ -11462,7 +11564,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an inference experiment.

\n \n

\n This operation does not delete your endpoint, variants, or any underlying resources. This operation only\n deletes the metadata of your experiment.\n

\n " + "smithy.api#documentation": "

Deletes an inference experiment.

\n \n

\n This operation does not delete your endpoint, variants, or any underlying resources. This operation only\n deletes the metadata of your experiment.\n

\n " } }, "com.amazonaws.sagemaker#DeleteInferenceExperimentRequest": { @@ -11617,7 +11719,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a model package.

\n

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

" + "smithy.api#documentation": "

Deletes a model package.

\n

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

" } }, "com.amazonaws.sagemaker#DeleteModelPackageGroup": { @@ -11679,7 +11781,7 @@ "ModelPackageName": { "target": "com.amazonaws.sagemaker#VersionedArnOrName", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package to delete.

\n

When you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package to delete.

\n

When you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

", "smithy.api#required": {} } } @@ -11752,7 +11854,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you\n must call the StopNotebookInstance API.

\n \n

When you delete a notebook instance, you lose all of your data. SageMaker removes\n the ML compute instance, and deletes the ML storage volume and the network interface\n associated with the notebook instance.

\n " + "smithy.api#documentation": "

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you\n must call the StopNotebookInstance API.

\n \n

When you delete a notebook instance, you lose all of your data. SageMaker removes\n the ML compute instance, and deletes the ML storage volume and the network interface\n associated with the notebook instance.

\n " } }, "com.amazonaws.sagemaker#DeleteNotebookInstanceInput": { @@ -11948,7 +12050,7 @@ "target": "com.amazonaws.sagemaker#DeleteTagsOutput" }, "traits": { - "smithy.api#documentation": "

Deletes the specified tags from an SageMaker resource.

\n

To list a resource's tags, use the ListTags API.

\n \n

When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

\n \n \n

When you call this API to delete tags from a SageMaker Studio Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain\n or User Profile launched before you called this API.

\n " + "smithy.api#documentation": "

Deletes the specified tags from an SageMaker resource.

\n

To list a resource's tags, use the ListTags API.

\n \n

When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

\n \n \n

When you call this API to delete tags from a SageMaker Studio Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain\n or User Profile launched before you called this API.

\n " } }, "com.amazonaws.sagemaker#DeleteTagsInput": { @@ -12102,7 +12204,7 @@ "target": "com.amazonaws.sagemaker#DeleteWorkforceResponse" }, "traits": { - "smithy.api#documentation": "

Use this operation to delete a workforce.

\n\n

If you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use \n to create a new workforce.

\n \n

If a private workforce contains one or more work teams, you must use \n the \n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will recieve a ResourceInUse error.

\n " + "smithy.api#documentation": "

Use this operation to delete a workforce.

\n

If you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use \n to create a new workforce.

\n \n

If a private workforce contains one or more work teams, you must use \n the \n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will recieve a ResourceInUse error.

\n " } }, "com.amazonaws.sagemaker#DeleteWorkforceRequest": { @@ -12206,7 +12308,7 @@ } }, "traits": { - "smithy.api#documentation": "

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

\n

If you used the registry/repository[:tag] form to specify the image path\n of the primary container when you created the model hosted in this\n ProductionVariant, the path resolves to a path of the form\n registry/repository[@digest]. A digest is a hash value that identifies\n a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

" + "smithy.api#documentation": "

Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

\n

If you used the registry/repository[:tag] form to specify the image path\n of the primary container when you created the model hosted in this\n ProductionVariant, the path resolves to a path of the form\n registry/repository[@digest]. A digest is a hash value that identifies\n a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

" } }, "com.amazonaws.sagemaker#DeployedImages": { @@ -12651,7 +12753,7 @@ "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

The user profile name.

" + "smithy.api#documentation": "

The user profile name. If this value is not set, then SpaceName must be set.

" } }, "AppType": { @@ -12748,7 +12850,7 @@ "SpaceName": { "target": "com.amazonaws.sagemaker#SpaceName", "traits": { - "smithy.api#documentation": "

The name of the space.

" + "smithy.api#documentation": "

The name of the space. If this value is not set, then UserProfileName must be set.

" } } } @@ -12964,7 +13066,7 @@ "BestCandidate": { "target": "com.amazonaws.sagemaker#AutoMLCandidate", "traits": { - "smithy.api#documentation": "

Returns the job's best AutoMLCandidate.

" + "smithy.api#documentation": "

The best model candidate selected by SageMaker Autopilot using both the best objective metric and\n lowest InferenceLatency for\n an experiment.

" } }, "AutoMLJobStatus": { @@ -13091,7 +13193,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a model compilation job.

\n

To create a model compilation job, use CreateCompilationJob. To get\n information about multiple model compilation jobs, use ListCompilationJobs.

" + "smithy.api#documentation": "

Returns information about a model compilation job.

\n

To create a model compilation job, use CreateCompilationJob. To get\n information about multiple model compilation jobs, use ListCompilationJobs.

" } }, "com.amazonaws.sagemaker#DescribeCompilationJobRequest": { @@ -13133,7 +13235,7 @@ "CompilationStartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

The time when the model compilation job started the CompilationJob\n instances.

\n

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs,\n the start time might be later than this time. That's because it takes time to download\n the compilation job, which depends on the size of the compilation job container.

" + "smithy.api#documentation": "

The time when the model compilation job started the CompilationJob\n instances.

\n

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs,\n the start time might be later than this time. That's because it takes time to download\n the compilation job, which depends on the size of the compilation job container.

" } }, "CompilationEndTime": { @@ -14184,7 +14286,7 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantList", "traits": { - "smithy.api#documentation": "

\n Array of ProductionVariant objects. There is one for each model that you want to host at this\n endpoint in shadow mode with production traffic replicated from the model specified on\n ProductionVariants.If you use this field, you can only specify one variant for\n ProductionVariants and one variant for ShadowProductionVariants.\n

" + "smithy.api#documentation": "

An array of ProductionVariant objects, one for each model that you want\n to host at this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants.

" } } } @@ -14228,7 +14330,7 @@ "ProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "

An array of ProductionVariantSummary objects, one for each model\n hosted behind this endpoint.

" + "smithy.api#documentation": "

An array of ProductionVariantSummary objects, one for each model\n hosted behind this endpoint.

" } }, "DataCaptureConfig": { @@ -14237,7 +14339,7 @@ "EndpointStatus": { "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "

The status of the endpoint.

\n
    \n
  • \n

    \n OutOfService: Endpoint is not available to take incoming\n requests.

    \n
    • \n
  • \n

    \n Creating: CreateEndpoint is executing.

    \n
    • \n
  • \n

    \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

    \n
    • \n
  • \n

    \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

    \n
    • \n
  • \n

    \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

    \n
    • \n
  • \n

    \n InService: Endpoint is available to process incoming\n requests.

    \n
    • \n
  • \n

    \n Deleting: DeleteEndpoint is executing.

    \n
    • \n
  • \n

    \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.

    \n
    • \n
", + "smithy.api#documentation": "

The status of the endpoint.

\n
    \n
  • \n

    \n OutOfService: Endpoint is not available to take incoming\n requests.

    \n
    • \n
  • \n

    \n Creating: CreateEndpoint is executing.

    \n
    • \n
  • \n

    \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

    \n
    • \n
  • \n

    \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

    \n
    • \n
  • \n

    \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

    \n
    • \n
  • \n

    \n InService: Endpoint is available to process incoming\n requests.

    \n
    • \n
  • \n

    \n Deleting: DeleteEndpoint is executing.

    \n
    • \n
  • \n

    \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -14288,7 +14390,7 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "

\n Array of ProductionVariant objects. There is one for each model that you want to host at this\n endpoint in shadow mode with production traffic replicated from the model specified on\n ProductionVariants.If you use this field, you can only specify one variant for\n ProductionVariants and one variant for ShadowProductionVariants.\n

" + "smithy.api#documentation": "

An array of ProductionVariantSummary objects, one for each model\n that you want to host at this endpoint in shadow mode with production traffic\n replicated from the model specified on ProductionVariants.

" } } } @@ -14476,13 +14578,13 @@ "OfflineStoreConfig": { "target": "com.amazonaws.sagemaker#OfflineStoreConfig", "traits": { - "smithy.api#documentation": "

The configuration of the OfflineStore, inducing the S3 location of the\n OfflineStore, Amazon Web Services Glue or Amazon Web Services Hive data catalogue configurations, and the\n security configuration.

" + "smithy.api#documentation": "

The configuration of the offline store. It includes the following configurations:

\n
    \n
  • \n

    Amazon S3 location of the offline store.

    \n
    • \n
  • \n

    Configuration of the Glue data catalog.

    \n
    • \n
  • \n

    Table format of the offline store.

    \n
    • \n
  • \n

    Option to disable the automatic creation of a Glue table for the offline store.

    \n
    • \n
  • \n

    Encryption configuration.

    \n
    • \n
" } }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the\n OfflineStore if an OfflineStoreConfig is provided.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

" } }, "FeatureGroupStatus": { @@ -15336,7 +15438,7 @@ "ImageArn": { "target": "com.amazonaws.sagemaker#ImageArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

" + "smithy.api#documentation": "

The ARN of the image.

" } }, "ImageName": { @@ -15360,7 +15462,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

" + "smithy.api#documentation": "

The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

" } } } @@ -15460,6 +15562,12 @@ "traits": { "smithy.api#documentation": "

The version of the image. If not specified, the latest version is described.

" } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The alias of the image version.

" + } } } }, @@ -15493,7 +15601,7 @@ "ImageArn": { "target": "com.amazonaws.sagemaker#ImageArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image the version is based on.

" + "smithy.api#documentation": "

The ARN of the image the version is based on.

" } }, "ImageVersionArn": { @@ -15519,6 +15627,49 @@ "traits": { "smithy.api#documentation": "

The version number.

" } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "

The stability of the image version specified by the maintainer.

\n
    \n
  • \n

    \n NOT_PROVIDED: The maintainers did not provide a status for image version stability.

    \n
    • \n
  • \n

    \n STABLE: The image version is stable.

    \n
    • \n
  • \n

    \n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

    \n
    • \n
  • \n

    \n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

    \n
    • \n
" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#JobType", + "traits": { + "smithy.api#documentation": "

Indicates SageMaker job type compatibility.

\n
    \n
  • \n

    \n TRAINING: The image version is compatible with SageMaker training jobs.

    \n
    • \n
  • \n

    \n INFERENCE: The image version is compatible with SageMaker inference jobs.

    \n
    • \n
  • \n

    \n NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

    \n
    • \n
" + } + }, + "MLFramework": { + "target": "com.amazonaws.sagemaker#MLFramework", + "traits": { + "smithy.api#documentation": "

The machine learning framework vended in the image version.

" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "

The supported programming language and its version.

" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "

Indicates CPU or GPU compatibility.

\n
    \n
  • \n

    \n CPU: The image version is compatible with CPU.

    \n
    • \n
  • \n

    \n GPU: The image version is compatible with GPU.

    \n
    • \n
" + } + }, + "Horovod": { + "target": "com.amazonaws.sagemaker#Horovod", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates Horovod compatibility.

" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "

The maintainer description of the image version.

" + } } } }, @@ -15584,14 +15735,14 @@ "Status": { "target": "com.amazonaws.sagemaker#InferenceExperimentStatus", "traits": { - "smithy.api#documentation": "

\n The status of the inference experiment. The following are the possible statuses for an inference\n experiment:\n

\n
    \n
  • \n

    \n Creating - Amazon SageMaker is creating your experiment.\n

    \n
    • \n
  • \n

    \n Created - Amazon SageMaker has finished creating your experiment and it will begin at the scheduled time.\n

    \n
    • \n
  • \n

    \n Updating - When you make changes to your experiment, your experiment shows as updating.\n

    \n
    • \n
  • \n

    \n Starting - Amazon SageMaker is beginning your experiment.\n

    \n
    • \n
  • \n

    \n Running - Your experiment is in progress.\n

    \n
    • \n
  • \n

    \n Stopping - Amazon SageMaker is stopping your experiment.\n

    \n
    • \n
  • \n

    \n Completed - Your experiment has completed.\n

    \n
    • \n
  • \n

    \n Cancelled - When you conclude your experiment early, it shows as canceled.\n

    \n
    • \n
", + "smithy.api#documentation": "

\n The status of the inference experiment. The following are the possible statuses for an inference\n experiment:\n

\n
    \n
  • \n

    \n Creating - Amazon SageMaker is creating your experiment.\n

    \n
    • \n
  • \n

    \n Created - Amazon SageMaker has finished the creation of your experiment and will begin the\n experiment at the scheduled time.\n

    \n
    • \n
  • \n

    \n Updating - When you make changes to your experiment, your experiment shows as updating.\n

    \n
    • \n
  • \n

    \n Starting - Amazon SageMaker is beginning your experiment.\n

    \n
    • \n
  • \n

    \n Running - Your experiment is in progress.\n

    \n
    • \n
  • \n

    \n Stopping - Amazon SageMaker is stopping your experiment.\n

    \n
    • \n
  • \n

    \n Completed - Your experiment has completed.\n

    \n
    • \n
  • \n

    \n Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows\n as cancelled.\n

    \n
    • \n
", "smithy.api#required": {} } }, "StatusReason": { "target": "com.amazonaws.sagemaker#InferenceExperimentStatusReason", "traits": { - "smithy.api#documentation": "

The error message for the inference experiment status result.

" + "smithy.api#documentation": "

\n The error message or client-specified Reason from the StopInferenceExperiment\n API, that explains the status of the inference experiment.\n

" } }, "Description": { @@ -15609,7 +15760,7 @@ "CompletionTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

\n The timestamp at which the inference experiment was completed or will complete.\n

" + "smithy.api#documentation": "

\n The timestamp at which the inference experiment was completed.\n

" } }, "LastModifiedTime": { @@ -15621,7 +15772,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images.\n

" + "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n

" } }, "EndpointMetadata": { @@ -15634,20 +15785,20 @@ "ModelVariants": { "target": "com.amazonaws.sagemaker#ModelVariantConfigSummaryList", "traits": { - "smithy.api#documentation": "

\n Array of ModelVariantConfigSummary objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure\n configuration for deploying the corresponding variant.\n

", + "smithy.api#documentation": "

\n An array of ModelVariantConfigSummary objects. There is one for each variant in the inference\n experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure\n configuration for deploying the corresponding variant.\n

", "smithy.api#required": {} } }, "DataStorageConfig": { "target": "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig", "traits": { - "smithy.api#documentation": "

The Amazon S3 storage configuration for the inference experiment.

" + "smithy.api#documentation": "

The Amazon S3 location and configuration for storing inference request and response data.

" } }, "ShadowModeConfig": { "target": "com.amazonaws.sagemaker#ShadowModeConfig", "traits": { - "smithy.api#documentation": "

\n Shows which variant is a production variant and which variant is a shadow variant. For shadow\n variants, also shows the sampling percentage.\n

" + "smithy.api#documentation": "

\n The configuration of ShadowMode inference experiment type, which shows the production variant\n that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.\n

" } }, "KmsKey": { @@ -15901,7 +16052,7 @@ "LabelCategoryConfigS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the JSON file that defines the categories used to label data\n objects. Please note the following label-category limits:

\n
    \n
  • \n

    Semantic segmentation labeling jobs using automated labeling: 20 labels

    \n
    • \n
  • \n

    Box bounding labeling jobs (all): 10 labels

    \n
    • \n
\n

The file is a JSON structure in the following format:

\n

\n {\n

\n

\n \"document-version\": \"2018-11-28\"\n

\n

\n \"labels\": [\n

\n

\n {\n

\n

\n \"label\": \"label 1\"\n

\n

\n },\n

\n

\n {\n

\n

\n \"label\": \"label 2\"\n

\n

\n },\n

\n

\n ...\n

\n

\n {\n

\n

\n \"label\": \"label n\"\n

\n

\n }\n

\n

\n ]\n

\n

\n }\n

" + "smithy.api#documentation": "

The S3 location of the JSON file that defines the categories used to label data\n objects. Please note the following label-category limits:

\n
    \n
  • \n

    Semantic segmentation labeling jobs using automated labeling: 20 labels

    \n
    • \n
  • \n

    Box bounding labeling jobs (all): 10 labels

    \n
    • \n
\n

The file is a JSON structure in the following format:

\n

\n {\n

\n

\n \"document-version\": \"2018-11-28\"\n

\n

\n \"labels\": [\n

\n

\n {\n

\n

\n \"label\": \"label 1\"\n

\n

\n },\n

\n

\n {\n

\n

\n \"label\": \"label 2\"\n

\n

\n },\n

\n

\n ...\n

\n

\n {\n

\n

\n \"label\": \"label n\"\n

\n

\n }\n

\n

\n ]\n

\n

\n }\n

" } }, "StoppingConditions": { @@ -16530,7 +16681,7 @@ "target": "com.amazonaws.sagemaker#DescribeModelPackageOutput" }, "traits": { - "smithy.api#documentation": "

Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.

\n

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.

" + "smithy.api#documentation": "

Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.

\n

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#DescribeModelPackageGroup": { @@ -16608,7 +16759,7 @@ "ModelPackageName": { "target": "com.amazonaws.sagemaker#VersionedArnOrName", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package to describe.

\n

When you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package to describe.

\n

When you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

", "smithy.api#required": {} } } @@ -17078,7 +17229,7 @@ "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigOutput" }, "traits": { - "smithy.api#documentation": "

Returns a description of a notebook instance lifecycle configuration.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" + "smithy.api#documentation": "

Returns a description of a notebook instance lifecycle configuration.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" } }, "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfigInput": { @@ -17218,13 +17369,13 @@ "NotebookInstanceLifecycleConfigName": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", "traits": { - "smithy.api#documentation": "

Returns the name of a notebook instance lifecycle configuration.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance\n

" + "smithy.api#documentation": "

Returns the name of a notebook instance lifecycle configuration.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance\n

" } }, "DirectInternetAccess": { "target": "com.amazonaws.sagemaker#DirectInternetAccess", "traits": { - "smithy.api#documentation": "

Describes whether SageMaker provides internet access to the notebook instance. If this\n value is set to Disabled, the notebook instance does not have\n internet access, and cannot connect to SageMaker training and endpoint services.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default.

" + "smithy.api#documentation": "

Describes whether SageMaker provides internet access to the notebook instance. If this\n value is set to Disabled, the notebook instance does not have\n internet access, and cannot connect to SageMaker training and endpoint services.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default.

" } }, "VolumeSizeInGB": { @@ -17254,7 +17405,7 @@ "RootAccess": { "target": "com.amazonaws.sagemaker#RootAccess", "traits": { - "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance.

\n \n

Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

\n " + "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance.

\n \n

Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

\n " } }, "PlatformIdentifier": { @@ -18042,7 +18193,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a training job.

\n

Some of the attributes below only appear if the training job successfully starts.\n If the training job fails, TrainingJobStatus is Failed and,\n depending on the FailureReason, attributes like\n TrainingStartTime, TrainingTimeInSeconds,\n TrainingEndTime, and BillableTimeInSeconds may not be\n present in the response.

", + "smithy.api#documentation": "

Returns information about a training job.

\n

Some of the attributes below only appear if the training job successfully starts.\n If the training job fails, TrainingJobStatus is Failed and,\n depending on the FailureReason, attributes like\n TrainingStartTime, TrainingTimeInSeconds,\n TrainingEndTime, and BillableTimeInSeconds may not be\n present in the response.

", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -18148,14 +18299,14 @@ "TrainingJobStatus": { "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "

The status of the training job.

\n

SageMaker provides the following training job statuses:

\n
    \n
  • \n

    \n InProgress - The training is in progress.

    \n
    • \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
  • \n

    \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

    \n
    • \n
  • \n

    \n Stopping - The training job is stopping.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n

For more detailed information, see SecondaryStatus.

", + "smithy.api#documentation": "

The status of the training job.

\n

SageMaker provides the following training job statuses:

\n
    \n
  • \n

    \n InProgress - The training is in progress.

    \n
    • \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
  • \n

    \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

    \n
    • \n
  • \n

    \n Stopping - The training job is stopping.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n

For more detailed information, see SecondaryStatus.

", "smithy.api#required": {} } }, "SecondaryStatus": { "target": "com.amazonaws.sagemaker#SecondaryStatus", "traits": { - "smithy.api#documentation": "

Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.

\n

SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Interrupted - The job stopped because the managed\n spot training instances were interrupted.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n \n \n

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTraining\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
", + "smithy.api#documentation": "

Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.

\n

SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Interrupted - The job stopped because the managed\n spot training instances were interrupted.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n \n

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTraining\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -18212,7 +18363,7 @@ "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

", + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

", "smithy.api#required": {} } }, @@ -18286,7 +18437,7 @@ "BillableTimeInSeconds": { "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", "traits": { - "smithy.api#documentation": "

The billable time in seconds. Billable time refers to the absolute wall-clock\n time.

\n

Multiply BillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run distributed training. The formula is as follows:\n BillableTimeInSeconds * InstanceCount .

\n

You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.

" + "smithy.api#documentation": "

The billable time in seconds. Billable time refers to the absolute wall-clock\n time.

\n

Multiply BillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run distributed training. The formula is as follows:\n BillableTimeInSeconds * InstanceCount .

\n

You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.

" } }, "DebugHookConfig": { @@ -18484,7 +18635,7 @@ "BatchStrategy": { "target": "com.amazonaws.sagemaker#BatchStrategy", "traits": { - "smithy.api#documentation": "

Specifies the number of records to include in a mini-batch for an HTTP inference\n request.\n A record\n is a single unit of input data that inference\n can be made on. For example, a single line in a CSV file is a record.

\n

To enable the batch strategy, you must set SplitType\n to\n Line, RecordIO, or\n TFRecord.

" + "smithy.api#documentation": "

Specifies the number of records to include in a mini-batch for an HTTP inference\n request.\n A record\n is a single unit of input data that inference\n can be made on. For example, a single line in a CSV file is a record.

\n

To enable the batch strategy, you must set SplitType\n to\n Line, RecordIO, or\n TFRecord.

" } }, "Environment": { @@ -18709,7 +18860,7 @@ "Sources": { "target": "com.amazonaws.sagemaker#TrialComponentSources", "traits": { - "smithy.api#documentation": "

A list of the Amazon Resource Name (ARN) and, if applicable, job type for multiple sources of an experiment run.

" + "smithy.api#documentation": "

A list of ARNs and, if applicable, job types for multiple sources of an experiment\n run.

" } } } @@ -18904,7 +19055,7 @@ "target": "com.amazonaws.sagemaker#DescribeWorkforceResponse" }, "traits": { - "smithy.api#documentation": "

Lists private workforce information, including workforce name, Amazon Resource Name\n (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address\n ranges are the IP addresses that workers can use to access tasks.

\n \n

This operation applies only to private workforces.

\n " + "smithy.api#documentation": "

Lists private workforce information, including workforce name, Amazon Resource Name\n (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address\n ranges are the IP addresses that workers can use to access tasks.

\n \n

This operation applies only to private workforces.

\n " } }, "com.amazonaws.sagemaker#DescribeWorkforceRequest": { @@ -20678,7 +20829,7 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "

\n Array of ProductionVariant objects, one for each model that you want to host at this endpoint\n in shadow mode with production traffic replicated from the model specified on\n ProductionVariants.If you use this field, you can only specify one variant for\n ProductionVariants and one variant for ShadowProductionVariants.\n

" + "smithy.api#documentation": "

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model\n in shadow mode with production traffic replicated from the proudction variant.

" } } }, @@ -20927,7 +21078,7 @@ "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { - "smithy.api#documentation": "

\n If the status of the endpoint is Failed, this provides the reason why it failed.\n

" + "smithy.api#documentation": "

\n If the status of the endpoint is Failed, or the status is InService but update\n operation fails, this provides the reason why it failed.\n

" } } }, @@ -21135,7 +21286,7 @@ "EndpointStatus": { "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "

The status of the endpoint.

\n
    \n
  • \n

    \n OutOfService: Endpoint is not available to take incoming\n requests.

    \n
    • \n
  • \n

    \n Creating: CreateEndpoint is executing.

    \n
    • \n
  • \n

    \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

    \n
    • \n
  • \n

    \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

    \n
    • \n
  • \n

    \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

    \n
    • \n
  • \n

    \n InService: Endpoint is available to process incoming\n requests.

    \n
    • \n
  • \n

    \n Deleting: DeleteEndpoint is executing.

    \n
    • \n
  • \n

    \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.

    \n
    • \n
\n

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

", + "smithy.api#documentation": "

The status of the endpoint.

\n
    \n
  • \n

    \n OutOfService: Endpoint is not available to take incoming\n requests.

    \n
    • \n
  • \n

    \n Creating: CreateEndpoint is executing.

    \n
    • \n
  • \n

    \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

    \n
    • \n
  • \n

    \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

    \n
    • \n
  • \n

    \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

    \n
    • \n
  • \n

    \n InService: Endpoint is available to process incoming\n requests.

    \n
    • \n
  • \n

    \n Deleting: DeleteEndpoint is executing.

    \n
    • \n
  • \n

    \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.

    \n
    • \n
\n

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

", "smithy.api#required": {} } } @@ -21424,7 +21575,7 @@ "ExperimentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of an existing experiment to associate the trial component with.

" + "smithy.api#documentation": "

The name of an existing experiment to associate with the trial component.

" } }, "TrialName": { @@ -21442,7 +21593,7 @@ "RunName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of the experiment run to associate the trial component with.

" + "smithy.api#documentation": "

The name of the experiment run to associate with the trial component.

" } } }, @@ -21715,7 +21866,7 @@ "RecordIdentifierFeatureName": { "target": "com.amazonaws.sagemaker#FeatureName", "traits": { - "smithy.api#documentation": "

The name of the Feature whose value uniquely identifies a\n Record defined in the FeatureGroup \n FeatureDefinitions.

" + "smithy.api#documentation": "

The name of the Feature whose value uniquely identifies a\n Record defined in the FeatureGroup\n FeatureDefinitions.

" } }, "EventTimeFeatureName": { @@ -22298,7 +22449,7 @@ } }, "traits": { - "smithy.api#documentation": "

A conditional statement for a search expression that includes a resource property, a\n Boolean operator, and a value. Resources that match the statement are returned in the\n results from the Search API.

\n \n

If you specify a Value, but not an Operator, Amazon SageMaker uses the\n equals operator.

\n

In search, there are several property types:

\n
\n
Metrics
\n
\n

To define a metric filter, enter a value using the form\n \"Metrics.\", where is\n a metric name. For example, the following filter searches for training jobs\n with an \"accuracy\" metric greater than\n \"0.9\":

\n

\n {\n

\n

\n \"Name\": \"Metrics.accuracy\",\n

\n

\n \"Operator\": \"GreaterThan\",\n

\n

\n \"Value\": \"0.9\"\n

\n

\n }\n

\n
\n
HyperParameters
\n
\n

To define a hyperparameter filter, enter a value with the form\n \"HyperParameters.\". Decimal hyperparameter\n values are treated as a decimal in a comparison if the specified\n Value is also a decimal value. If the specified\n Value is an integer, the decimal hyperparameter values are\n treated as integers. For example, the following filter is satisfied by\n training jobs with a \"learning_rate\" hyperparameter that is\n less than \"0.5\":

\n

\n {\n

\n

\n \"Name\": \"HyperParameters.learning_rate\",\n

\n

\n \"Operator\": \"LessThan\",\n

\n

\n \"Value\": \"0.5\"\n

\n

\n }\n

\n
\n
Tags
\n
\n

To define a tag filter, enter a value with the form\n Tags..

\n
\n
" + "smithy.api#documentation": "

A conditional statement for a search expression that includes a resource property, a\n Boolean operator, and a value. Resources that match the statement are returned in the\n results from the Search API.

\n

If you specify a Value, but not an Operator, Amazon SageMaker uses the\n equals operator.

\n

In search, there are several property types:

\n
\n
Metrics
\n
\n

To define a metric filter, enter a value using the form\n \"Metrics.\", where is\n a metric name. For example, the following filter searches for training jobs\n with an \"accuracy\" metric greater than\n \"0.9\":

\n

\n {\n

\n

\n \"Name\": \"Metrics.accuracy\",\n

\n

\n \"Operator\": \"GreaterThan\",\n

\n

\n \"Value\": \"0.9\"\n

\n

\n }\n

\n
\n
HyperParameters
\n
\n

To define a hyperparameter filter, enter a value with the form\n \"HyperParameters.\". Decimal hyperparameter\n values are treated as a decimal in a comparison if the specified\n Value is also a decimal value. If the specified\n Value is an integer, the decimal hyperparameter values are\n treated as integers. For example, the following filter is satisfied by\n training jobs with a \"learning_rate\" hyperparameter that is\n less than \"0.5\":

\n

\n {\n

\n

\n \"Name\": \"HyperParameters.learning_rate\",\n

\n

\n \"Operator\": \"LessThan\",\n

\n

\n \"Value\": \"0.5\"\n

\n

\n }\n

\n
\n
Tags
\n
\n

To define a tag filter, enter a value with the form\n Tags..

\n
\n
" } }, "com.amazonaws.sagemaker#FilterList": { @@ -22909,7 +23060,7 @@ "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" } } }, @@ -22923,7 +23074,7 @@ "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that\n contains the credentials used to access the git repository. The secret must have a\n staging label of AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" } } }, @@ -22974,6 +23125,12 @@ } } }, + "com.amazonaws.sagemaker#Horovod": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.sagemaker#HubArn": { "type": "string", "traits": { @@ -23592,7 +23749,7 @@ "PreHumanTaskLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

\n

For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

\n \n \n\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n

    \n
    • \n
\n \n\n

\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n

    \n
    • \n
\n \n

\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
\n \n

\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n

    \n
    • \n
\n \n

\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n

    \n
    • \n
\n \n

\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
\n \n

\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n

    \n
    • \n
\n \n \n \n \n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n \n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n

    \n
    • \n
\n \n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n \n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n

    \n
    • \n
\n \n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n

    \n
    • \n
\n \n \n \n\n

\n 3D Point Cloud Modalities\n

\n

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

\n\n \n

\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
\n \n

\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
\n \n \n \n

\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n \n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n \n

\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox\n

    \n
    • \n
\n \n

\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
\n \n

\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
\n \n

\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n \n \n \n \n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n \n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n \n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n \n \n \n \n

\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n \n

\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n \n

\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

\n

For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n

    \n
    • \n
\n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Modalities\n

\n

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

\n

\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n

\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox\n

    \n
    • \n
\n

\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
\n

\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n

\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -23626,14 +23783,14 @@ "TaskTimeLimitInSeconds": { "target": "com.amazonaws.sagemaker#TaskTimeLimitInSeconds", "traits": { - "smithy.api#documentation": "

The amount of time that a worker has to complete a task.

\n

If you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).

\n

If you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:

\n
    \n
  • \n

    For image and \n text labeling jobs,\n the maximum is 8 hours (28,800 seconds).

    \n
    • \n
  • \n

    For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

    \n
    • \n
", + "smithy.api#documentation": "

The amount of time that a worker has to complete a task.

\n

If you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).

\n

If you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:

\n
    \n
  • \n

    For image and \n text labeling jobs,\n the maximum is 8 hours (28,800 seconds).

    \n
    • \n
  • \n

    For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

    \n
    • \n
", "smithy.api#required": {} } }, "TaskAvailabilityLifetimeInSeconds": { "target": "com.amazonaws.sagemaker#TaskAvailabilityLifetimeInSeconds", "traits": { - "smithy.api#documentation": "

The length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.

\n
    \n
  • \n

    If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds).\n The default is 6 hours (21,600 seconds).

    \n
    • \n
  • \n

    If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

    \n
    • \n
" + "smithy.api#documentation": "

The length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.

\n
    \n
  • \n

    If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds).\n The default is 6 hours (21,600 seconds).

    \n
    • \n
  • \n

    If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

    \n
    • \n
" } }, "MaxConcurrentTaskCount": { @@ -23926,7 +24083,7 @@ "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "

The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.

\n

Storage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.

\n \n

If you want to use hyperparameter optimization with instance type flexibility, use\n HyperParameterTuningResourceConfig instead.

\n " + "smithy.api#documentation": "

The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.

\n

Storage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.

\n \n

If you want to use hyperparameter optimization with instance type flexibility, use\n HyperParameterTuningResourceConfig instead.

\n " } }, "StoppingCondition": { @@ -24082,7 +24239,7 @@ "ObjectiveStatus": { "target": "com.amazonaws.sagemaker#ObjectiveStatus", "traits": { - "smithy.api#documentation": "

The status of the objective metric for the training job:

\n
    \n
  • \n

    Succeeded: The\n final\n objective metric for the training job was evaluated by the\n hyperparameter tuning job and\n used\n in the hyperparameter tuning process.

    \n
    • \n
\n
    \n
  • \n

    Pending: The training job is in progress and evaluation of its final objective\n metric is pending.

    \n
    • \n
\n
    \n
  • \n

    Failed:\n The final objective metric for the training job was not evaluated, and was not\n used in the hyperparameter tuning process. This typically occurs when the\n training job failed or did not emit an objective\n metric.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the objective metric for the training job:

\n
    \n
  • \n

    Succeeded: The\n final\n objective metric for the training job was evaluated by the\n hyperparameter tuning job and\n used\n in the hyperparameter tuning process.

    \n
    • \n
\n
    \n
  • \n

    Pending: The training job is in progress and evaluation of its final objective\n metric is pending.

    \n
    • \n
\n
    \n
  • \n

    Failed:\n The final objective metric for the training job was not evaluated, and was not\n used in the hyperparameter tuning process. This typically occurs when the\n training job failed or did not emit an objective\n metric.

    \n
    • \n
" } } }, @@ -24173,26 +24330,26 @@ "HyperParameterTuningJobObjective": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobObjective", "traits": { - "smithy.api#documentation": "

The HyperParameterTuningJobObjective object that specifies the\n objective\n metric for this tuning job.

" + "smithy.api#documentation": "

The HyperParameterTuningJobObjective specifies the objective metric\n used to evaluate the performance of training jobs launched by this tuning job.

" } }, "ResourceLimits": { "target": "com.amazonaws.sagemaker#ResourceLimits", "traits": { - "smithy.api#documentation": "

The ResourceLimits object that specifies the\n maximum\n number of training jobs and parallel training jobs for this tuning\n job.

", + "smithy.api#documentation": "

The ResourceLimits object that specifies the maximum number of\n training and parallel training jobs that can be used for this hyperparameter tuning\n job.

", "smithy.api#required": {} } }, "ParameterRanges": { "target": "com.amazonaws.sagemaker#ParameterRanges", "traits": { - "smithy.api#documentation": "

The ParameterRanges object that specifies the ranges of\n hyperparameters\n that this tuning job searches.

" + "smithy.api#documentation": "

The ParameterRanges object that specifies the ranges of\n hyperparameters that this tuning job searches over to find the optimal configuration for\n the highest model performance against your chosen objective metric.

" } }, "TrainingJobEarlyStoppingType": { "target": "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType", "traits": { - "smithy.api#documentation": "

Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. Because the Hyperband strategy has its own\n advanced internal early stopping mechanism, TrainingJobEarlyStoppingType\n must be OFF to use Hyperband. This parameter can take on one\n of the following values (the default value is OFF):

\n
\n
OFF
\n
\n

Training jobs launched by the hyperparameter tuning job do not use early\n stopping.

\n
\n
AUTO
\n
\n

SageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.

\n
\n
" + "smithy.api#documentation": "

Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. Because the Hyperband strategy has its own\n advanced internal early stopping mechanism, TrainingJobEarlyStoppingType\n must be OFF to use Hyperband. This parameter can take on one\n of the following values (the default value is OFF):

\n
\n
OFF
\n
\n

Training jobs launched by the hyperparameter tuning job do not use early\n stopping.

\n
\n
AUTO
\n
\n

SageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.

\n
\n
" } }, "TuningJobCompletionCriteria": { @@ -24200,6 +24357,12 @@ "traits": { "smithy.api#documentation": "

The tuning job's completion criteria.

" } + }, + "RandomSeed": { + "target": "com.amazonaws.sagemaker#RandomSeed", + "traits": { + "smithy.api#documentation": "

A value used to initialize a pseudo-random number generator. Setting a random seed and\n using the same seed later for the same tuning job will allow hyperparameter optimization\n to find more a consistent hyperparameter configuration between the two runs.

" + } } }, "traits": { @@ -24535,20 +24698,20 @@ "ParentHyperParameterTuningJobs": { "target": "com.amazonaws.sagemaker#ParentHyperParameterTuningJobs", "traits": { - "smithy.api#documentation": "

An array of hyperparameter tuning jobs that are used as the starting point for the new\n hyperparameter tuning job. For more information about warm starting a hyperparameter\n tuning job, see Using a Previous\n Hyperparameter Tuning Job as a Starting Point.

\n

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent\n jobs for warm start tuning jobs.

", + "smithy.api#documentation": "

An array of hyperparameter tuning jobs that are used as the starting point for the new\n hyperparameter tuning job. For more information about warm starting a hyperparameter\n tuning job, see Using a Previous\n Hyperparameter Tuning Job as a Starting Point.

\n

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent\n jobs for warm start tuning jobs.

", "smithy.api#required": {} } }, "WarmStartType": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType", "traits": { - "smithy.api#documentation": "

Specifies one of the following:

\n
\n
IDENTICAL_DATA_AND_ALGORITHM
\n
\n

The new hyperparameter tuning job uses the same input data and training\n image as the parent tuning jobs. You can change the hyperparameter ranges to\n search and the maximum number of training jobs that the hyperparameter\n tuning job launches. You cannot use a new version of the training algorithm,\n unless the changes in the new version do not affect the algorithm itself.\n For example, changes that improve logging or adding support for a different\n data format are allowed. You can also change hyperparameters from tunable to\n static, and from static to tunable, but the total number of static plus\n tunable hyperparameters must remain the same as it is in all parent jobs.\n The objective metric for the new tuning job must be the same as for all\n parent jobs.

\n
\n
TRANSFER_LEARNING
\n
\n

The new hyperparameter tuning job can include input data, hyperparameter\n ranges, maximum number of concurrent training jobs, and maximum number of\n training jobs that are different than those of its parent hyperparameter\n tuning jobs. The training image can also be a different version from the\n version used in the parent hyperparameter tuning job. You can also change\n hyperparameters from tunable to static, and from static to tunable, but the\n total number of static plus tunable hyperparameters must remain the same as\n it is in all parent jobs. The objective metric for the new tuning job must\n be the same as for all parent jobs.

\n
\n
", + "smithy.api#documentation": "

Specifies one of the following:

\n
\n
IDENTICAL_DATA_AND_ALGORITHM
\n
\n

The new hyperparameter tuning job uses the same input data and training\n image as the parent tuning jobs. You can change the hyperparameter ranges to\n search and the maximum number of training jobs that the hyperparameter\n tuning job launches. You cannot use a new version of the training algorithm,\n unless the changes in the new version do not affect the algorithm itself.\n For example, changes that improve logging or adding support for a different\n data format are allowed. You can also change hyperparameters from tunable to\n static, and from static to tunable, but the total number of static plus\n tunable hyperparameters must remain the same as it is in all parent jobs.\n The objective metric for the new tuning job must be the same as for all\n parent jobs.

\n
\n
TRANSFER_LEARNING
\n
\n

The new hyperparameter tuning job can include input data, hyperparameter\n ranges, maximum number of concurrent training jobs, and maximum number of\n training jobs that are different than those of its parent hyperparameter\n tuning jobs. The training image can also be a different version from the\n version used in the parent hyperparameter tuning job. You can also change\n hyperparameters from tunable to static, and from static to tunable, but the\n total number of static plus tunable hyperparameters must remain the same as\n it is in all parent jobs. The objective metric for the new tuning job must\n be the same as for all parent jobs.

\n
\n
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies the configuration for a hyperparameter tuning job that uses one or more\n previous hyperparameter tuning jobs as a starting point. The results of previous tuning\n jobs are used to inform which combinations of hyperparameters to search over in the new\n tuning job.

\n

All training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric, and the training job that performs the best is compared to the\n best training jobs from the parent tuning jobs. From these, the training job that\n performs the best as measured by the objective metric is returned as the overall best\n training job.

\n \n

All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.

\n " + "smithy.api#documentation": "

Specifies the configuration for a hyperparameter tuning job that uses one or more\n previous hyperparameter tuning jobs as a starting point. The results of previous tuning\n jobs are used to inform which combinations of hyperparameters to search over in the new\n tuning job.

\n

All training jobs launched by the new hyperparameter tuning job are evaluated by using\n the objective metric, and the training job that performs the best is compared to the\n best training jobs from the parent tuning jobs. From these, the training job that\n performs the best as measured by the objective metric is returned as the overall best\n training job.

\n \n

All training jobs launched by parent hyperparameter tuning jobs and the new\n hyperparameter tuning jobs count against the limit of training jobs for the tuning\n job.

\n " } }, "com.amazonaws.sagemaker#HyperParameterTuningJobWarmStartType": { @@ -24588,13 +24751,13 @@ "target": "com.amazonaws.sagemaker#OptionalVolumeSizeInGB", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The volume size in GB for the storage volume to be used in processing hyperparameter\n optimization jobs (optional). These volumes store model artifacts, incremental states\n and optionally, scratch space for training algorithms. Do not provide a value for this\n parameter if a value for InstanceConfigs is also specified.

\n

Some instance types have a fixed total local storage size. If you select one of these\n instances for training, VolumeSizeInGB cannot be greater than this total\n size. For a list of instance types with local instance storage and their sizes, see\n instance store volumes.

\n \n

SageMaker supports only the General Purpose SSD\n (gp2) storage volume type.

\n " + "smithy.api#documentation": "

The volume size in GB for the storage volume to be used in processing hyperparameter\n optimization jobs (optional). These volumes store model artifacts, incremental states\n and optionally, scratch space for training algorithms. Do not provide a value for this\n parameter if a value for InstanceConfigs is also specified.

\n

Some instance types have a fixed total local storage size. If you select one of these\n instances for training, VolumeSizeInGB cannot be greater than this total\n size. For a list of instance types with local instance storage and their sizes, see\n instance store volumes.

\n \n

SageMaker supports only the General Purpose SSD\n (gp2) storage volume type.

\n " } }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume\n attached to the compute instances used to run the training job. You can use either of\n the following formats to specify a key.

\n

KMS Key ID:

\n

\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

\n

Amazon Resource Name (ARN) of a KMS key:

\n

\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

\n

Some instances use local storage, which use a hardware module to\n encrypt storage volumes. If you choose one of these instance types, you\n cannot request a VolumeKmsKeyId. For a list of instance types that use\n local storage, see instance store\n volumes. For more information about Amazon Web Services Key Management Service, see KMS\n encryption for more information.

" + "smithy.api#documentation": "

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume\n attached to the compute instances used to run the training job. You can use either of\n the following formats to specify a key.

\n

KMS Key ID:

\n

\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

\n

Amazon Resource Name (ARN) of a KMS key:

\n

\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

\n

Some instances use local storage, which use a hardware module to\n encrypt storage volumes. If you choose one of these instance types, you\n cannot request a VolumeKmsKeyId. For a list of instance types that use\n local storage, see instance store\n volumes. For more information about Amazon Web Services Key Management Service, see KMS\n encryption for more information.

" } }, "AllocationStrategy": { @@ -24606,12 +24769,12 @@ "InstanceConfigs": { "target": "com.amazonaws.sagemaker#HyperParameterTuningInstanceConfigs", "traits": { - "smithy.api#documentation": "

A list containing the configuration(s) for one or more resources for processing\n hyperparameter jobs. These resources include compute instances and storage volumes to\n use in model training jobs launched by hyperparameter tuning jobs. The\n AllocationStrategy controls the order in which multiple configurations\n provided in InstanceConfigs are used.

\n \n

If you only want to use a single instance configuration inside the\n HyperParameterTuningResourceConfig API, do not provide a value for\n InstanceConfigs. Instead, use InstanceType,\n VolumeSizeInGB and InstanceCount. If you use\n InstanceConfigs, do not provide values for\n InstanceType, VolumeSizeInGB or\n InstanceCount.

\n " + "smithy.api#documentation": "

A list containing the configuration(s) for one or more resources for processing\n hyperparameter jobs. These resources include compute instances and storage volumes to\n use in model training jobs launched by hyperparameter tuning jobs. The\n AllocationStrategy controls the order in which multiple configurations\n provided in InstanceConfigs are used.

\n \n

If you only want to use a single instance configuration inside the\n HyperParameterTuningResourceConfig API, do not provide a value for\n InstanceConfigs. Instead, use InstanceType,\n VolumeSizeInGB and InstanceCount. If you use\n InstanceConfigs, do not provide values for\n InstanceType, VolumeSizeInGB or\n InstanceCount.

\n " } } }, "traits": { - "smithy.api#documentation": "

The configuration of resources, including compute instances and storage volumes for\n use in training jobs launched by hyperparameter tuning jobs. Specify one or more\n instance type and count and the allocation strategy for instance selection.

\n \n

\n HyperParameterTuningResourceConfig supports all of the capabilities\n of ResourceConfig with added functionality for flexible instance management.

\n " + "smithy.api#documentation": "

The configuration of resources, including compute instances and storage volumes for\n use in training jobs launched by hyperparameter tuning jobs.\n HyperParameterTuningResourceConfig is similar to\n ResourceConfig, but has the additional InstanceConfigs and\n AllocationStrategy fields to allow for flexible instance management.\n Specify one or more instance types, count, and the allocation strategy for instance\n selection.

\n \n

\n HyperParameterTuningResourceConfig supports the capabilities of\n ResourceConfig with the exception of\n KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools\n by default, which reuse clusters between training jobs.

\n " } }, "com.amazonaws.sagemaker#HyperParameterValue": { @@ -24715,7 +24878,7 @@ "ImageArn": { "target": "com.amazonaws.sagemaker#ImageArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

", + "smithy.api#documentation": "

The ARN of the image.

", "smithy.api#required": {} } }, @@ -24771,7 +24934,7 @@ "RepositoryAccessMode": { "target": "com.amazonaws.sagemaker#RepositoryAccessMode", "traits": { - "smithy.api#documentation": "

Set this to one of the following values:

\n
    \n
  • \n

    \n Platform - The model image is hosted in Amazon ECR.

    \n
    • \n
  • \n

    \n Vpc - The model image is hosted in a private Docker registry in\n your VPC.

    \n
    • \n
", + "smithy.api#documentation": "

Set this to one of the following values:

\n
    \n
  • \n

    \n Platform - The model image is hosted in Amazon ECR.

    \n
    • \n
  • \n

    \n Vpc - The model image is hosted in a private Docker registry in\n your VPC.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -24983,7 +25146,7 @@ "ImageArn": { "target": "com.amazonaws.sagemaker#ImageArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image the version is based on.

", + "smithy.api#documentation": "

The ARN of the image the version is based on.

", "smithy.api#required": {} } }, @@ -25249,7 +25412,7 @@ "Mode": { "target": "com.amazonaws.sagemaker#InferenceExecutionMode", "traits": { - "smithy.api#documentation": "

How containers in a multi-container are run. The following values are valid.

\n
    \n
  • \n

    \n SERIAL - Containers run as a serial pipeline.

    \n
    • \n
  • \n

    \n DIRECT - Only the individual container that you specify is\n run.

    \n
    • \n
", + "smithy.api#documentation": "

How containers in a multi-container are run. The following values are valid.

\n
    \n
  • \n

    \n SERIAL - Containers run as a serial pipeline.

    \n
    • \n
  • \n

    \n DIRECT - Only the individual container that you specify is\n run.

    \n
    • \n
", "smithy.api#required": {} } } @@ -25291,14 +25454,14 @@ "Destination": { "target": "com.amazonaws.sagemaker#DestinationS3Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket where the inference experiment data is stored.

", + "smithy.api#documentation": "

The Amazon S3 bucket where the inference request and response data is stored.

", "smithy.api#required": {} } }, "KmsKey": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt\n captured data when uploading to Amazon S3.\n

" + "smithy.api#documentation": "

\n The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3\n server-side encryption.\n

" } }, "ContentType": { @@ -25306,7 +25469,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon S3 location and configuration for storing inference experiment data.

" + "smithy.api#documentation": "

The Amazon S3 location and configuration for storing inference request and response data.

" } }, "com.amazonaws.sagemaker#InferenceExperimentDescription": { @@ -25500,7 +25663,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container\n images.\n

" + "smithy.api#documentation": "

\n The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage\n Amazon SageMaker Inference endpoints for model deployment.\n

" } } }, @@ -25729,13 +25892,13 @@ "SupportedTransformInstanceTypes": { "target": "com.amazonaws.sagemaker#TransformInstanceTypes", "traits": { - "smithy.api#documentation": "

A list of the instance types on which a transformation job can be run or on which an\n endpoint can be deployed.

\n

This parameter is required for unversioned models, and optional for versioned\n models.

" + "smithy.api#documentation": "

A list of the instance types on which a transformation job can be run or on which an\n endpoint can be deployed.

\n

This parameter is required for unversioned models, and optional for versioned\n models.

" } }, "SupportedRealtimeInferenceInstanceTypes": { "target": "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes", "traits": { - "smithy.api#documentation": "

A list of the instance types that are used to generate inferences in real-time.

\n

This parameter is required for unversioned models, and optional for versioned\n models.

" + "smithy.api#documentation": "

A list of the instance types that are used to generate inferences in real-time.

\n

This parameter is required for unversioned models, and optional for versioned\n models.

" } }, "SupportedContentTypes": { @@ -25796,7 +25959,7 @@ "DataInputConfig": { "target": "com.amazonaws.sagemaker#DataInputConfig", "traits": { - "smithy.api#documentation": "

Specifies the name and shape of the expected data inputs for your trained model with a\n JSON dictionary form. The data inputs are InputConfig$Framework\n specific.

\n
    \n
  • \n

    \n TensorFlow: You must specify the name and shape (NHWC format) of\n the expected data inputs using a dictionary format for your trained model. The\n dictionary formats required for the console and CLI are different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"input\":[1,1024,1024,3]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input\\\":[1,1024,1024,3]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"data1\": [1,28,28,1],\n \"data2\":[1,28,28,1]}\n

        \n
        • \n
      • \n

        If using the CLI, {\\\"data1\\\": [1,28,28,1],\n \\\"data2\\\":[1,28,28,1]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n KERAS: You must specify the name and shape (NCHW format) of\n expected data inputs using a dictionary format for your trained model. Note that\n while Keras model artifacts should be uploaded in NHWC (channel-last) format,\n DataInputConfig should be specified in NCHW (channel-first)\n format. The dictionary formats required for the console and CLI are\n different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"input_1\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input_1\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"input_1\": [1,3,224,224],\n \"input_2\":[1,3,224,224]} \n

        \n
        • \n
      • \n

        If using the CLI, {\\\"input_1\\\": [1,3,224,224],\n \\\"input_2\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of\n the expected data inputs in order using a dictionary format for your trained\n model. The dictionary formats required for the console and CLI are\n different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"data\":[1,3,1024,1024]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"data\\\":[1,3,1024,1024]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"var1\": [1,1,28,28],\n \"var2\":[1,1,28,28]} \n

        \n
        • \n
      • \n

        If using the CLI, {\\\"var1\\\": [1,1,28,28],\n \\\"var2\\\":[1,1,28,28]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n PyTorch: You can either specify the name and shape (NCHW format)\n of expected data inputs in order using a dictionary format for your trained\n model or you can specify the shape only using a list format. The dictionary\n formats required for the console and CLI are different. The list formats for the\n console and CLI are the same.

    \n
      \n
    • \n

      Examples for one input in dictionary format:

      \n
        \n
      • \n

        If using the console,\n {\"input0\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input0\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Example for one input in list format:\n [[1,3,224,224]]\n

      \n
      • \n
    • \n

      Examples for two inputs in dictionary format:

      \n
        \n
      • \n

        If using the console, {\"input0\":[1,3,224,224],\n \"input1\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI, {\\\"input0\\\":[1,3,224,224],\n \\\"input1\\\":[1,3,224,224]} \n

        \n
        • \n
      \n
      • \n
    • \n

      Example for two inputs in list format: [[1,3,224,224],\n [1,3,224,224]]\n

      \n
      • \n
    \n
    • \n
  • \n

    \n XGBOOST: input data name and shape are not needed.

    \n
    • \n
\n

\n DataInputConfig supports the following parameters for CoreML\n OutputConfig$TargetDevice (ML Model format):

\n
    \n
  • \n

    \n shape: Input shape, for example {\"input_1\": {\"shape\": [1,224,224,3]}}.\n In addition to static input shapes, CoreML converter supports Flexible input shapes:

    \n
      \n
    • \n

      Range Dimension. You can use the Range Dimension feature if you know the input shape\n will be within some specific interval in that dimension,\n for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3]}}\n

      \n
      • \n
    • \n

      Enumerated shapes. Sometimes, the models are trained to work only on a select\n set of inputs. You can enumerate all supported input shapes,\n for example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160, 3]]}}\n

      \n
      • \n
    \n
    • \n
  • \n

    \n default_shape: Default input shape. You can set a default shape during\n conversion for both Range Dimension and Enumerated Shapes. For example\n {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1, 224, 224, 3]}}\n

    \n
    • \n
  • \n

    \n type: Input type. Allowed values: Image and Tensor.\n By default, the converter generates an ML Model with inputs of type Tensor (MultiArray).\n User can set input type to be Image. Image input type requires additional input parameters\n such as bias and scale.

    \n
    • \n
  • \n

    \n bias: If the input type is an Image, you need to provide the bias vector.

    \n
    • \n
  • \n

    \n scale: If the input type is an Image, you need to provide a scale factor.

    \n
    • \n
\n

CoreML ClassifierConfig parameters can be specified using\n OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.\n CoreML conversion examples:

\n
    \n
  • \n

    Tensor type input:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\":\n [1,224,224,3]}}\n

      \n
      • \n
    \n
    • \n
  • \n

    Tensor type input without input name (PyTorch):

    \n
      \n
    • \n

      \n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\":\n [1,3,224,224]}]\n

      \n
      • \n
    \n
    • \n
  • \n

    Image type input:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\":\n [1,224,224,3], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}\n

      \n
      • \n
    \n
    • \n
  • \n

    Image type input without input name (PyTorch):

    \n
      \n
    • \n

      \n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\":\n [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}]\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}\n

      \n
      • \n
    \n
    • \n
\n

Depending on the model format, DataInputConfig requires the following parameters for \n ml_eia2 \n OutputConfig:TargetDevice.

\n
    \n
  • \n

    For TensorFlow models saved in the SavedModel format, specify the input names \n from signature_def_key and the input model shapes for DataInputConfig. \n Specify the signature_def_key in \n \n OutputConfig:CompilerOptions\n if \n the model does not use TensorFlow's default signature def key. For example:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"signature_def_key\": \"serving_custom\"}\n

      \n
      • \n
    \n
    • \n
  • \n

    For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes \n in DataInputConfig and the output tensor names for output_names in \n \n OutputConfig:CompilerOptions\n .\n For example:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224, 3]}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"output_names\": [\"output_tensor:0\"]}\n

      \n
      • \n
    \n
    • \n
", + "smithy.api#documentation": "

Specifies the name and shape of the expected data inputs for your trained model with a\n JSON dictionary form. The data inputs are InputConfig$Framework\n specific.

\n
    \n
  • \n

    \n TensorFlow: You must specify the name and shape (NHWC format) of\n the expected data inputs using a dictionary format for your trained model. The\n dictionary formats required for the console and CLI are different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"input\":[1,1024,1024,3]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input\\\":[1,1024,1024,3]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"data1\": [1,28,28,1],\n \"data2\":[1,28,28,1]}\n

        \n
        • \n
      • \n

        If using the CLI, {\\\"data1\\\": [1,28,28,1],\n \\\"data2\\\":[1,28,28,1]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n KERAS: You must specify the name and shape (NCHW format) of\n expected data inputs using a dictionary format for your trained model. Note that\n while Keras model artifacts should be uploaded in NHWC (channel-last) format,\n DataInputConfig should be specified in NCHW (channel-first)\n format. The dictionary formats required for the console and CLI are\n different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"input_1\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input_1\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"input_1\": [1,3,224,224],\n \"input_2\":[1,3,224,224]} \n

        \n
        • \n
      • \n

        If using the CLI, {\\\"input_1\\\": [1,3,224,224],\n \\\"input_2\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of\n the expected data inputs in order using a dictionary format for your trained\n model. The dictionary formats required for the console and CLI are\n different.

    \n
      \n
    • \n

      Examples for one input:

      \n
        \n
      • \n

        If using the console,\n {\"data\":[1,3,1024,1024]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"data\\\":[1,3,1024,1024]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Examples for two inputs:

      \n
        \n
      • \n

        If using the console, {\"var1\": [1,1,28,28],\n \"var2\":[1,1,28,28]} \n

        \n
        • \n
      • \n

        If using the CLI, {\\\"var1\\\": [1,1,28,28],\n \\\"var2\\\":[1,1,28,28]}\n

        \n
        • \n
      \n
      • \n
    \n
    • \n
  • \n

    \n PyTorch: You can either specify the name and shape (NCHW format)\n of expected data inputs in order using a dictionary format for your trained\n model or you can specify the shape only using a list format. The dictionary\n formats required for the console and CLI are different. The list formats for the\n console and CLI are the same.

    \n
      \n
    • \n

      Examples for one input in dictionary format:

      \n
        \n
      • \n

        If using the console,\n {\"input0\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI,\n {\\\"input0\\\":[1,3,224,224]}\n

        \n
        • \n
      \n
      • \n
    • \n

      Example for one input in list format:\n [[1,3,224,224]]\n

      \n
      • \n
    • \n

      Examples for two inputs in dictionary format:

      \n
        \n
      • \n

        If using the console, {\"input0\":[1,3,224,224],\n \"input1\":[1,3,224,224]}\n

        \n
        • \n
      • \n

        If using the CLI, {\\\"input0\\\":[1,3,224,224],\n \\\"input1\\\":[1,3,224,224]} \n

        \n
        • \n
      \n
      • \n
    • \n

      Example for two inputs in list format: [[1,3,224,224],\n [1,3,224,224]]\n

      \n
      • \n
    \n
    • \n
  • \n

    \n XGBOOST: input data name and shape are not needed.

    \n
    • \n
\n

\n DataInputConfig supports the following parameters for CoreML\n OutputConfig$TargetDevice (ML Model format):

\n
    \n
  • \n

    \n shape: Input shape, for example {\"input_1\": {\"shape\": [1,224,224,3]}}.\n In addition to static input shapes, CoreML converter supports Flexible input shapes:

    \n
      \n
    • \n

      Range Dimension. You can use the Range Dimension feature if you know the input shape\n will be within some specific interval in that dimension,\n for example: {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3]}}\n

      \n
      • \n
    • \n

      Enumerated shapes. Sometimes, the models are trained to work only on a select\n set of inputs. You can enumerate all supported input shapes,\n for example: {\"input_1\": {\"shape\": [[1, 224, 224, 3], [1, 160, 160, 3]]}}\n

      \n
      • \n
    \n
    • \n
  • \n

    \n default_shape: Default input shape. You can set a default shape during\n conversion for both Range Dimension and Enumerated Shapes. For example\n {\"input_1\": {\"shape\": [\"1..10\", 224, 224, 3], \"default_shape\": [1, 224, 224, 3]}}\n

    \n
    • \n
  • \n

    \n type: Input type. Allowed values: Image and Tensor.\n By default, the converter generates an ML Model with inputs of type Tensor (MultiArray).\n User can set input type to be Image. Image input type requires additional input parameters\n such as bias and scale.

    \n
    • \n
  • \n

    \n bias: If the input type is an Image, you need to provide the bias vector.

    \n
    • \n
  • \n

    \n scale: If the input type is an Image, you need to provide a scale factor.

    \n
    • \n
\n

CoreML ClassifierConfig parameters can be specified using\n OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models.\n CoreML conversion examples:

\n
    \n
  • \n

    Tensor type input:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\":\n [1,224,224,3]}}\n

      \n
      • \n
    \n
    • \n
  • \n

    Tensor type input without input name (PyTorch):

    \n
      \n
    • \n

      \n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\":\n [1,3,224,224]}]\n

      \n
      • \n
    \n
    • \n
  • \n

    Image type input:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_1\": {\"shape\": [[1,224,224,3], [1,160,160,3]], \"default_shape\":\n [1,224,224,3], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}\n

      \n
      • \n
    \n
    • \n
  • \n

    Image type input without input name (PyTorch):

    \n
      \n
    • \n

      \n \"DataInputConfig\": [{\"shape\": [[1,3,224,224], [1,3,160,160]], \"default_shape\":\n [1,3,224,224], \"type\": \"Image\", \"bias\": [-1,-1,-1], \"scale\": 0.007843137255}]\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"class_labels\": \"imagenet_labels_1000.txt\"}\n

      \n
      • \n
    \n
    • \n
\n

Depending on the model format, DataInputConfig requires the following parameters for \n ml_eia2\n OutputConfig:TargetDevice.

\n
    \n
  • \n

    For TensorFlow models saved in the SavedModel format, specify the input names \n from signature_def_key and the input model shapes for DataInputConfig. \n Specify the signature_def_key in \n \n OutputConfig:CompilerOptions\n if \n the model does not use TensorFlow's default signature def key. For example:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"inputs\": [1, 224, 224, 3]}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"signature_def_key\": \"serving_custom\"}\n

      \n
      • \n
    \n
    • \n
  • \n

    For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes \n in DataInputConfig and the output tensor names for output_names in \n \n OutputConfig:CompilerOptions\n .\n For example:

    \n
      \n
    • \n

      \n \"DataInputConfig\": {\"input_tensor:0\": [1, 224, 224, 3]}\n

      \n
      • \n
    • \n

      \n \"CompilerOptions\": {\"output_names\": [\"output_tensor:0\"]}\n

      \n
      • \n
    \n
    • \n
", "smithy.api#required": {} } }, @@ -25810,7 +25973,7 @@ "FrameworkVersion": { "target": "com.amazonaws.sagemaker#FrameworkVersion", "traits": { - "smithy.api#documentation": "

Specifies the framework version to use. This API field is only supported for the MXNet,\n\t PyTorch, TensorFlow and TensorFlow Lite frameworks.

\n

For information about framework versions supported for cloud targets and edge devices, see \n Cloud Supported Instance Types and Frameworks and \n Edge Supported Frameworks.

" + "smithy.api#documentation": "

Specifies the framework version to use. This API field is only supported for the MXNet,\n\t PyTorch, TensorFlow and TensorFlow Lite frameworks.

\n

For information about framework versions supported for cloud targets and edge devices, see \n Cloud Supported Instance Types and Frameworks and \n Edge Supported Frameworks.

" } } }, @@ -26389,7 +26552,7 @@ "ScalingType": { "target": "com.amazonaws.sagemaker#HyperParameterScalingType", "traits": { - "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
" + "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
" } } }, @@ -26488,6 +26651,29 @@ "smithy.api#pattern": "^.+$" } }, + "com.amazonaws.sagemaker#JobType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFERENCE" + } + }, + "NOTEBOOK_KERNEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOTEBOOK_KERNEL" + } + } + } + }, "com.amazonaws.sagemaker#JoinSource": { "type": "enum", "members": { @@ -26548,7 +26734,7 @@ "LifecycleConfigArns": { "target": "com.amazonaws.sagemaker#LifecycleConfigArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

\n \n

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

\n \n

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

\n " } }, "CodeRepositories": { @@ -26598,7 +26784,7 @@ "LifecycleConfigArns": { "target": "com.amazonaws.sagemaker#LifecycleConfigArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

\n \n

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

\n \n

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

\n " } } }, @@ -26796,7 +26982,7 @@ "LabelingJobAlgorithmSpecificationArn": { "target": "com.amazonaws.sagemaker#LabelingJobAlgorithmSpecificationArn", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You\n must select one of the following ARNs:

\n
    \n
  • \n

    \n Image classification\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification\n

    \n
    • \n
  • \n

    \n Text classification\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification\n

    \n
    • \n
  • \n

    \n Object detection\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection\n

    \n
    • \n
  • \n

    \n Semantic Segmentation\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation\n

    \n
    • \n
", + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You\n must select one of the following ARNs:

\n
    \n
  • \n

    \n Image classification\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification\n

    \n
    • \n
  • \n

    \n Text classification\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification\n

    \n
    • \n
  • \n

    \n Object detection\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection\n

    \n
    • \n
  • \n

    \n Semantic Segmentation\n

    \n

    \n arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -26858,7 +27044,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about the location of input data.

\n \n

You must specify at least one of the following: S3DataSource or SnsDataSource.

\n

Use SnsDataSource to specify an SNS input topic\n for a streaming labeling job. If you do not specify \n and SNS input topic ARN, Ground Truth will create a one-time labeling job.

\n

Use S3DataSource to specify an input \n manifest file for both streaming and one-time labeling jobs.\n Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

" + "smithy.api#documentation": "

Provides information about the location of input data.

\n

You must specify at least one of the following: S3DataSource or SnsDataSource.

\n

Use SnsDataSource to specify an SNS input topic\n for a streaming labeling job. If you do not specify \n and SNS input topic ARN, Ground Truth will create a one-time labeling job.

\n

Use S3DataSource to specify an input \n manifest file for both streaming and one-time labeling jobs.\n Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

" } }, "com.amazonaws.sagemaker#LabelingJobForWorkteamSummary": { @@ -26979,13 +27165,13 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

\n

If you provide your own KMS key ID, you must add the required permissions to your KMS\n key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

\n

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your\n role's account to encrypt your output data.

\n

If you use a bucket policy with an s3:PutObject permission that only\n allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

\n

If you provide your own KMS key ID, you must add the required permissions to your KMS\n key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

\n

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your\n role's account to encrypt your output data.

\n

If you use a bucket policy with an s3:PutObject permission that only\n allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

" } }, "SnsTopicArn": { "target": "com.amazonaws.sagemaker#SnsTopicArn", "traits": { - "smithy.api#documentation": "

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to\n do real time chaining to another streaming job and receive an Amazon SNS notifications each\n time a data object is submitted by a worker.

\n

If you provide an SnsTopicArn in OutputConfig, when workers\n complete labeling tasks, Ground Truth will send labeling task output data to the SNS output\n topic you specify here.

\n

To learn more, see Receive Output Data from a Streaming Labeling\n Job.

" + "smithy.api#documentation": "

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to\n do real time chaining to another streaming job and receive an Amazon SNS notifications each\n time a data object is submitted by a worker.

\n

If you provide an SnsTopicArn in OutputConfig, when workers\n complete labeling tasks, Ground Truth will send labeling task output data to the SNS output\n topic you specify here.

\n

To learn more, see Receive Output Data from a Streaming Labeling\n Job.

" } } }, @@ -26999,7 +27185,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training and inference jobs used for\n automated data labeling.

\n

You can only specify a VolumeKmsKeyId when you create a labeling job with\n automated data labeling enabled using the API operation CreateLabelingJob.\n You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for\n automated data labeling model training and inference when you create a labeling job\n using the console. To learn more, see Output Data and Storage Volume\n Encryption.

\n

The VolumeKmsKeyId can be any of the following formats:

\n
    \n
  • \n

    KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training and inference jobs used for\n automated data labeling.

\n

You can only specify a VolumeKmsKeyId when you create a labeling job with\n automated data labeling enabled using the API operation CreateLabelingJob.\n You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for\n automated data labeling model training and inference when you create a labeling job\n using the console. To learn more, see Output Data and Storage Volume\n Encryption.

\n

The VolumeKmsKeyId can be any of the following formats:

\n
    \n
  • \n

    KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" } }, "VpcConfig": { @@ -27016,7 +27202,7 @@ "ManifestS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the manifest file that describes the input data objects.

\n

The input manifest file referenced in ManifestS3Uri must contain one of\n the following keys: source-ref or source. The value of the\n keys are interpreted as follows:

\n
    \n
  • \n

    \n source-ref: The source of the object is the Amazon S3 object\n specified in the value. Use this value when the object is a binary object, such\n as an image.

    \n
    • \n
  • \n

    \n source: The source of the object is the value. Use this\n value when the object is a text value.

    \n
    • \n
\n

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to\n create an input manifest file.

", + "smithy.api#documentation": "

The Amazon S3 location of the manifest file that describes the input data objects.

\n

The input manifest file referenced in ManifestS3Uri must contain one of\n the following keys: source-ref or source. The value of the\n keys are interpreted as follows:

\n
    \n
  • \n

    \n source-ref: The source of the object is the Amazon S3 object\n specified in the value. Use this value when the object is a binary object, such\n as an image.

    \n
    • \n
  • \n

    \n source: The source of the object is the value. Use this\n value when the object is a text value.

    \n
    • \n
\n

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to\n create an input manifest file.

", "smithy.api#required": {} } } @@ -27098,7 +27284,7 @@ } }, "traits": { - "smithy.api#documentation": "

A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped. You can use these conditions to control the cost of data\n labeling.

\n \n

Labeling jobs fail after 30 days with an appropriate client error message.

\n " + "smithy.api#documentation": "

A set of conditions for stopping a labeling job. If any of the conditions are met, the\n job is automatically stopped. You can use these conditions to control the cost of data\n labeling.

\n \n

Labeling jobs fail after 30 days with an appropriate client error message.

\n " } }, "com.amazonaws.sagemaker#LabelingJobSummary": { @@ -27562,6 +27748,82 @@ } } }, + "com.amazonaws.sagemaker#ListAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListAliasesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the aliases of a specified image or image version.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SageMakerImageVersionAliases", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListAliasesRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#documentation": "

The name of the image.

", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The alias of the image version.

" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of aliases to return.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

If the previous call to ListAliases didn't return the full set of\n aliases, the call returns a token for retrieving the next set of aliases.

" + } + } + } + }, + "com.amazonaws.sagemaker#ListAliasesResponse": { + "type": "structure", + "members": { + "SageMakerImageVersionAliases": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "

A list of SageMaker image version aliases.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token for getting the next set of aliases, if more aliases exist.

" + } + } + } + }, "com.amazonaws.sagemaker#ListAppImageConfigs": { "type": "operation", "input": { @@ -27710,13 +27972,13 @@ "UserProfileNameEquals": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "

A parameter to search by user profile name.

" + "smithy.api#documentation": "

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

" } }, "SpaceNameEquals": { "target": "com.amazonaws.sagemaker#SpaceName", "traits": { - "smithy.api#documentation": "

A parameter to search by space name.

" + "smithy.api#documentation": "

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

" } } } @@ -28217,7 +28479,7 @@ "CodeRepositorySummaryList": { "target": "com.amazonaws.sagemaker#CodeRepositorySummaryList", "traits": { - "smithy.api#documentation": "

Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:

\n
    \n
  • \n

    Name

    \n
    • \n
  • \n

    Amazon Resource Name (ARN)

    \n
    • \n
  • \n

    Creation time

    \n
    • \n
  • \n

    Last modified time

    \n
    • \n
  • \n

    Configuration information, including the URL location of the repository and\n the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.

    \n
    • \n
", + "smithy.api#documentation": "

Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:

\n
    \n
  • \n

    Name

    \n
    • \n
  • \n

    Amazon Resource Name (ARN)

    \n
    • \n
  • \n

    Creation time

    \n
    • \n
  • \n

    Last modified time

    \n
    • \n
  • \n

    Configuration information, including the URL location of the repository and\n the ARN of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -28238,7 +28500,7 @@ "target": "com.amazonaws.sagemaker#ListCompilationJobsResponse" }, "traits": { - "smithy.api#documentation": "

Lists model compilation jobs that satisfy various filters.

\n

To create a model compilation job, use CreateCompilationJob. To get\n information about a particular model compilation job you have created, use DescribeCompilationJob.

", + "smithy.api#documentation": "

Lists model compilation jobs that satisfy various filters.

\n

To create a model compilation job, use CreateCompilationJob. To get\n information about a particular model compilation job you have created, use DescribeCompilationJob.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31404,7 +31666,7 @@ "ModelPackageType": { "target": "com.amazonaws.sagemaker#ModelPackageType", "traits": { - "smithy.api#documentation": "

A filter that returns only the model packages of the specified type. This can be one\n of the following values.

\n
    \n
  • \n

    \n UNVERSIONED - List only unversioined models. \n This is the default value if no ModelPackageType is specified.

    \n
    • \n
  • \n

    \n VERSIONED - List only versioned models.

    \n
    • \n
  • \n

    \n BOTH - List both versioned and unversioned models.

    \n
    • \n
" + "smithy.api#documentation": "

A filter that returns only the model packages of the specified type. This can be one\n of the following values.

\n
    \n
  • \n

    \n UNVERSIONED - List only unversioined models. \n This is the default value if no ModelPackageType is specified.

    \n
    • \n
  • \n

    \n VERSIONED - List only versioned models.

    \n
    • \n
  • \n

    \n BOTH - List both versioned and unversioned models.

    \n
    • \n
" } }, "NextToken": { @@ -32148,7 +32410,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the previous call to the ListNotebookInstances is truncated, the\n response includes a NextToken. You can use this token in your subsequent\n ListNotebookInstances request to fetch the next set of notebook\n instances.

\n \n

You might specify a filter or a sort order in your request. When response is\n truncated, you must use the same values for the filer and sort order in the next\n request.

\n " + "smithy.api#documentation": "

If the previous call to the ListNotebookInstances is truncated, the\n response includes a NextToken. You can use this token in your subsequent\n ListNotebookInstances request to fetch the next set of notebook\n instances.

\n \n

You might specify a filter or a sort order in your request. When response is\n truncated, you must use the same values for the filer and sort order in the next\n request.

\n " } }, "MaxResults": { @@ -33119,7 +33381,7 @@ "target": "com.amazonaws.sagemaker#ListTrainingJobsResponse" }, "traits": { - "smithy.api#documentation": "

Lists training jobs.

\n \n

When StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.

\n

For example, if ListTrainingJobs is invoked with the following\n parameters:

\n

\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n

\n

First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.

\n

You can quickly test the API using the following Amazon Web Services CLI\n code.

\n

\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n

\n ", + "smithy.api#documentation": "

Lists training jobs.

\n \n

When StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.

\n

For example, if ListTrainingJobs is invoked with the following\n parameters:

\n

\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n

\n

First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.

\n

You can quickly test the API using the following Amazon Web Services CLI\n code.

\n

\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -33182,7 +33444,7 @@ "SortBy": { "target": "com.amazonaws.sagemaker#TrainingJobSortByOptions", "traits": { - "smithy.api#documentation": "

The field to sort results by. The default is Name.

\n

If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.

" + "smithy.api#documentation": "

The field to sort results by. The default is Name.

\n

If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.

" } }, "SortOrder": { @@ -33857,6 +34119,16 @@ "smithy.api#default": 0 } }, + "com.amazonaws.sagemaker#MLFramework": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" + } + }, "com.amazonaws.sagemaker#MaxAutoMLJobRuntimeInSeconds": { "type": "integer", "traits": { @@ -34401,7 +34673,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about the location that is configured for storing model\n artifacts.

\n

Model artifacts are the output that results from training a model, and typically\n consist of trained parameters, a model definition that describes how to compute\n inferences, and other metadata.

" + "smithy.api#documentation": "

Provides information about the location that is configured for storing model\n artifacts.

\n

Model artifacts are the output that results from training a model, and typically\n consist of trained parameters, a model definition that describes how to compute\n inferences, and other metadata.

" } }, "com.amazonaws.sagemaker#ModelBiasAppSpecification": { @@ -35420,7 +35692,7 @@ "InfrastructureType": { "target": "com.amazonaws.sagemaker#ModelInfrastructureType", "traits": { - "smithy.api#documentation": "

The inference option to which to deploy your model. Possible values are the following:

\n
    \n
  • \n

    \n RealTime: Deploy to real-time inference.

    \n
    • \n
", + "smithy.api#documentation": "

The inference option to which to deploy your model. Possible values are the following:

\n
    \n
  • \n

    \n RealTime: Deploy to real-time inference.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -35741,7 +36013,7 @@ "ModelPackageStatus": { "target": "com.amazonaws.sagemaker#ModelPackageStatus", "traits": { - "smithy.api#documentation": "

The status of the model package. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The model package is pending being created.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The model package is in the process of being\n created.

    \n
    • \n
  • \n

    \n COMPLETED - The model package was successfully created.

    \n
    • \n
  • \n

    \n FAILED - The model package failed.

    \n
    • \n
  • \n

    \n DELETING - The model package is in the process of being deleted.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the model package. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The model package is pending being created.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The model package is in the process of being\n created.

    \n
    • \n
  • \n

    \n COMPLETED - The model package was successfully created.

    \n
    • \n
  • \n

    \n FAILED - The model package failed.

    \n
    • \n
  • \n

    \n DELETING - The model package is in the process of being deleted.

    \n
    • \n
" } }, "ModelPackageStatusDetails": { @@ -35760,7 +36032,7 @@ "ModelApprovalStatus": { "target": "com.amazonaws.sagemaker#ModelApprovalStatus", "traits": { - "smithy.api#documentation": "

The approval status of the model. This can be one of the following values.

\n
    \n
  • \n

    \n APPROVED - The model is approved

    \n
    • \n
  • \n

    \n REJECTED - The model is rejected.

    \n
    • \n
  • \n

    \n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.

    \n
    • \n
" + "smithy.api#documentation": "

The approval status of the model. This can be one of the following values.

\n
    \n
  • \n

    \n APPROVED - The model is approved

    \n
    • \n
  • \n

    \n REJECTED - The model is rejected.

    \n
    • \n
  • \n

    \n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.

    \n
    • \n
" } }, "CreatedBy": { @@ -35880,7 +36152,7 @@ "Image": { "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { - "smithy.api#documentation": "

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

\n

If you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

", + "smithy.api#documentation": "

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

\n

If you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

", "smithy.api#required": {} } }, @@ -35893,7 +36165,7 @@ "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model package.

\n " + "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model package.

\n " } }, "ProductId": { @@ -35992,7 +36264,7 @@ "ModelPackageGroupStatus": { "target": "com.amazonaws.sagemaker#ModelPackageGroupStatus", "traits": { - "smithy.api#documentation": "

The status of the model group. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The model group is pending being created.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The model group is in the process of being\n created.

    \n
    • \n
  • \n

    \n COMPLETED - The model group was successfully created.

    \n
    • \n
  • \n

    \n FAILED - The model group failed.

    \n
    • \n
  • \n

    \n DELETING - The model group is in the process of being deleted.

    \n
    • \n
  • \n

    \n DELETE_FAILED - SageMaker failed to delete the model group.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the model group. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The model group is pending being created.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The model group is in the process of being\n created.

    \n
    • \n
  • \n

    \n COMPLETED - The model group was successfully created.

    \n
    • \n
  • \n

    \n FAILED - The model group failed.

    \n
    • \n
  • \n

    \n DELETING - The model group is in the process of being deleted.

    \n
    • \n
  • \n

    \n DELETE_FAILED - SageMaker failed to delete the model group.

    \n
    • \n
" } }, "Tags": { @@ -36290,7 +36562,7 @@ "ModelApprovalStatus": { "target": "com.amazonaws.sagemaker#ModelApprovalStatus", "traits": { - "smithy.api#documentation": "

The approval status of the model. This can be one of the following values.

\n
    \n
  • \n

    \n APPROVED - The model is approved

    \n
    • \n
  • \n

    \n REJECTED - The model is rejected.

    \n
    • \n
  • \n

    \n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.

    \n
    • \n
" + "smithy.api#documentation": "

The approval status of the model. This can be one of the following values.

\n
    \n
  • \n

    \n APPROVED - The model is approved

    \n
    • \n
  • \n

    \n REJECTED - The model is rejected.

    \n
    • \n
  • \n

    \n PENDING_MANUAL_APPROVAL - The model is waiting for manual\n approval.

    \n
    • \n
" } } }, @@ -36346,7 +36618,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.

\n

The data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.

" + "smithy.api#documentation": "

Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.

\n

The data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#ModelPackageValidationProfiles": { @@ -36613,7 +36885,7 @@ "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

The name of the model.

", + "smithy.api#documentation": "

The name of the Amazon SageMaker Model entity.

", "smithy.api#required": {} } }, @@ -36654,7 +36926,7 @@ "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

The name of the model.

", + "smithy.api#documentation": "

The name of the Amazon SageMaker Model entity.

", "smithy.api#required": {} } }, @@ -36675,7 +36947,7 @@ "Status": { "target": "com.amazonaws.sagemaker#ModelVariantStatus", "traits": { - "smithy.api#documentation": "

The status of the deployment.

", + "smithy.api#documentation": "

The status of deployment for the model variant on the hosted inference endpoint.

\n
    \n
  • \n

    \n Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.\n

    \n
    • \n
  • \n

    \n InService - The model variant is running on the hosted inference endpoint.\n

    \n
    • \n
  • \n

    \n Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.\n

    \n
    • \n
  • \n

    \n Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.\n

    \n
    • \n
  • \n

    \n Deleted - The model variant has been deleted on the hosted inference endpoint. This\n can only happen after stopping the experiment.\n

    \n
    • \n
", "smithy.api#required": {} } } @@ -37597,7 +37869,7 @@ "MonitoringScheduleStatus": { "target": "com.amazonaws.sagemaker#ScheduleStatus", "traits": { - "smithy.api#documentation": "

The status of the monitoring schedule. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The schedule is pending being created.

    \n
    • \n
  • \n

    \n FAILED - The schedule failed.

    \n
    • \n
  • \n

    \n SCHEDULED - The schedule was successfully created.

    \n
    • \n
  • \n

    \n STOPPED - The schedule was stopped.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the monitoring schedule. This can be one of the following values.

\n
    \n
  • \n

    \n PENDING - The schedule is pending being created.

    \n
    • \n
  • \n

    \n FAILED - The schedule failed.

    \n
    • \n
  • \n

    \n SCHEDULED - The schedule was successfully created.

    \n
    • \n
  • \n

    \n STOPPED - The schedule was stopped.

    \n
    • \n
" } }, "MonitoringType": { @@ -38234,7 +38506,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the notebook instance lifecycle configuration script.

\n

Each lifecycle configuration script has a limit of 16384 characters.

\n

The value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.

\n

View CloudWatch Logs for notebook instance lifecycle configurations in log group\n /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].

\n

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" + "smithy.api#documentation": "

Contains the notebook instance lifecycle configuration script.

\n

Each lifecycle configuration script has a limit of 16384 characters.

\n

The value of the $PATH environment variable that is available to both\n scripts is /sbin:bin:/usr/sbin:/usr/bin.

\n

View CloudWatch Logs for notebook instance lifecycle configurations in log group\n /aws/sagemaker/NotebookInstances in log stream\n [notebook-instance-name]/[LifecycleConfigHook].

\n

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs\n for longer than 5 minutes, it fails and the notebook instance is not created or\n started.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" } }, "com.amazonaws.sagemaker#NotebookInstanceName": { @@ -38394,7 +38666,7 @@ "NotebookInstanceLifecycleConfigName": { "target": "com.amazonaws.sagemaker#NotebookInstanceLifecycleConfigName", "traits": { - "smithy.api#documentation": "

The name of a notebook instance lifecycle configuration associated with this notebook\n instance.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" + "smithy.api#documentation": "

The name of a notebook instance lifecycle configuration associated with this notebook\n instance.

\n

For information about notebook instance lifestyle configurations, see Step\n 2.1: (Optional) Customize a Notebook Instance.

" } }, "DefaultCodeRepository": { @@ -38565,7 +38837,7 @@ "TableFormat": { "target": "com.amazonaws.sagemaker#TableFormat", "traits": { - "smithy.api#documentation": "

Format for the offline store feature group. Iceberg is the optimal format for feature groups shared between offline and online stores.

" + "smithy.api#documentation": "

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

" } } }, @@ -38910,19 +39182,19 @@ "TargetPlatform": { "target": "com.amazonaws.sagemaker#TargetPlatform", "traits": { - "smithy.api#documentation": "

Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.

\n

The following examples show how to configure the TargetPlatform and\n CompilerOptions JSON strings for popular target platforms:

\n
    \n
  • \n

    Raspberry Pi 3 Model B+

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},\n

    \n

    \n \"CompilerOptions\": {'mattr': ['+neon']}\n

    \n
    • \n
  • \n

    Jetson TX2

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"NVIDIA\"},\n

    \n

    \n \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1',\n 'cuda-ver': '10.0'}\n

    \n
    • \n
  • \n

    EC2 m5.2xlarge instance OS

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\":\n \"NVIDIA\"},\n

    \n

    \n \"CompilerOptions\": {'mcpu': 'skylake-avx512'}\n

    \n
    • \n
  • \n

    RK3399

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"MALI\"}\n

    \n
    • \n
  • \n

    ARMv7 phone (CPU)

    \n

    \n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},\n

    \n

    \n \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr':\n ['+neon']}\n

    \n
    • \n
  • \n

    ARMv8 phone (CPU)

    \n

    \n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},\n

    \n

    \n \"CompilerOptions\": {'ANDROID_PLATFORM': 29}\n

    \n
    • \n
" + "smithy.api#documentation": "

Contains information about a target platform that you want your model to run on, such\n as OS, architecture, and accelerators. It is an alternative of\n TargetDevice.

\n

The following examples show how to configure the TargetPlatform and\n CompilerOptions JSON strings for popular target platforms:

\n
    \n
  • \n

    Raspberry Pi 3 Model B+

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM_EABIHF\"},\n

    \n

    \n \"CompilerOptions\": {'mattr': ['+neon']}\n

    \n
    • \n
  • \n

    Jetson TX2

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"NVIDIA\"},\n

    \n

    \n \"CompilerOptions\": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1',\n 'cuda-ver': '10.0'}\n

    \n
    • \n
  • \n

    EC2 m5.2xlarge instance OS

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"X86_64\", \"Accelerator\":\n \"NVIDIA\"},\n

    \n

    \n \"CompilerOptions\": {'mcpu': 'skylake-avx512'}\n

    \n
    • \n
  • \n

    RK3399

    \n

    \n \"TargetPlatform\": {\"Os\": \"LINUX\", \"Arch\": \"ARM64\", \"Accelerator\":\n \"MALI\"}\n

    \n
    • \n
  • \n

    ARMv7 phone (CPU)

    \n

    \n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM_EABI\"},\n

    \n

    \n \"CompilerOptions\": {'ANDROID_PLATFORM': 25, 'mattr':\n ['+neon']}\n

    \n
    • \n
  • \n

    ARMv8 phone (CPU)

    \n

    \n \"TargetPlatform\": {\"Os\": \"ANDROID\", \"Arch\": \"ARM64\"},\n

    \n

    \n \"CompilerOptions\": {'ANDROID_PLATFORM': 29}\n

    \n
    • \n
" } }, "CompilerOptions": { "target": "com.amazonaws.sagemaker#CompilerOptions", "traits": { - "smithy.api#documentation": "

Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n

\n
    \n
  • \n

    \n DTYPE: Specifies the data type for the input. When compiling for\n ml_* (except for ml_inf) instances using PyTorch\n framework, provide the data type (dtype) of the model's input.\n \"float32\" is used if \"DTYPE\" is not specified.\n Options for data type are:

    \n
      \n
    • \n

      float32: Use either \"float\" or \"float32\".

      \n
      • \n
    • \n

      int64: Use either \"int64\" or \"long\".

      \n
      • \n
    \n

    For example, {\"dtype\" : \"float32\"}.

    \n
    • \n
  • \n

    \n CPU: Compilation for CPU supports the following compiler\n options.

    \n
      \n
    • \n

      \n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n

      \n
      • \n
    • \n

      \n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n

      \n
      • \n
    \n
    • \n
  • \n

    \n ARM: Details of ARM CPU compilations.

    \n
      \n
    • \n

      \n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.

      \n

      For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.

      \n
      • \n
    \n
    • \n
  • \n

    \n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.

    \n
      \n
    • \n

      \n gpu_code: Specifies the targeted architecture.

      \n
      • \n
    • \n

      \n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.

      \n
      • \n
    • \n

      \n cuda-ver: Specifies the CUDA version in x.y\n format.

      \n
      • \n
    \n

    For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n

    \n
    • \n
  • \n

    \n ANDROID: Compilation for the Android OS supports the following\n compiler options:

    \n
      \n
    • \n

      \n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.

      \n
      • \n
    • \n

      \n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.

      \n
      • \n
    \n
    • \n
  • \n

    \n INFERENTIA: Compilation for target ml_inf1 uses compiler options\n passed in as a JSON string. For example,\n \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".\n

    \n

    For information about supported compiler options, see\n \n Neuron Compiler CLI.\n

    \n
    • \n
  • \n

    \n CoreML: Compilation for the CoreML OutputConfig$TargetDevice\n supports the following compiler options:

    \n
      \n
    • \n

      \n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example,\n {\"class_labels\": \"imagenet_labels_1000.txt\"}.\n Labels inside the txt file should be separated by newlines.

      \n
      • \n
    \n
    • \n
  • \n

    \n EIA: Compilation for the Elastic Inference Accelerator supports the following \n compiler options:

    \n
      \n
    • \n

      \n precision_mode: Specifies the precision of compiled artifacts. Supported values\n are \"FP16\" and \"FP32\". Default is\n \"FP32\".

      \n
      • \n
    • \n

      \n signature_def_key: Specifies the signature to use for models in SavedModel\n format. Defaults is TensorFlow's default signature def key.

      \n
      • \n
    • \n

      \n output_names: Specifies a list of output tensor names for \n models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.

      \n
      • \n
    \n

    For example: \n {\"precision_mode\": \"FP32\", \"output_names\": [\"output:0\"]}\n

    \n
    • \n
" + "smithy.api#documentation": "

Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n

\n
    \n
  • \n

    \n DTYPE: Specifies the data type for the input. When compiling for\n ml_* (except for ml_inf) instances using PyTorch\n framework, provide the data type (dtype) of the model's input.\n \"float32\" is used if \"DTYPE\" is not specified.\n Options for data type are:

    \n
      \n
    • \n

      float32: Use either \"float\" or \"float32\".

      \n
      • \n
    • \n

      int64: Use either \"int64\" or \"long\".

      \n
      • \n
    \n

    For example, {\"dtype\" : \"float32\"}.

    \n
    • \n
  • \n

    \n CPU: Compilation for CPU supports the following compiler\n options.

    \n
      \n
    • \n

      \n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n

      \n
      • \n
    • \n

      \n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n

      \n
      • \n
    \n
    • \n
  • \n

    \n ARM: Details of ARM CPU compilations.

    \n
      \n
    • \n

      \n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.

      \n

      For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.

      \n
      • \n
    \n
    • \n
  • \n

    \n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.

    \n
      \n
    • \n

      \n gpu_code: Specifies the targeted architecture.

      \n
      • \n
    • \n

      \n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.

      \n
      • \n
    • \n

      \n cuda-ver: Specifies the CUDA version in x.y\n format.

      \n
      • \n
    \n

    For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n

    \n
    • \n
  • \n

    \n ANDROID: Compilation for the Android OS supports the following\n compiler options:

    \n
      \n
    • \n

      \n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.

      \n
      • \n
    • \n

      \n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.

      \n
      • \n
    \n
    • \n
  • \n

    \n INFERENTIA: Compilation for target ml_inf1 uses compiler options\n passed in as a JSON string. For example,\n \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".\n

    \n

    For information about supported compiler options, see\n \n Neuron Compiler CLI.\n

    \n
    • \n
  • \n

    \n CoreML: Compilation for the CoreML OutputConfig$TargetDevice\n supports the following compiler options:

    \n
      \n
    • \n

      \n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example,\n {\"class_labels\": \"imagenet_labels_1000.txt\"}.\n Labels inside the txt file should be separated by newlines.

      \n
      • \n
    \n
    • \n
  • \n

    \n EIA: Compilation for the Elastic Inference Accelerator supports the following \n compiler options:

    \n
      \n
    • \n

      \n precision_mode: Specifies the precision of compiled artifacts. Supported values\n are \"FP16\" and \"FP32\". Default is\n \"FP32\".

      \n
      • \n
    • \n

      \n signature_def_key: Specifies the signature to use for models in SavedModel\n format. Defaults is TensorFlow's default signature def key.

      \n
      • \n
    • \n

      \n output_names: Specifies a list of output tensor names for \n models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.

      \n
      • \n
    \n

    For example: \n {\"precision_mode\": \"FP32\", \"output_names\": [\"output:0\"]}\n

    \n
    • \n
" } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption\n after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.\n For more information, see\n KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n\t

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption\n after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.\n For more information, see\n KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" } } }, @@ -38936,7 +39208,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.

" } }, "S3OutputPath": { @@ -39114,7 +39386,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.

\n \n

The maximum number of items specified for Array Members refers to the\n maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.

\n " + "smithy.api#documentation": "

Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.

\n \n

The maximum number of items specified for Array Members refers to the\n maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.

\n " } }, "com.amazonaws.sagemaker#ParameterType": { @@ -39233,7 +39505,7 @@ "ProductionVariants": { "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "

List of PendingProductionVariantSummary objects.

" + "smithy.api#documentation": "

An array of PendingProductionVariantSummary objects, one for each model\n hosted behind this endpoint for the in-progress deployment.

" } }, "StartTime": { @@ -39245,7 +39517,7 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "

\n Array of ProductionVariant objects, one for each model that you want to host at this endpoint\n in shadow mode with production traffic replicated from the model specified on\n ProductionVariants.If you use this field, you can only specify one variant for\n ProductionVariants and one variant for ShadowProductionVariants.\n

" + "smithy.api#documentation": "

An array of PendingProductionVariantSummary objects, one for each model\n hosted behind this endpoint in shadow mode with production traffic replicated from the\n model specified on ProductionVariants for the in-progress deployment.

" } } }, @@ -40102,14 +40374,14 @@ "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", "traits": { - "smithy.api#documentation": "

The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.

\n \n

Certain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.

\n

For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.

\n ", + "smithy.api#documentation": "

The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.

\n \n

Certain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.

\n

For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.

\n ", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " } } }, @@ -41035,6 +41307,23 @@ } } }, + "com.amazonaws.sagemaker#Processor": { + "type": "enum", + "members": { + "CPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPU" + } + }, + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GPU" + } + } + } + }, "com.amazonaws.sagemaker#ProductId": { "type": "string", "traits": { @@ -41190,7 +41479,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management\n Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n

    \n
    • \n
\n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management\n Service Developer Guide.

" } } }, @@ -42092,7 +42381,7 @@ "Status": { "target": "com.amazonaws.sagemaker#VariantStatus", "traits": { - "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or\n operational status.

\n
    \n
  • \n

    \n Creating: Creating inference resources for the production\n variant.

    \n
    • \n
  • \n

    \n Deleting: Terminating inference resources for the production\n variant.

    \n
    • \n
  • \n

    \n Updating: Updating capacity for the production variant.

    \n
    • \n
  • \n

    \n ActivatingTraffic: Turning on traffic for the production\n variant.

    \n
    • \n
  • \n

    \n Baking: Waiting period to monitor the CloudWatch alarms in the\n automatic rollback configuration.

    \n
    • \n
", + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or\n operational status.

\n
    \n
  • \n

    \n Creating: Creating inference resources for the production\n variant.

    \n
    • \n
  • \n

    \n Deleting: Terminating inference resources for the production\n variant.

    \n
    • \n
  • \n

    \n Updating: Updating capacity for the production variant.

    \n
    • \n
  • \n

    \n ActivatingTraffic: Turning on traffic for the production\n variant.

    \n
    • \n
  • \n

    \n Baking: Waiting period to monitor the CloudWatch alarms in the\n automatic rollback configuration.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -42424,6 +42713,16 @@ } } }, + "com.amazonaws.sagemaker#ProgrammingLang": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" + } + }, "com.amazonaws.sagemaker#Project": { "type": "structure", "members": { @@ -42787,7 +43086,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

\n

Use one of the following prices for bounding box tasks. Prices are in US dollars and\n should be based on the complexity of the task; the longer it takes in your initial\n testing, the more you should offer.

\n
    \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for image classification, text classification, and\n custom tasks. Prices are in US dollars.

\n
    \n
  • \n

    0.012

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for semantic segmentation tasks. Prices are in US\n dollars.

\n
    \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon\n Augmented AI review tasks. Prices are in US dollars.

\n
    \n
  • \n

    2.400

    \n
    • \n
  • \n

    2.280

    \n
    • \n
  • \n

    2.160

    \n
    • \n
  • \n

    2.040

    \n
    • \n
  • \n

    1.920

    \n
    • \n
  • \n

    1.800

    \n
    • \n
  • \n

    1.680

    \n
    • \n
  • \n

    1.560

    \n
    • \n
  • \n

    1.440

    \n
    • \n
  • \n

    1.320

    \n
    • \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
\n

Use one of the following prices for Rekognition DetectModerationLabels Amazon\n Augmented AI review tasks. Prices are in US dollars.

\n
    \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
\n

Use one of the following prices for Amazon Augmented AI custom human review tasks.\n Prices are in US dollars.

\n
    \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
" + "smithy.api#documentation": "

Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

\n

Use one of the following prices for bounding box tasks. Prices are in US dollars and\n should be based on the complexity of the task; the longer it takes in your initial\n testing, the more you should offer.

\n
    \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for image classification, text classification, and\n custom tasks. Prices are in US dollars.

\n
    \n
  • \n

    0.012

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for semantic segmentation tasks. Prices are in US\n dollars.

\n
    \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    1.200

    \n
    • \n
\n

Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon\n Augmented AI review tasks. Prices are in US dollars.

\n
    \n
  • \n

    2.400

    \n
    • \n
  • \n

    2.280

    \n
    • \n
  • \n

    2.160

    \n
    • \n
  • \n

    2.040

    \n
    • \n
  • \n

    1.920

    \n
    • \n
  • \n

    1.800

    \n
    • \n
  • \n

    1.680

    \n
    • \n
  • \n

    1.560

    \n
    • \n
  • \n

    1.440

    \n
    • \n
  • \n

    1.320

    \n
    • \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
\n

Use one of the following prices for Rekognition DetectModerationLabels Amazon\n Augmented AI review tasks. Prices are in US dollars.

\n
    \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
\n

Use one of the following prices for Amazon Augmented AI custom human review tasks.\n Prices are in US dollars.

\n
    \n
  • \n

    1.200

    \n
    • \n
  • \n

    1.080

    \n
    • \n
  • \n

    0.960

    \n
    • \n
  • \n

    0.840

    \n
    • \n
  • \n

    0.720

    \n
    • \n
  • \n

    0.600

    \n
    • \n
  • \n

    0.480

    \n
    • \n
  • \n

    0.360

    \n
    • \n
  • \n

    0.240

    \n
    • \n
  • \n

    0.120

    \n
    • \n
  • \n

    0.072

    \n
    • \n
  • \n

    0.060

    \n
    • \n
  • \n

    0.048

    \n
    • \n
  • \n

    0.036

    \n
    • \n
  • \n

    0.024

    \n
    • \n
  • \n

    0.012

    \n
    • \n
" } }, "com.amazonaws.sagemaker#PutModelPackageGroupPolicy": { @@ -43232,26 +43531,34 @@ } } }, + "com.amazonaws.sagemaker#RandomSeed": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#RealTimeInferenceConfig": { "type": "structure", "members": { "InstanceType": { "target": "com.amazonaws.sagemaker#InstanceType", "traits": { - "smithy.api#documentation": "

The number of instances of the type specified by InstanceType.

", + "smithy.api#documentation": "

The instance type the model is deployed to.

", "smithy.api#required": {} } }, "InstanceCount": { "target": "com.amazonaws.sagemaker#TaskCount", "traits": { - "smithy.api#documentation": "

The instance type the model is deployed to.

", + "smithy.api#documentation": "

The number of instances of the type specified by InstanceType.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The infrastructure configuration for deploying the model to real-time inference.

" + "smithy.api#documentation": "

The infrastructure configuration for deploying the model to a real-time inference endpoint.

" } }, "com.amazonaws.sagemaker#RealtimeInferenceInstanceTypes": { @@ -43409,7 +43716,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. \n This key will be passed to SageMaker Hosting for endpoint creation.

\n \n

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage \n volume of the endpoints created for inference recommendation. The inference recommendation job will fail \n asynchronously during endpoint configuration creation if the role passed does not have \n kms:CreateGrant permission.

\n \n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:::key/\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:::alias/\"\n

    \n
    • \n
\n

For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. \n This key will be passed to SageMaker Hosting for endpoint creation.

\n

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage \n volume of the endpoints created for inference recommendation. The inference recommendation job will fail \n asynchronously during endpoint configuration creation if the role passed does not have \n kms:CreateGrant permission.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:::key/\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:::alias/\"\n

    \n
    • \n
\n

For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" } }, "ContainerConfig": { @@ -43423,6 +43730,12 @@ "traits": { "smithy.api#documentation": "

Existing customer endpoints on which to run an Inference Recommender job.

" } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcConfig", + "traits": { + "smithy.api#documentation": "

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

" + } } }, "traits": { @@ -43445,7 +43758,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. \n The SageMaker execution role must have kms:GenerateDataKey permission.

\n \n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:::key/\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:::alias/\"\n

    \n
    • \n
\n

For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. \n The SageMaker execution role must have kms:GenerateDataKey permission.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:::key/\"\n

    \n
    • \n
  • \n

    // KMS Key Alias

    \n

    \n \"alias/ExampleAlias\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key Alias

    \n

    \n \"arn:aws:kms:::alias/\"\n

    \n
    • \n
\n

For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" } }, "CompiledOutputConfig": { @@ -43590,6 +43903,72 @@ } } }, + "com.amazonaws.sagemaker#RecommendationJobVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs. IDs have the form of sg-xxxxxxxx.\n Specify the security groups for the VPC that is specified in the Subnets field.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSubnets", + "traits": { + "smithy.api#documentation": "

The ID of the subnets in the VPC to which you want to connect your model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, "com.amazonaws.sagemaker#RecommendationMetrics": { "type": "structure", "members": { @@ -43877,6 +44256,16 @@ "smithy.api#documentation": "

Metadata for a register model job step.

" } }, + "com.amazonaws.sagemaker#ReleaseNotes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.sagemaker#RenderUiTemplate": { "type": "operation", "input": { @@ -43920,7 +44309,7 @@ "HumanTaskUiArn": { "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { - "smithy.api#documentation": "

The HumanTaskUiArn of the worker UI that you want to render. Do not\n provide a HumanTaskUiArn if you use the UiTemplate\n parameter.

\n

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

" + "smithy.api#documentation": "

The HumanTaskUiArn of the worker UI that you want to render. Do not\n provide a HumanTaskUiArn if you use the UiTemplate\n parameter.

\n

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

" } } } @@ -44075,7 +44464,7 @@ "InstanceType": { "target": "com.amazonaws.sagemaker#TrainingInstanceType", "traits": { - "smithy.api#documentation": "

The ML compute instance type.

" + "smithy.api#documentation": "

The ML compute instance type.

\n \n

SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting\n December 9th, 2022.

\n

\n Amazon EC2 P4de instances\n (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance\n HBM2e GPU memory, which accelerate the speed of training ML models that need to be\n trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker\n supports ML training jobs on P4de instances (ml.p4de.24xlarge) to\n reduce model training time. The ml.p4de.24xlarge instances are\n available in the following Amazon Web Services Regions.

\n
    \n
  • \n

    US East (N. Virginia) (us-east-1)

    \n
    • \n
  • \n

    US West (Oregon) (us-west-2)

    \n
    • \n
\n

To request quota limit increase and start using P4de instances, contact the SageMaker\n Training service team through your account team.

\n " } }, "InstanceCount": { @@ -44089,14 +44478,14 @@ "target": "com.amazonaws.sagemaker#VolumeSizeInGB", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The size of the ML storage volume that you want to provision.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.

\n

When using an ML instance with NVMe SSD\n volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.\n Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures\n storage paths for training datasets, checkpoints, model artifacts, and outputs to use\n the entire capacity of the instance storage. For example, ML instance families with the\n NVMe-type instance storage include ml.p4d, ml.g4dn, and\n ml.g5.

\n

When using an ML instance with the EBS-only storage option and without instance\n storage, you must define the size of EBS volume through VolumeSizeInGB in\n the ResourceConfig API. For example, ML instance families that use EBS\n volumes include ml.c5 and ml.p2.

\n

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

\n

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker\n Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and\n Outputs.

", + "smithy.api#documentation": "

The size of the ML storage volume that you want to provision.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.

\n

When using an ML instance with NVMe SSD\n volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.\n Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures\n storage paths for training datasets, checkpoints, model artifacts, and outputs to use\n the entire capacity of the instance storage. For example, ML instance families with the\n NVMe-type instance storage include ml.p4d, ml.g4dn, and\n ml.g5.

\n

When using an ML instance with the EBS-only storage option and without instance\n storage, you must define the size of EBS volume through VolumeSizeInGB in\n the ResourceConfig API. For example, ML instance families that use EBS\n volumes include ml.c5 and ml.p2.

\n

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

\n

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker\n Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and\n Outputs.

", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

\n
    \n
  • \n

    // KMS Key ID

    \n

    \n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
  • \n

    // Amazon Resource Name (ARN) of a KMS Key

    \n

    \n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

    \n
    • \n
" } }, "InstanceGroups": { @@ -44113,7 +44502,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the resources, including ML compute instances and ML storage volumes, to\n use for model training.

" + "smithy.api#documentation": "

Describes the resources, including machine learning (ML) compute instances and ML\n storage volumes, to use for model training.

" } }, "com.amazonaws.sagemaker#ResourceConfigForUpdate": { @@ -44592,21 +44981,21 @@ "S3DataType": { "target": "com.amazonaws.sagemaker#S3DataType", "traits": { - "smithy.api#documentation": "

If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix for model training.

\n

If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want SageMaker to use for model\n training.

\n

If you choose AugmentedManifestFile, S3Uri identifies an object that is\n an augmented manifest file in JSON lines format. This file contains the data you want to\n use for model training. AugmentedManifestFile can only be used if the\n Channel's input mode is Pipe.

", + "smithy.api#documentation": "

If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix for model training.

\n

If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want SageMaker to use for model\n training.

\n

If you choose AugmentedManifestFile, S3Uri identifies an object that is\n an augmented manifest file in JSON lines format. This file contains the data you want to\n use for model training. AugmentedManifestFile can only be used if the\n Channel's input mode is Pipe.

", "smithy.api#required": {} } }, "S3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:

\n
    \n
  • \n

    A key name prefix might look like this:\n s3://bucketname/exampleprefix\n

    \n
    • \n
  • \n

    A manifest might look like this:\n s3://bucketname/example.manifest\n

    \n

    A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set\n of S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.

    \n

    The following code example shows a valid manifest format:

    \n

    \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

    \n

    \n \"relative/path/to/custdata-1\",\n

    \n

    \n \"relative/path/custdata-2\",\n

    \n

    \n ...\n

    \n

    \n \"relative/path/custdata-N\"\n

    \n

    \n ]\n

    \n

    This JSON is equivalent to the following S3Uri\n list:

    \n

    \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

    \n

    \n ...\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

    \n

    The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.

    \n
    • \n
", + "smithy.api#documentation": "

Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:

\n
    \n
  • \n

    A key name prefix might look like this:\n s3://bucketname/exampleprefix\n

    \n
    • \n
  • \n

    A manifest might look like this:\n s3://bucketname/example.manifest\n

    \n

    A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set\n of S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.

    \n

    The following code example shows a valid manifest format:

    \n

    \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

    \n

    \n \"relative/path/to/custdata-1\",\n

    \n

    \n \"relative/path/custdata-2\",\n

    \n

    \n ...\n

    \n

    \n \"relative/path/custdata-N\"\n

    \n

    \n ]\n

    \n

    This JSON is equivalent to the following S3Uri\n list:

    \n

    \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

    \n

    \n ...\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

    \n

    The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.

    \n
    • \n
", "smithy.api#required": {} } }, "S3DataDistributionType": { "target": "com.amazonaws.sagemaker#S3DataDistribution", "traits": { - "smithy.api#documentation": "

If you want SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.

\n

If you want SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.

\n

Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.

\n

In distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.

" + "smithy.api#documentation": "

If you want SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.

\n

If you want SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.

\n

Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.

\n

In distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.

" } }, "AttributeNames": { @@ -45213,6 +45602,9 @@ { "target": "com.amazonaws.sagemaker#ListAlgorithms" }, + { + "target": "com.amazonaws.sagemaker#ListAliases" + }, { "target": "com.amazonaws.sagemaker#ListAppImageConfigs" }, @@ -45543,6 +45935,9 @@ { "target": "com.amazonaws.sagemaker#UpdateImage" }, + { + "target": "com.amazonaws.sagemaker#UpdateImageVersion" + }, { "target": "com.amazonaws.sagemaker#UpdateInferenceExperiment" }, @@ -45607,7 +46002,7 @@ "name": "sagemaker" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Provides APIs for creating and managing SageMaker resources.

\n

Other Resources:

\n ", + "smithy.api#documentation": "

Provides APIs for creating and managing SageMaker resources.

\n

Other Resources:

\n ", "smithy.api#title": "Amazon SageMaker Service", "smithy.api#xmlNamespace": { "uri": "http://sagemaker.amazonaws.com/doc/2017-05-13/" @@ -45666,15 +46061,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -46006,9 +46392,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -46019,9 +46405,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -46032,9 +46418,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -46045,9 +46431,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -46058,9 +46444,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -46071,9 +46457,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -46084,9 +46470,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -46097,9 +46483,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -46110,9 +46496,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -46123,9 +46509,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -46136,9 +46522,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -46149,9 +46535,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -46162,9 +46548,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -46175,9 +46561,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -46188,9 +46574,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -46201,9 +46587,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -46214,9 +46600,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -46227,9 +46613,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -46240,9 +46626,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -46253,9 +46639,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -46266,9 +46652,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -46279,9 +46665,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -46292,9 +46678,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -46305,9 +46691,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -46318,9 +46704,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -46331,9 +46717,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -46344,9 +46730,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -46357,9 +46743,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -46370,9 +46756,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -46383,9 +46769,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -46396,9 +46782,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -46409,9 +46795,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -46422,9 +46808,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -46435,9 +46821,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -46448,9 +46834,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -46461,9 +46847,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -46474,9 +46860,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -46487,9 +46873,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -46500,9 +46886,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -46513,9 +46899,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -46526,9 +46912,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -46539,9 +46925,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -46552,9 +46938,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -46565,9 +46951,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -46578,9 +46964,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -46591,9 +46977,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -46604,9 +46990,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -46617,9 +47003,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -46630,9 +47016,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -46643,9 +47029,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -46656,9 +47042,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -46669,9 +47055,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -46682,9 +47068,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -46695,9 +47081,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -46708,9 +47094,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -46721,9 +47107,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -46734,9 +47120,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -46747,9 +47133,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -46760,9 +47146,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -46773,9 +47159,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -46786,9 +47172,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -46799,9 +47185,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -46812,9 +47198,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -46825,9 +47211,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -46838,9 +47224,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -46851,9 +47237,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -46864,9 +47250,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -46877,9 +47263,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -46890,9 +47276,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -46903,9 +47289,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -46916,9 +47302,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -46929,9 +47315,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -46942,9 +47328,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -46955,9 +47341,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -46968,9 +47354,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -46981,9 +47367,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -46994,9 +47380,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -47007,9 +47393,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -47020,9 +47406,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -47033,9 +47419,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -47046,9 +47432,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -47059,9 +47445,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -47072,9 +47458,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -47085,9 +47471,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -47098,9 +47484,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -47111,9 +47497,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -47124,9 +47510,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -47137,9 +47523,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -47150,9 +47536,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -47163,9 +47549,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -47176,9 +47562,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -47189,9 +47575,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -47200,9 +47586,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -47213,9 +47599,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -47224,9 +47610,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -47237,9 +47623,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -47250,9 +47636,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -47263,9 +47649,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -47276,9 +47662,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -47289,9 +47675,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -47302,9 +47688,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -47315,9 +47701,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -47328,9 +47714,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -47341,9 +47727,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -47354,9 +47740,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -47367,9 +47753,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -47380,9 +47766,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -47393,9 +47779,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -47406,9 +47792,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -47419,9 +47805,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -47432,9 +47818,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -47445,9 +47831,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -47456,9 +47842,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -47469,9 +47855,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -47480,9 +47866,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -47493,9 +47879,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -47506,9 +47892,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -47518,9 +47904,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -47530,9 +47916,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -47541,6 +47927,22 @@ } } }, + "com.amazonaws.sagemaker#SageMakerImageVersionAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!^[.-])^([a-zA-Z0-9-_.]+)$" + } + }, + "com.amazonaws.sagemaker#SageMakerImageVersionAliases": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias" + } + }, "com.amazonaws.sagemaker#SagemakerServicecatalogStatus": { "type": "enum", "members": { @@ -47573,7 +47975,7 @@ "ScheduleExpression": { "target": "com.amazonaws.sagemaker#ScheduleExpression", "traits": { - "smithy.api#documentation": "

A cron expression that describes details about the monitoring schedule.

\n\n

Currently the only supported cron expressions are:

\n
    \n
  • \n

    If you want to set the job to start every hour, please use the following:

    \n

    \n Hourly: cron(0 * ? * * *)\n

    \n
    • \n
  • \n

    If you want to start the job daily:

    \n

    \n cron(0 [00-23] ? * * *)\n

    \n
    • \n
\n

For example, the following are valid cron expressions:

\n
    \n
  • \n

    Daily at noon UTC: cron(0 12 ? * * *)\n

    \n
    • \n
  • \n

    Daily at midnight UTC: cron(0 0 ? * * *)\n

    \n
    • \n
\n\n

To support running every 6, 12 hours, the following are also supported:

\n

\n cron(0 [00-23]/[01-24] ? * * *)\n

\n

For example, the following are valid cron expressions:

\n
    \n
  • \n

    Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)\n

    \n
    • \n
  • \n

    Every two hours starting at midnight: cron(0 0/2 ? * * *)\n

    \n
    • \n
\n\n \n
    \n
  • \n

    Even though the cron expression is set to start at 5PM UTC, note that there\n could be a delay of 0-20 minutes from the actual requested time to run the\n execution.

    \n
    • \n
  • \n

    We recommend that if you would like a daily schedule, you do not provide this\n parameter. Amazon SageMaker will pick a time for running every day.

    \n
    • \n
\n ", + "smithy.api#documentation": "

A cron expression that describes details about the monitoring schedule.

\n

Currently the only supported cron expressions are:

\n
    \n
  • \n

    If you want to set the job to start every hour, please use the following:

    \n

    \n Hourly: cron(0 * ? * * *)\n

    \n
    • \n
  • \n

    If you want to start the job daily:

    \n

    \n cron(0 [00-23] ? * * *)\n

    \n
    • \n
\n

For example, the following are valid cron expressions:

\n
    \n
  • \n

    Daily at noon UTC: cron(0 12 ? * * *)\n

    \n
    • \n
  • \n

    Daily at midnight UTC: cron(0 0 ? * * *)\n

    \n
    • \n
\n

To support running every 6, 12 hours, the following are also supported:

\n

\n cron(0 [00-23]/[01-24] ? * * *)\n

\n

For example, the following are valid cron expressions:

\n
    \n
  • \n

    Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)\n

    \n
    • \n
  • \n

    Every two hours starting at midnight: cron(0 0/2 ? * * *)\n

    \n
    • \n
\n \n
    \n
  • \n

    Even though the cron expression is set to start at 5PM UTC, note that there\n could be a delay of 0-20 minutes from the actual requested time to run the\n execution.

    \n
    • \n
  • \n

    We recommend that if you would like a daily schedule, you do not provide this\n parameter. Amazon SageMaker will pick a time for running every day.

    \n
    • \n
\n ", "smithy.api#required": {} } } @@ -47948,7 +48350,7 @@ "Status": { "target": "com.amazonaws.sagemaker#SecondaryStatus", "traits": { - "smithy.api#documentation": "

Contains a secondary status information from a training\n job.

\n

Status might be one of the following secondary statuses:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTrainingStack\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
", + "smithy.api#documentation": "

Contains a secondary status information from a training\n job.

\n

Status might be one of the following secondary statuses:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTrainingStack\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -47968,12 +48370,12 @@ "StatusMessage": { "target": "com.amazonaws.sagemaker#StatusMessage", "traits": { - "smithy.api#documentation": "

A detailed description of the progress within a secondary status.\n

\n

SageMaker provides secondary statuses and status messages that apply to each of\n them:

\n
\n
Starting
\n
\n
    \n
  • \n

    Starting the training job.

    \n
    • \n
  • \n

    Launching requested ML\n instances.

    \n
    • \n
  • \n

    Insufficient\n capacity error from EC2 while launching instances,\n retrying!

    \n
    • \n
  • \n

    Launched\n instance was unhealthy, replacing it!

    \n
    • \n
  • \n

    Preparing the instances for training.

    \n
    • \n
\n
\n
Training
\n
\n
    \n
  • \n

    Downloading the training image.

    \n
    • \n
  • \n

    Training\n image download completed. Training in\n progress.

    \n
    • \n
\n
\n
\n \n

Status messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.

\n \n

To have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For\n example, at the start of a training job, you might see the following:

\n
    \n
  • \n

    \n TrainingJobStatus - InProgress

    \n
    • \n
  • \n

    \n SecondaryStatus - Training

    \n
    • \n
  • \n

    \n StatusMessage - Downloading the training image

    \n
    • \n
" + "smithy.api#documentation": "

A detailed description of the progress within a secondary status.\n

\n

SageMaker provides secondary statuses and status messages that apply to each of\n them:

\n
\n
Starting
\n
\n
    \n
  • \n

    Starting the training job.

    \n
    • \n
  • \n

    Launching requested ML\n instances.

    \n
    • \n
  • \n

    Insufficient\n capacity error from EC2 while launching instances,\n retrying!

    \n
    • \n
  • \n

    Launched\n instance was unhealthy, replacing it!

    \n
    • \n
  • \n

    Preparing the instances for training.

    \n
    • \n
\n
\n
Training
\n
\n
    \n
  • \n

    Downloading the training image.

    \n
    • \n
  • \n

    Training\n image download completed. Training in\n progress.

    \n
    • \n
\n
\n
\n \n

Status messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.

\n \n

To have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For\n example, at the start of a training job, you might see the following:

\n
    \n
  • \n

    \n TrainingJobStatus - InProgress

    \n
    • \n
  • \n

    \n SecondaryStatus - Training

    \n
    • \n
  • \n

    \n StatusMessage - Downloading the training image

    \n
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides\n additional details about a status that the training job has transitioned through. A\n training job can be in one of several states, for example, starting, downloading,\n training, or uploading. Within each state, there are a number of intermediate states.\n For example, within the starting state, SageMaker could be starting the training job or\n launching the ML instances. These transitional states are referred to as the job's\n secondary\n status.\n

\n

" + "smithy.api#documentation": "

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides\n additional details about a status that the training job has transitioned through. A\n training job can be in one of several states, for example, starting, downloading,\n training, or uploading. Within each state, there are a number of intermediate states.\n For example, within the starting state, SageMaker could be starting the training job or\n launching the ML instances. These transitional states are referred to as the job's\n secondary\n status.\n

\n

" } }, "com.amazonaws.sagemaker#SecondaryStatusTransitions": { @@ -48172,7 +48574,7 @@ "ProvisionedProductStatusMessage": { "target": "com.amazonaws.sagemaker#ProvisionedProductStatusMessage", "traits": { - "smithy.api#documentation": "

The current status of the product.

\n
    \n
  • \n

    \n AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

    \n
    • \n
  • \n

    \n UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

    \n
    • \n
  • \n

    \n TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

    \n
    • \n
  • \n

    \n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

    \n
    • \n
  • \n

    \n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

    \n
    • \n
" + "smithy.api#documentation": "

The current status of the product.

\n
    \n
  • \n

    \n AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

    \n
    • \n
  • \n

    \n UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

    \n
    • \n
  • \n

    \n TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

    \n
    • \n
  • \n

    \n ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

    \n
    • \n
  • \n

    \n PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

    \n
    • \n
" } } }, @@ -48248,7 +48650,7 @@ "SourceModelVariantName": { "target": "com.amazonaws.sagemaker#ModelVariantName", "traits": { - "smithy.api#documentation": "

\n The name of the production variant.\n

", + "smithy.api#documentation": "

\n The name of the production variant, which takes all the inference requests.\n

", "smithy.api#required": {} } }, @@ -48261,7 +48663,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Shows which variant is a production variant and which variant is a shadow variant. For shadow\n variants, also shows the sampling percentages.\n

" + "smithy.api#documentation": "

\n The configuration of ShadowMode inference experiment type, which specifies a production variant\n to take all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the\n inference requests. For the shadow variant it also specifies the percentage of requests that Amazon SageMaker replicates.\n

" } }, "com.amazonaws.sagemaker#ShadowModelVariantConfig": { @@ -48278,7 +48680,7 @@ "target": "com.amazonaws.sagemaker#Percentage", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of inference requests that are replicated to the shadow variant.

", + "smithy.api#documentation": "

\n The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.\n

", "smithy.api#required": {} } } @@ -48338,7 +48740,7 @@ } }, "traits": { - "smithy.api#documentation": "

A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, the results of the S3 key prefix\n matches are shuffled. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.

\n

For Pipe input mode, when ShuffleConfig is specified shuffling is done at\n the start of every epoch. With large datasets, this ensures that the order of the\n training data is different for each epoch, and it helps reduce bias and possible\n overfitting. In a multi-node training job when ShuffleConfig is combined\n with S3DataDistributionType of ShardedByS3Key, the data is\n shuffled across nodes so that the content sent to a particular node on the first epoch\n might be sent to a different node on the second epoch.

" + "smithy.api#documentation": "

A configuration for a shuffle option for input data in a channel. If you use\n S3Prefix for S3DataType, the results of the S3 key prefix\n matches are shuffled. If you use ManifestFile, the order of the S3 object\n references in the ManifestFile is shuffled. If you use\n AugmentedManifestFile, the order of the JSON lines in the\n AugmentedManifestFile is shuffled. The shuffling order is determined\n using the Seed value.

\n

For Pipe input mode, when ShuffleConfig is specified shuffling is done at\n the start of every epoch. With large datasets, this ensures that the order of the\n training data is different for each epoch, and it helps reduce bias and possible\n overfitting. In a multi-node training job when ShuffleConfig is combined\n with S3DataDistributionType of ShardedByS3Key, the data is\n shuffled across nodes so that the content sent to a particular node on the first epoch\n might be sent to a different node on the second epoch.

" } }, "com.amazonaws.sagemaker#SingleSignOnUserIdentifier": { @@ -48608,7 +49010,7 @@ "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n algorithm.

\n " + "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n algorithm.

\n " } }, "AlgorithmName": { @@ -48656,7 +49058,7 @@ "Cidrs": { "target": "com.amazonaws.sagemaker#Cidrs", "traits": { - "smithy.api#documentation": "

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

\n

Maximum: Ten CIDR values

\n \n

The following Length Constraints apply to individual CIDR values in\n the CIDR value list.

\n ", + "smithy.api#documentation": "

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

\n

Maximum: Ten CIDR values

\n \n

The following Length Constraints apply to individual CIDR values in\n the CIDR value list.

\n ", "smithy.api#required": {} } } @@ -49251,7 +49653,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a model compilation job.

\n

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the\n job down. If the job hasn't stopped, it sends the SIGKILL signal.

\n

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to\n Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.\n

" + "smithy.api#documentation": "

Stops a model compilation job.

\n

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the\n job down. If the job hasn't stopped, it sends the SIGKILL signal.

\n

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to\n Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.\n

" } }, "com.amazonaws.sagemaker#StopCompilationJobRequest": { @@ -49335,7 +49737,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a running hyperparameter tuning job and all running training jobs that the\n tuning job launched.

\n

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All\n data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the\n tuning job moves to the Stopped state, it releases all\n reserved\n resources for the tuning job.

" + "smithy.api#documentation": "

Stops a running hyperparameter tuning job and all running training jobs that the\n tuning job launched.

\n

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All\n data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the\n tuning job moves to the Stopped state, it releases all\n reserved\n resources for the tuning job.

" } }, "com.amazonaws.sagemaker#StopHyperParameterTuningJobRequest": { @@ -49383,20 +49785,20 @@ "ModelVariantActions": { "target": "com.amazonaws.sagemaker#ModelVariantActionMap", "traits": { - "smithy.api#documentation": "

\n Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:\n

\n
    \n
  • \n

    \n Promote - Promote the shadow variant to a production variant

    \n
    • \n
  • \n

    \n Remove - Delete the variant

    \n
    • \n
  • \n

    \n Retain - Keep the variant as it is

    \n
    • \n
", + "smithy.api#documentation": "

\n Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:\n

\n
    \n
  • \n

    \n Promote - Promote the shadow variant to a production variant

    \n
    • \n
  • \n

    \n Remove - Delete the variant

    \n
    • \n
  • \n

    \n Retain - Keep the variant as it is

    \n
    • \n
", "smithy.api#required": {} } }, "DesiredModelVariants": { "target": "com.amazonaws.sagemaker#ModelVariantConfigList", "traits": { - "smithy.api#documentation": "

\n Array of ModelVariantConfig objects. There is one for each variant that you want to deploy\n after the inference experiment stops. Each ModelVariantConfig describes the infrastructure\n configuration for deploying the corresponding variant.\n

" + "smithy.api#documentation": "

\n An array of ModelVariantConfig objects. There is one for each variant that you want to deploy\n after the inference experiment stops. Each ModelVariantConfig describes the infrastructure\n configuration for deploying the corresponding variant.\n

" } }, "DesiredState": { "target": "com.amazonaws.sagemaker#InferenceExperimentStopDesiredState", "traits": { - "smithy.api#documentation": "

\n The desired state of the experiment after stopping. The possible states are the following:\n

\n
    \n
  • \n

    \n Completed: The experiment completed successfully

    \n
    • \n
  • \n

    \n Cancelled: The experiment was canceled

    \n
    • \n
" + "smithy.api#documentation": "

\n The desired state of the experiment after stopping. The possible states are the following:\n

\n
    \n
  • \n

    \n Completed: The experiment completed successfully

    \n
    • \n
  • \n

    \n Cancelled: The experiment was canceled

    \n
    • \n
" } }, "Reason": { @@ -49515,7 +49917,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Terminates the ML compute instance. Before terminating the instance, SageMaker\n disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker\n stops charging you for the ML compute instance when you call\n StopNotebookInstance.

\n

To access data on the ML storage volume for a notebook instance that has been\n terminated, call the StartNotebookInstance API.\n StartNotebookInstance launches another ML compute instance, configures\n it, and attaches the preserved ML storage volume so you can continue your work.\n

" + "smithy.api#documentation": "

Terminates the ML compute instance. Before terminating the instance, SageMaker\n disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker\n stops charging you for the ML compute instance when you call\n StopNotebookInstance.

\n

To access data on the ML storage volume for a notebook instance that has been\n terminated, call the StartNotebookInstance API.\n StartNotebookInstance launches another ML compute instance, configures\n it, and attaches the preserved ML storage volume so you can continue your work.\n

" } }, "com.amazonaws.sagemaker#StopNotebookInstanceInput": { @@ -49544,7 +49946,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a pipeline execution.

\n\n

\n Callback Step\n

\n

A pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".

\n

You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.

\n

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

\n\n

\n Lambda Step\n

\n

A pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.

" + "smithy.api#documentation": "

Stops a pipeline execution.

\n

\n Callback Step\n

\n

A pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".

\n

You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.

\n

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

\n

\n Lambda Step\n

\n

A pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.

" } }, "com.amazonaws.sagemaker#StopPipelineExecutionRequest": { @@ -49621,7 +50023,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a training job. To stop a job, SageMaker sends the algorithm the\n SIGTERM signal, which delays job termination for 120 seconds.\n Algorithms might use this 120-second window to save the model artifacts, so the results\n of the training is not lost.

\n

When it receives a StopTrainingJob request, SageMaker changes the status of\n the job to Stopping. After SageMaker stops the job, it sets the status to\n Stopped.

" + "smithy.api#documentation": "

Stops a training job. To stop a job, SageMaker sends the algorithm the\n SIGTERM signal, which delays job termination for 120 seconds.\n Algorithms might use this 120-second window to save the model artifacts, so the results\n of the training is not lost.

\n

When it receives a StopTrainingJob request, SageMaker changes the status of\n the job to Stopping. After SageMaker stops the job, it sets the status to\n Stopped.

" } }, "com.amazonaws.sagemaker#StopTrainingJobRequest": { @@ -49650,7 +50052,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a batch transform job.

\n

When Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

" + "smithy.api#documentation": "

Stops a batch transform job.

\n

When Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

" } }, "com.amazonaws.sagemaker#StopTransformJobRequest": { @@ -49672,18 +50074,18 @@ "target": "com.amazonaws.sagemaker#MaxRuntimeInSeconds", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can run\n before it is stopped.

\n

For compilation jobs, if the job does not complete during this time, a\n TimeOut error is generated. We recommend starting with 900 seconds and\n increasing as necessary based on your model.

\n

For all other jobs, if the job does not complete during this time, SageMaker ends the job.\n When RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is\n 28 days.

\n

The maximum time that a TrainingJob can run in total, including any time\n spent publishing metrics or archiving and uploading models after it has been stopped, is\n 30 days.

" + "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can run\n before it is stopped.

\n

For compilation jobs, if the job does not complete during this time, a\n TimeOut error is generated. We recommend starting with 900 seconds and\n increasing as necessary based on your model.

\n

For all other jobs, if the job does not complete during this time, SageMaker ends the job.\n When RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is\n 28 days.

\n

The maximum time that a TrainingJob can run in total, including any time\n spent publishing metrics or archiving and uploading models after it has been stopped, is\n 30 days.

" } }, "MaxWaitTimeInSeconds": { "target": "com.amazonaws.sagemaker#MaxWaitTimeInSeconds", "traits": { - "smithy.api#documentation": "

The maximum length of time, in seconds, that a managed Spot training job has to\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n SageMaker ends the job.

\n

When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.

" + "smithy.api#documentation": "

The maximum length of time, in seconds, that a managed Spot training job has to\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n SageMaker ends the job.

\n

When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job or model compilation job can run.\n It also specifies how long a managed spot training job has to complete. When the job\n reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap\n model training costs.

\n

To stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.

\n

The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.

\n \n

The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.

\n " + "smithy.api#documentation": "

Specifies a limit to how long a model training job or model compilation job can run.\n It also specifies how long a managed spot training job has to complete. When the job\n reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap\n model training costs.

\n

To stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.

\n

The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.

\n \n

The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.

\n " } }, "com.amazonaws.sagemaker#String": { @@ -50038,7 +50440,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata\n for SageMaker Amazon Web Services resources.

\n

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to SageMaker resources, see AddTags.

\n

For more information on adding metadata to your Amazon Web Services resources with\n tagging, see Tagging Amazon Web Services resources. For advice on best practices for\n managing Amazon Web Services resources with tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging\n Strategy.

" + "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata\n for SageMaker Amazon Web Services resources.

\n

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to SageMaker resources, see AddTags.

\n

For more information on adding metadata to your Amazon Web Services resources with\n tagging, see Tagging Amazon Web Services resources. For advice on best practices for\n managing Amazon Web Services resources with tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging\n Strategy.

" } }, "com.amazonaws.sagemaker#TagKey": { @@ -50299,21 +50701,21 @@ "Os": { "target": "com.amazonaws.sagemaker#TargetPlatformOs", "traits": { - "smithy.api#documentation": "

Specifies a target platform OS.

\n
    \n
  • \n

    \n LINUX: Linux-based operating systems.

    \n
    • \n
  • \n

    \n ANDROID: Android operating systems. Android API level can be\n specified using the ANDROID_PLATFORM compiler option. For example,\n \"CompilerOptions\": {'ANDROID_PLATFORM': 28}\n

    \n
    • \n
", + "smithy.api#documentation": "

Specifies a target platform OS.

\n
    \n
  • \n

    \n LINUX: Linux-based operating systems.

    \n
    • \n
  • \n

    \n ANDROID: Android operating systems. Android API level can be\n specified using the ANDROID_PLATFORM compiler option. For example,\n \"CompilerOptions\": {'ANDROID_PLATFORM': 28}\n

    \n
    • \n
", "smithy.api#required": {} } }, "Arch": { "target": "com.amazonaws.sagemaker#TargetPlatformArch", "traits": { - "smithy.api#documentation": "

Specifies a target platform architecture.

\n
    \n
  • \n

    \n X86_64: 64-bit version of the x86 instruction set.

    \n
    • \n
  • \n

    \n X86: 32-bit version of the x86 instruction set.

    \n
    • \n
  • \n

    \n ARM64: ARMv8 64-bit CPU.

    \n
    • \n
  • \n

    \n ARM_EABIHF: ARMv7 32-bit, Hard Float.

    \n
    • \n
  • \n

    \n ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM\n platform.

    \n
    • \n
", + "smithy.api#documentation": "

Specifies a target platform architecture.

\n
    \n
  • \n

    \n X86_64: 64-bit version of the x86 instruction set.

    \n
    • \n
  • \n

    \n X86: 32-bit version of the x86 instruction set.

    \n
    • \n
  • \n

    \n ARM64: ARMv8 64-bit CPU.

    \n
    • \n
  • \n

    \n ARM_EABIHF: ARMv7 32-bit, Hard Float.

    \n
    • \n
  • \n

    \n ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM\n platform.

    \n
    • \n
", "smithy.api#required": {} } }, "Accelerator": { "target": "com.amazonaws.sagemaker#TargetPlatformAccelerator", "traits": { - "smithy.api#documentation": "

Specifies a target platform accelerator (optional).

\n
    \n
  • \n

    \n NVIDIA: Nvidia graphics processing unit. It also requires\n gpu-code, trt-ver, cuda-ver compiler\n options

    \n
    • \n
  • \n

    \n MALI: ARM Mali graphics processor

    \n
    • \n
  • \n

    \n INTEL_GRAPHICS: Integrated Intel graphics

    \n
    • \n
" + "smithy.api#documentation": "

Specifies a target platform accelerator (optional).

\n
    \n
  • \n

    \n NVIDIA: Nvidia graphics processing unit. It also requires\n gpu-code, trt-ver, cuda-ver compiler\n options

    \n
    • \n
  • \n

    \n MALI: ARM Mali graphics processor

    \n
    • \n
  • \n

    \n INTEL_GRAPHICS: Integrated Intel graphics

    \n
    • \n
" } } }, @@ -50627,7 +51029,7 @@ "Type": { "target": "com.amazonaws.sagemaker#TrafficRoutingConfigType", "traits": { - "smithy.api#documentation": "

Traffic routing strategy type.

\n
    \n
  • \n

    \n ALL_AT_ONCE: Endpoint traffic shifts to the new fleet\n in a single step.\n

    \n
    • \n
  • \n

    \n CANARY: Endpoint traffic shifts to the new fleet\n in two steps. The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.\n

    \n
    • \n
  • \n

    \n LINEAR: Endpoint traffic shifts to the new fleet in\n n steps of a configurable size.\n

    \n
    • \n
", + "smithy.api#documentation": "

Traffic routing strategy type.

\n
    \n
  • \n

    \n ALL_AT_ONCE: Endpoint traffic shifts to the new fleet\n in a single step.\n

    \n
    • \n
  • \n

    \n CANARY: Endpoint traffic shifts to the new fleet\n in two steps. The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.\n

    \n
    • \n
  • \n

    \n LINEAR: Endpoint traffic shifts to the new fleet in\n n steps of a configurable size.\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -50791,7 +51193,7 @@ } }, "traits": { - "smithy.api#documentation": "

The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.

\n\n

\n Pipe mode\n

\n

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.

\n\n

\n File mode\n

\n

If an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.

\n

You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.

\n

For distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.

\n\n

\n FastFile mode\n

\n

If an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.

\n

\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.

" + "smithy.api#documentation": "

The training input mode that the algorithm supports. For more information about input\n modes, see Algorithms.

\n

\n Pipe mode\n

\n

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from\n Amazon S3 to the container.

\n

\n File mode\n

\n

If an algorithm supports File mode, SageMaker downloads the training data from\n S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume\n for the training container.

\n

You must provision the ML storage volume with sufficient capacity to accommodate the\n data downloaded from S3. In addition to the training data, the ML storage volume also\n stores the output model. The algorithm container uses the ML storage volume to also\n store intermediate information, if any.

\n

For distributed algorithms, training data is distributed uniformly. Your training\n duration is predictable if the input data objects sizes are approximately the same. SageMaker\n does not split the files any further for model training. If the object sizes are skewed,\n training won't be optimal as the data distribution is also skewed when one host in a\n training cluster is overloaded, thus becoming a bottleneck in training.

\n

\n FastFile mode\n

\n

If an algorithm supports FastFile mode, SageMaker streams data directly from\n S3 to the container with no code changes, and provides file system access to the data.\n Users can author their training script to interact with these files as if they were\n stored on disk.

\n

\n FastFile mode works best when the data is read sequentially. Augmented\n manifest files aren't supported. The startup time is lower when there are fewer files in\n the S3 bucket provided.

" } }, "com.amazonaws.sagemaker#TrainingInstanceCount": { @@ -51150,13 +51552,13 @@ "TrainingJobStatus": { "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "

The status of the\n training\n job.

\n

Training job statuses are:

\n
    \n
  • \n

    \n InProgress - The training is in progress.

    \n
    • \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
  • \n

    \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

    \n
    • \n
  • \n

    \n Stopping - The training job is stopping.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n

For\n more detailed information, see SecondaryStatus.

" + "smithy.api#documentation": "

The status of the\n training\n job.

\n

Training job statuses are:

\n
    \n
  • \n

    \n InProgress - The training is in progress.

    \n
    • \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
  • \n

    \n Failed - The training job has failed. To see the reason for the\n failure, see the FailureReason field in the response to a\n DescribeTrainingJobResponse call.

    \n
    • \n
  • \n

    \n Stopping - The training job is stopping.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n

For\n more detailed information, see SecondaryStatus.

" } }, "SecondaryStatus": { "target": "com.amazonaws.sagemaker#SecondaryStatus", "traits": { - "smithy.api#documentation": "

Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.

\n

SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n \n

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTrainingStack\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
" + "smithy.api#documentation": "

Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.

\n

SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

    \n
    • \n
\n
\n
\n \n

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

\n
    \n
  • \n

    \n LaunchingMLInstances\n

    \n
    • \n
  • \n

    \n PreparingTrainingStack\n

    \n
    • \n
  • \n

    \n DownloadingTrainingImage\n

    \n
    • \n
" } }, "FailureReason": { @@ -51210,7 +51612,7 @@ "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

" + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

" } }, "CreationTime": { @@ -51378,7 +51780,7 @@ "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.

", + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.

", "smithy.api#required": {} } } @@ -51747,7 +52149,7 @@ "SplitType": { "target": "com.amazonaws.sagemaker#SplitType", "traits": { - "smithy.api#documentation": "

The method to use to split the transform job's data files into smaller batches.\n Splitting is necessary when the total size of each object is too large to fit in a\n single request. You can also use data splitting to improve performance by processing\n multiple concurrent mini-batches. The default value for SplitType is\n None, which indicates that input data files are not split, and request\n payloads contain the entire contents of an input object. Set the value of this parameter\n to Line to split records on a newline character boundary.\n SplitType also supports a number of record-oriented binary data\n formats. Currently, the supported record formats are:

\n
    \n
  • \n

    RecordIO

    \n
    • \n
  • \n

    TFRecord

    \n
    • \n
\n

When splitting is enabled, the size of a mini-batch depends on the values of the\n BatchStrategy and MaxPayloadInMB parameters. When the\n value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum\n number of records in each request, up to the MaxPayloadInMB limit. If the\n value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual\n records in each request.

\n \n

Some data formats represent a record as a binary payload wrapped with extra\n padding bytes. When splitting is applied to a binary data format, padding is removed\n if the value of BatchStrategy is set to SingleRecord.\n Padding is not removed if the value of BatchStrategy is set to\n MultiRecord.

\n

For more information about RecordIO, see Create a Dataset Using\n RecordIO in the MXNet documentation. For more information about\n TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

\n " + "smithy.api#documentation": "

The method to use to split the transform job's data files into smaller batches.\n Splitting is necessary when the total size of each object is too large to fit in a\n single request. You can also use data splitting to improve performance by processing\n multiple concurrent mini-batches. The default value for SplitType is\n None, which indicates that input data files are not split, and request\n payloads contain the entire contents of an input object. Set the value of this parameter\n to Line to split records on a newline character boundary.\n SplitType also supports a number of record-oriented binary data\n formats. Currently, the supported record formats are:

\n
    \n
  • \n

    RecordIO

    \n
    • \n
  • \n

    TFRecord

    \n
    • \n
\n

When splitting is enabled, the size of a mini-batch depends on the values of the\n BatchStrategy and MaxPayloadInMB parameters. When the\n value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum\n number of records in each request, up to the MaxPayloadInMB limit. If the\n value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual\n records in each request.

\n \n

Some data formats represent a record as a binary payload wrapped with extra\n padding bytes. When splitting is applied to a binary data format, padding is removed\n if the value of BatchStrategy is set to SingleRecord.\n Padding is not removed if the value of BatchStrategy is set to\n MultiRecord.

\n

For more information about RecordIO, see Create a Dataset Using\n RecordIO in the MXNet documentation. For more information about\n TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

\n " } } }, @@ -52115,7 +52517,7 @@ "BatchStrategy": { "target": "com.amazonaws.sagemaker#BatchStrategy", "traits": { - "smithy.api#documentation": "

A string that determines the number of records included in a single mini-batch.

\n

\n SingleRecord means only one record is used per mini-batch.\n MultiRecord means a mini-batch is set to contain as many records that\n can fit within the MaxPayloadInMB limit.

" + "smithy.api#documentation": "

A string that determines the number of records included in a single mini-batch.

\n

\n SingleRecord means only one record is used per mini-batch.\n MultiRecord means a mini-batch is set to contain as many records that\n can fit within the MaxPayloadInMB limit.

" } }, "Environment": { @@ -52275,7 +52677,7 @@ "S3OutputPath": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For\n example, s3://bucket-name/key-name-prefix.

\n

For every S3 object used as input for the transform job, batch transform stores the\n transformed data with an .out suffix in a corresponding subfolder in the\n location in the output prefix. For example, for the input data stored at\n s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform\n stores the transformed data at\n s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out.\n Batch transform doesn't upload partially processed objects. For an input S3 object that\n contains multiple records, it creates an .out file only if the transform\n job succeeds on the entire file. When the input contains multiple S3 objects, the batch\n transform job processes the listed S3 objects and uploads only the output for\n successfully processed objects. If any object fails in the transform job batch transform\n marks the job as failed to prompt investigation.

", + "smithy.api#documentation": "

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For\n example, s3://bucket-name/key-name-prefix.

\n

For every S3 object used as input for the transform job, batch transform stores the\n transformed data with an .out suffix in a corresponding subfolder in the\n location in the output prefix. For example, for the input data stored at\n s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform\n stores the transformed data at\n s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out.\n Batch transform doesn't upload partially processed objects. For an input S3 object that\n contains multiple records, it creates an .out file only if the transform\n job succeeds on the entire file. When the input contains multiple S3 objects, the batch\n transform job processes the listed S3 objects and uploads only the output for\n successfully processed objects. If any object fails in the transform job batch transform\n marks the job as failed to prompt investigation.

", "smithy.api#required": {} } }, @@ -52294,7 +52696,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n \n \n

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n\tCreateModel\n\t\trequest. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n\tCreateModel\n\t\trequest. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" } } }, @@ -52322,7 +52724,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume\n attached to the ML compute instance(s) that run the batch transform job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

\n The VolumeKmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume\n attached to the ML compute instance(s) that run the batch transform job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

\n The VolumeKmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
" } } }, @@ -52336,14 +52738,14 @@ "S3DataType": { "target": "com.amazonaws.sagemaker#S3DataType", "traits": { - "smithy.api#documentation": "

If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

\n

If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch\n transform.

\n

The following values are compatible: ManifestFile,\n S3Prefix\n

\n

The following value is not compatible: AugmentedManifestFile\n

", + "smithy.api#documentation": "

If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

\n

If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch\n transform.

\n

The following values are compatible: ManifestFile,\n S3Prefix\n

\n

The following value is not compatible: AugmentedManifestFile\n

", "smithy.api#required": {} } }, "S3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest. For example:

\n
    \n
  • \n

    A key name prefix might look like this:\n s3://bucketname/exampleprefix.

    \n
    • \n
  • \n

    A manifest might look like this:\n s3://bucketname/example.manifest\n

    \n

    The manifest is an S3 object which is a JSON file with the following format:

    \n

    \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

    \n

    \n \"relative/path/to/custdata-1\",\n

    \n

    \n \"relative/path/custdata-2\",\n

    \n

    \n ...\n

    \n

    \n \"relative/path/custdata-N\"\n

    \n

    \n ]\n

    \n

    The preceding JSON matches the following S3Uris:

    \n

    \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

    \n

    \n ...\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

    \n

    The complete set of S3Uris in this manifest constitutes the\n input data for the channel for this datasource. The object that each\n S3Uris points to must be readable by the IAM role that Amazon SageMaker\n uses to perform tasks on your behalf.

    \n
    • \n
", + "smithy.api#documentation": "

Depending on the value specified for the S3DataType, identifies either a\n key name prefix or a manifest. For example:

\n
    \n
  • \n

    A key name prefix might look like this:\n s3://bucketname/exampleprefix.

    \n
    • \n
  • \n

    A manifest might look like this:\n s3://bucketname/example.manifest\n

    \n

    The manifest is an S3 object which is a JSON file with the following format:

    \n

    \n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n

    \n

    \n \"relative/path/to/custdata-1\",\n

    \n

    \n \"relative/path/custdata-2\",\n

    \n

    \n ...\n

    \n

    \n \"relative/path/custdata-N\"\n

    \n

    \n ]\n

    \n

    The preceding JSON matches the following S3Uris:

    \n

    \n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-2\n

    \n

    \n ...\n

    \n

    \n s3://customer_bucket/some/prefix/relative/path/custdata-N\n

    \n

    The complete set of S3Uris in this manifest constitutes the\n input data for the channel for this datasource. The object that each\n S3Uris points to must be readable by the IAM role that Amazon SageMaker\n uses to perform tasks on your behalf.

    \n
    • \n
", "smithy.api#required": {} } } @@ -53134,12 +53536,12 @@ "HumanTaskUiArn": { "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { - "smithy.api#documentation": "

The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

\n

Use this parameter when you are creating a labeling job for named entity recognition,\n 3D point cloud and video frame labeling jobs. Use your labeling job task type to select\n one of the following ARNs and use it with this parameter when you create a labeling job.\n Replace aws-region with the Amazon Web Services Region you are creating your labeling job\n in. For example, replace aws-region with us-west-1 if you\n create a labeling job in US West (N. California).

\n

\n Named Entity Recognition\n

\n

Use the following HumanTaskUiArn for named entity recognition labeling\n jobs:

\n

\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition\n

\n \n

\n 3D Point Cloud HumanTaskUiArns\n

\n \n

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n

    \n
    • \n
\n \n

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n

    \n
    • \n
\n \n

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n

    \n
    • \n
\n \n

\n Video Frame HumanTaskUiArns\n

\n \n

Use this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n

    \n
    • \n
\n \n

Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n

    \n
    • \n
" + "smithy.api#documentation": "

The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

\n

Use this parameter when you are creating a labeling job for named entity recognition,\n 3D point cloud and video frame labeling jobs. Use your labeling job task type to select\n one of the following ARNs and use it with this parameter when you create a labeling job.\n Replace aws-region with the Amazon Web Services Region you are creating your labeling job\n in. For example, replace aws-region with us-west-1 if you\n create a labeling job in US West (N. California).

\n

\n Named Entity Recognition\n

\n

Use the following HumanTaskUiArn for named entity recognition labeling\n jobs:

\n

\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition\n

\n

\n 3D Point Cloud HumanTaskUiArns\n

\n

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n

    \n
    • \n
\n

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n

    \n
    • \n
\n

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n

    \n
    • \n
\n

\n Video Frame HumanTaskUiArns\n

\n

Use this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n

    \n
    • \n
\n

Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n

    \n
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

Provided configuration information for the worker UI for a labeling job. Provide\n either HumanTaskUiArn or UiTemplateS3Uri.

\n

For named entity recognition, 3D point cloud and video frame labeling jobs, use\n HumanTaskUiArn.

\n

For all other Ground Truth built-in task types and custom task types, use\n UiTemplateS3Uri to specify the location of a worker task template in\n Amazon S3.

" + "smithy.api#documentation": "

Provided configuration information for the worker UI for a labeling job. Provide\n either HumanTaskUiArn or UiTemplateS3Uri.

\n

For named entity recognition, 3D point cloud and video frame labeling jobs, use\n HumanTaskUiArn.

\n

For all other Ground Truth built-in task types and custom task types, use\n UiTemplateS3Uri to specify the location of a worker task template in\n Amazon S3.

" } }, "com.amazonaws.sagemaker#UiTemplate": { @@ -53376,7 +53778,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfigForUpdate", "traits": { - "smithy.api#documentation": "

The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" } } } @@ -53617,7 +54019,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deploys the new EndpointConfig specified in the request, switches to\n using newly created endpoint, and then deletes resources provisioned for the endpoint\n using the previous EndpointConfig (there is no availability loss).

\n

When SageMaker receives the request, it sets the endpoint status to\n Updating. After updating the endpoint, it sets the status to\n InService. To check the status of an endpoint, use the DescribeEndpoint API.\n \n

\n \n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n

If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.

\n " + "smithy.api#documentation": "

Deploys the new EndpointConfig specified in the request, switches to\n using newly created endpoint, and then deletes resources provisioned for the endpoint\n using the previous EndpointConfig (there is no availability loss).

\n

When SageMaker receives the request, it sets the endpoint status to\n Updating. After updating the endpoint, it sets the status to\n InService. To check the status of an endpoint, use the DescribeEndpoint API.\n \n

\n \n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n

If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.

\n " } }, "com.amazonaws.sagemaker#UpdateEndpointInput": { @@ -53991,7 +54393,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The new Amazon Resource Name (ARN) for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

" + "smithy.api#documentation": "

The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

" } } } @@ -54002,7 +54404,117 @@ "ImageArn": { "target": "com.amazonaws.sagemaker#ImageArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the image.

" + "smithy.api#documentation": "

The ARN of the image.

" + } + } + } + }, + "com.amazonaws.sagemaker#UpdateImageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateImageVersionRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateImageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceInUse" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the properties of a SageMaker image version.

" + } + }, + "com.amazonaws.sagemaker#UpdateImageVersionRequest": { + "type": "structure", + "members": { + "ImageName": { + "target": "com.amazonaws.sagemaker#ImageName", + "traits": { + "smithy.api#documentation": "

The name of the image.

", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAlias", + "traits": { + "smithy.api#documentation": "

The alias of the image version.

" + } + }, + "Version": { + "target": "com.amazonaws.sagemaker#ImageVersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the image.

" + } + }, + "AliasesToAdd": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "

A list of aliases to add.

" + } + }, + "AliasesToDelete": { + "target": "com.amazonaws.sagemaker#SageMakerImageVersionAliases", + "traits": { + "smithy.api#documentation": "

A list of aliases to delete.

" + } + }, + "VendorGuidance": { + "target": "com.amazonaws.sagemaker#VendorGuidance", + "traits": { + "smithy.api#documentation": "

The availability of the image version specified by the maintainer.

\n
    \n
  • \n

    \n NOT_PROVIDED: The maintainers did not provide a status for image version stability.

    \n
    • \n
  • \n

    \n STABLE: The image version is stable.

    \n
    • \n
  • \n

    \n TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.

    \n
    • \n
  • \n

    \n ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

    \n
    • \n
" + } + }, + "JobType": { + "target": "com.amazonaws.sagemaker#JobType", + "traits": { + "smithy.api#documentation": "

Indicates SageMaker job type compatibility.

\n
    \n
  • \n

    \n TRAINING: The image version is compatible with SageMaker training jobs.

    \n
    • \n
  • \n

    \n INFERENCE: The image version is compatible with SageMaker inference jobs.

    \n
    • \n
  • \n

    \n NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

    \n
    • \n
" + } + }, + "MLFramework": { + "target": "com.amazonaws.sagemaker#MLFramework", + "traits": { + "smithy.api#documentation": "

The machine learning framework vended in the image version.

" + } + }, + "ProgrammingLang": { + "target": "com.amazonaws.sagemaker#ProgrammingLang", + "traits": { + "smithy.api#documentation": "

The supported programming language and its version.

" + } + }, + "Processor": { + "target": "com.amazonaws.sagemaker#Processor", + "traits": { + "smithy.api#documentation": "

Indicates CPU or GPU compatibility.

\n
    \n
  • \n

    \n CPU: The image version is compatible with CPU.

    \n
    • \n
  • \n

    \n GPU: The image version is compatible with GPU.

    \n
    • \n
" + } + }, + "Horovod": { + "target": "com.amazonaws.sagemaker#Horovod", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates Horovod compatibility.

" + } + }, + "ReleaseNotes": { + "target": "com.amazonaws.sagemaker#ReleaseNotes", + "traits": { + "smithy.api#documentation": "

The maintainer description of the image version.

" + } + } + } + }, + "com.amazonaws.sagemaker#UpdateImageVersionResponse": { + "type": "structure", + "members": { + "ImageVersionArn": { + "target": "com.amazonaws.sagemaker#ImageVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the image version.

" } } } @@ -54052,19 +54564,19 @@ "ModelVariants": { "target": "com.amazonaws.sagemaker#ModelVariantConfigList", "traits": { - "smithy.api#documentation": "

\n Array of ModelVariantConfigSummary objects. There is one for each variant, whose infrastructure\n configuration you want to update.\n

" + "smithy.api#documentation": "

\n An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure\n configuration you want to update.\n

" } }, "DataStorageConfig": { "target": "com.amazonaws.sagemaker#InferenceExperimentDataStorageConfig", "traits": { - "smithy.api#documentation": "

The Amazon S3 storage configuration for the inference experiment.

" + "smithy.api#documentation": "

The Amazon S3 location and configuration for storing inference request and response data.

" } }, "ShadowModeConfig": { "target": "com.amazonaws.sagemaker#ShadowModeConfig", "traits": { - "smithy.api#documentation": "

The Amazon S3 storage configuration for the inference experiment.

" + "smithy.api#documentation": "

\n The configuration of ShadowMode inference experiment type. Use this field to specify a\n production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a\n percentage of the inference requests. For the shadow variant also specify the percentage of requests that\n Amazon SageMaker replicates.\n

" } } } @@ -54364,7 +54876,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the\n notebook instance. For more information, see SageMaker Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the\n notebook instance. For more information, see SageMaker Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n " } }, "LifecycleConfigName": { @@ -54428,7 +54940,7 @@ "RootAccess": { "target": "com.amazonaws.sagemaker#RootAccess", "traits": { - "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

\n \n

If you set this to Disabled, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.

\n " + "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

\n \n

If you set this to Disabled, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.

\n " } }, "InstanceMetadataServiceConfiguration": { @@ -54631,7 +55143,7 @@ "target": "com.amazonaws.sagemaker#UpdateProjectOutput" }, "traits": { - "smithy.api#documentation": "

Updates a machine learning (ML) project that is created from a template that \n sets up an ML pipeline from training to deploying an approved model.

\n \n

You must not update a project that is in use. If you update the\n ServiceCatalogProvisioningUpdateDetails of a project that is active\n or being created, or updated, you may lose resources already created by the\n project.

\n " + "smithy.api#documentation": "

Updates a machine learning (ML) project that is created from a template that \n sets up an ML pipeline from training to deploying an approved model.

\n \n

You must not update a project that is in use. If you update the\n ServiceCatalogProvisioningUpdateDetails of a project that is active\n or being created, or updated, you may lose resources already created by the\n project.

\n " } }, "com.amazonaws.sagemaker#UpdateProjectInput": { @@ -55019,7 +55531,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this operation to update your workforce. You can use this operation to \n require that workers use specific IP addresses to work on tasks\n and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

\n

The worker portal is now supported in VPC and public internet.

\n\n \n

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. \n You specify allowed IP addresses by creating a list of up to ten CIDRs.\n By default, a workforce isn't restricted to specific IP addresses. If you specify a\n range of IP addresses, workers who attempt to access tasks using any IP address outside\n the specified range are denied and get a Not Found error message on\n the worker portal.

\n

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"0.0.0.0/0\".

\n \n

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

\n \n

Use OidcConfig to update the configuration of a workforce created using\n your own OIDC IdP.

\n \n

You can only update your OIDC IdP configuration when there are no work teams\n associated with your workforce. You can delete work teams using the operation.

\n \n

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you\n can view details about your update workforce using the \n operation.

\n \n

This operation only applies to private workforces.

\n " + "smithy.api#documentation": "

Use this operation to update your workforce. You can use this operation to \n require that workers use specific IP addresses to work on tasks\n and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

\n

The worker portal is now supported in VPC and public internet.

\n

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. \n You specify allowed IP addresses by creating a list of up to ten CIDRs.\n By default, a workforce isn't restricted to specific IP addresses. If you specify a\n range of IP addresses, workers who attempt to access tasks using any IP address outside\n the specified range are denied and get a Not Found error message on\n the worker portal.

\n

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"0.0.0.0/0\".

\n \n

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

\n \n

Use OidcConfig to update the configuration of a workforce created using\n your own OIDC IdP.

\n \n

You can only update your OIDC IdP configuration when there are no work teams\n associated with your workforce. You can delete work teams using the operation.

\n \n

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you\n can view details about your update workforce using the \n operation.

\n \n

This operation only applies to private workforces.

\n " } }, "com.amazonaws.sagemaker#UpdateWorkforceRequest": { @@ -55035,7 +55547,7 @@ "SourceIpConfig": { "target": "com.amazonaws.sagemaker#SourceIpConfig", "traits": { - "smithy.api#documentation": "

A list of one to ten worker IP address ranges (CIDRs) that can be used to\n access tasks assigned to this workforce.

\n

Maximum: Ten CIDR values

" + "smithy.api#documentation": "

A list of one to ten worker IP address ranges (CIDRs) that can be used to\n access tasks assigned to this workforce.

\n

Maximum: Ten CIDR values

" } }, "OidcConfig": { @@ -55094,7 +55606,7 @@ "MemberDefinitions": { "target": "com.amazonaws.sagemaker#MemberDefinitions", "traits": { - "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition. You should not provide input\n for both of these parameters in a single request.

\n

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.

\n

For workforces created using your own OIDC IdP, specify the user groups that you want\n to include in your private work team in OidcMemberDefinition by listing\n those groups in Groups. Be aware that user groups that are already in the\n work team must also be listed in Groups when you make this request to\n remain on the work team. If you do not include these user groups, they will no longer be\n associated with the work team you update.

" + "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition. You should not provide input\n for both of these parameters in a single request.

\n

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito\n user groups within the user pool used to create a workforce. All of the\n CognitoMemberDefinition objects that make up the member definition must\n have the same ClientId and UserPool values. To add a Amazon\n Cognito user group to an existing worker pool, see Adding groups to a User\n Pool. For more information about user pools, see Amazon Cognito User\n Pools.

\n

For workforces created using your own OIDC IdP, specify the user groups that you want\n to include in your private work team in OidcMemberDefinition by listing\n those groups in Groups. Be aware that user groups that are already in the\n work team must also be listed in Groups when you make this request to\n remain on the work team. If you do not include these user groups, they will no longer be\n associated with the work team you update.

" } }, "Description": { @@ -55374,13 +55886,13 @@ "VariantPropertyType": { "target": "com.amazonaws.sagemaker#VariantPropertyType", "traits": { - "smithy.api#documentation": "

The type of variant property. The supported values are:

\n ", + "smithy.api#documentation": "

The type of variant property. The supported values are:

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies a production variant property type for an Endpoint.

\n

If you are updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties option set to\n true, the VariantProperty objects listed in UpdateEndpointInput$ExcludeRetainedVariantProperties override the\n existing variant properties of the endpoint.

" + "smithy.api#documentation": "

Specifies a production variant property type for an Endpoint.

\n

If you are updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties option set to\n true, the VariantProperty objects listed in UpdateEndpointInput$ExcludeRetainedVariantProperties override the\n existing variant properties of the endpoint.

" } }, "com.amazonaws.sagemaker#VariantPropertyList": { @@ -55470,6 +55982,35 @@ } } }, + "com.amazonaws.sagemaker#VendorGuidance": { + "type": "enum", + "members": { + "NOT_PROVIDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_PROVIDED" + } + }, + "STABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STABLE" + } + }, + "TO_BE_ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_BE_ARCHIVED" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + } + } + }, "com.amazonaws.sagemaker#VersionId": { "type": "string", "traits": { @@ -55619,14 +56160,14 @@ "Status": { "target": "com.amazonaws.sagemaker#WarmPoolResourceStatus", "traits": { - "smithy.api#documentation": "

The status of the warm pool.

\n
    \n
  • \n

    \n InUse: The warm pool is in use for the training job.

    \n
    • \n
  • \n

    \n Available: The warm pool is available to reuse for a matching\n training job.

    \n
    • \n
  • \n

    \n Reused: The warm pool moved to a matching training job for\n reuse.

    \n
    • \n
  • \n

    \n Terminated: The warm pool is no longer available. Warm pools are\n unavailable if they are terminated by a user, terminated for a patch update, or\n terminated for exceeding the specified\n KeepAlivePeriodInSeconds.

    \n
    • \n
", + "smithy.api#documentation": "

The status of the warm pool.

\n
    \n
  • \n

    \n InUse: The warm pool is in use for the training job.

    \n
    • \n
  • \n

    \n Available: The warm pool is available to reuse for a matching\n training job.

    \n
    • \n
  • \n

    \n Reused: The warm pool moved to a matching training job for\n reuse.

    \n
    • \n
  • \n

    \n Terminated: The warm pool is no longer available. Warm pools are\n unavailable if they are terminated by a user, terminated for a patch update, or\n terminated for exceeding the specified\n KeepAlivePeriodInSeconds.

    \n
    • \n
", "smithy.api#required": {} } }, "ResourceRetainedBillableTimeInSeconds": { "target": "com.amazonaws.sagemaker#ResourceRetainedBillableTimeInSeconds", "traits": { - "smithy.api#documentation": "

The billable time in seconds used by the warm pool. Billable time refers to the\n absolute wall-clock time.

\n

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run warm pool training. The formula is as follows:\n ResourceRetainedBillableTimeInSeconds * InstanceCount.

" + "smithy.api#documentation": "

The billable time in seconds used by the warm pool. Billable time refers to the\n absolute wall-clock time.

\n

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run warm pool training. The formula is as follows:\n ResourceRetainedBillableTimeInSeconds * InstanceCount.

" } }, "ReusedByJob": { @@ -55925,7 +56466,7 @@ "MemberDefinitions": { "target": "com.amazonaws.sagemaker#MemberDefinitions", "traits": { - "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition.

", + "smithy.api#documentation": "

A list of MemberDefinition objects that contains objects that identify\n the workers that make up the work team.

\n

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). \n For private workforces created using Amazon Cognito use\n CognitoMemberDefinition. For workforces created using your own OIDC identity\n provider (IdP) use OidcMemberDefinition.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/scheduler.2021-06-30.json b/codegen/sdk-codegen/aws-models/scheduler.2021-06-30.json index 2f29ee581ed..05fe101abfd 100644 --- a/codegen/sdk-codegen/aws-models/scheduler.2021-06-30.json +++ b/codegen/sdk-codegen/aws-models/scheduler.2021-06-30.json @@ -3029,4 +3029,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json index 030e87762d4..4b9dfa43f49 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json +++ b/codegen/sdk-codegen/aws-models/securityhub.2018-10-26.json @@ -1248,7 +1248,7 @@ "SpotAllocationStrategy": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

How to allocate instances across Spot Instance pools. Valid values are as follows:

\n\t
    \n
  • \n

    \n lowest-price\n

    \n
    • \n
  • \n

    \n capacity-optimized\n

    \n
    • \n
  • \n

    \n capacity-optimized-prioritized\n

    \n
    • \n
" + "smithy.api#documentation": "

How to allocate instances across Spot Instance pools. Valid values are as follows:

\n
    \n
  • \n

    \n lowest-price\n

    \n
    • \n
  • \n

    \n capacity-optimized\n

    \n
    • \n
  • \n

    \n capacity-optimized-prioritized\n

    \n
    • \n
" } }, "SpotInstancePools": { @@ -1414,7 +1414,7 @@ "VolumeType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The volume type. Valid values are as follows:

\n \t
    \n
  • \n

    \n gp2\n

    \n
    • \n
  • \n

    \n gp3\n

    \n
    • \n
  • \n

    \n io1\n

    \n
    • \n
  • \n

    \n sc1\n

    \n
    • \n
  • \n

    \n st1\n

    \n
    • \n
  • \n

    \n standard\n

    \n
    • \n
" + "smithy.api#documentation": "

The volume type. Valid values are as follows:

\n
    \n
  • \n

    \n gp2\n

    \n
    • \n
  • \n

    \n gp3\n

    \n
    • \n
  • \n

    \n io1\n

    \n
    • \n
  • \n

    \n sc1\n

    \n
    • \n
  • \n

    \n st1\n

    \n
    • \n
  • \n

    \n standard\n

    \n
    • \n
" } } }, @@ -3787,7 +3787,7 @@ "TableStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The current status of the table. Valid values are as follows:

\n\t\t
    \n
  • \n

    \n ACTIVE\n

    \n
    • \n
  • \n

    \n ARCHIVED\n

    \n
    • \n
  • \n

    \n ARCHIVING\n

    \n
    • \n
  • \n

    \n CREATING\n

    \n
    • \n
  • \n

    \n DELETING\n

    \n
    • \n
  • \n

    \n INACCESSIBLE_ENCRYPTION_CREDENTIALS\n

    \n
    • \n
  • \n

    \n UPDATING\n

    \n
    • \n
" + "smithy.api#documentation": "

The current status of the table. Valid values are as follows:

\n
    \n
  • \n

    \n ACTIVE\n

    \n
    • \n
  • \n

    \n ARCHIVED\n

    \n
    • \n
  • \n

    \n ARCHIVING\n

    \n
    • \n
  • \n

    \n CREATING\n

    \n
    • \n
  • \n

    \n DELETING\n

    \n
    • \n
  • \n

    \n INACCESSIBLE_ENCRYPTION_CREDENTIALS\n

    \n
    • \n
  • \n

    \n UPDATING\n

    \n
    • \n
" } } }, @@ -3827,7 +3827,7 @@ "IndexStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The current status of the index.

\n \t
    \n
  • \n

    \n ACTIVE\n

    \n
    • \n
  • \n

    \n CREATING\n

    \n
    • \n
  • \n

    \n DELETING\n

    \n
    • \n
  • \n

    \n UPDATING\n

    \n
    • \n
" + "smithy.api#documentation": "

The current status of the index.

\n
    \n
  • \n

    \n ACTIVE\n

    \n
    • \n
  • \n

    \n CREATING\n

    \n
    • \n
  • \n

    \n DELETING\n

    \n
    • \n
  • \n

    \n UPDATING\n

    \n
    • \n
" } }, "ItemCount": { @@ -3942,7 +3942,7 @@ "ProjectionType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The types of attributes that are projected into the index. Valid values are as follows:

\n \t
    \n
  • \n

    \n ALL\n

    \n
    • \n
  • \n

    \n INCLUDE\n

    \n
    • \n
  • \n

    \n KEYS_ONLY\n

    \n
    • \n
" + "smithy.api#documentation": "

The types of attributes that are projected into the index. Valid values are as follows:

\n
    \n
  • \n

    \n ALL\n

    \n
    • \n
  • \n

    \n INCLUDE\n

    \n
    • \n
  • \n

    \n KEYS_ONLY\n

    \n
    • \n
" } } }, @@ -4036,7 +4036,7 @@ "ReplicaStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The current status of the replica. Valid values are as follows:

\n \t
    \n
  • \n

    \n ACTIVE\n

    \n
    • \n
  • \n

    \n CREATING\n

    \n
    • \n
  • \n

    \n CREATION_FAILED\n

    \n
    • \n
  • \n

    \n DELETING\n

    \n
    • \n
  • \n

    \n UPDATING\n

    \n
    • \n
" + "smithy.api#documentation": "

The current status of the replica. Valid values are as follows:

\n
    \n
  • \n

    \n ACTIVE\n

    \n
    • \n
  • \n

    \n CREATING\n

    \n
    • \n
  • \n

    \n CREATION_FAILED\n

    \n
    • \n
  • \n

    \n DELETING\n

    \n
    • \n
  • \n

    \n UPDATING\n

    \n
    • \n
" } }, "ReplicaStatusDescription": { @@ -4375,6 +4375,1278 @@ "target": "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesDetails" } }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The device name.\n

" + } + }, + "Ebs": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails", + "traits": { + "smithy.api#documentation": "

\n Parameters used to automatically set up Amazon EBS volumes when the instance is \n launched.\n

" + } + }, + "NoDevice": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Omits the device from the block device mapping when an empty string is specified.\n

" + } + }, + "VirtualName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The virtual device name (ephemeralN). Instance store volumes are numbered starting \n from 0. An instance type with 2 available instance store volumes can specify mappings \n for ephemeral0 and ephemeral1. The number of available instance store volumes depends \n on the instance type.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about a block device mapping for an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails": { + "type": "structure", + "members": { + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the EBS volume is deleted on instance termination.\n

" + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the EBS volume is encrypted. Encrypted volumes can only be \n attached to instances that support Amazon EBS encryption. If you're creating a \n volume from a snapshot, you can't specify an encryption value.\n

" + } + }, + "Iops": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of I/O operations per second (IOPS). \n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS) customer managed key \n used for encryption.\n

" + } + }, + "SnapshotId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the EBS snapshot.\n

" + } + }, + "Throughput": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.\n

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. \n

" + } + }, + "VolumeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The volume type.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Parameters for a block device for an Amazon Elastic Block Store (Amazon EBS) volume in an Amazon EC2 launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the Capacity Reservation in which to run the instance.\n

" + } + }, + "CapacityReservationResourceGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about the target Capacity Reservation or Capacity Reservation group in which to run an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails": { + "type": "structure", + "members": { + "CapacityReservationPreference": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates the instance's Capacity Reservation preferences. If equal to open, the instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). If equal to none, the instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.\n \n

" + } + }, + "CapacityReservationTarget": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies a target Capacity Reservation.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the Capacity Reservation targeting option of an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCpuOptionsDetails": { + "type": "structure", + "members": { + "CoreCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of CPU cores for the instance.\n

" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of threads per CPU core. A value of 1 disables multithreading for the instance, \n The default value is 2.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the CPU options for an Amazon EC2 instance. For more information, see \n Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCreditSpecificationDetails": { + "type": "structure", + "members": { + "CpuCredits": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The credit option for CPU usage of a T instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the credit option for CPU usage of a T2, T3, or T3a Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataDetails": { + "type": "structure", + "members": { + "BlockDeviceMappingSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataBlockDeviceMappingSetList", + "traits": { + "smithy.api#documentation": "

\n Information about a block device mapping for an Amazon EC2 launch template.\n

" + } + }, + "CapacityReservationSpecification": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies an instance's Capacity Reservation targeting option. You can specify only \n one option at a time.\n

" + } + }, + "CpuOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCpuOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the CPU options for an instance. For more information, see \n Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.\n

" + } + }, + "CreditSpecification": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataCreditSpecificationDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the credit option for CPU usage of a T2, T3, or T3a instance.\n

" + } + }, + "DisableApiStop": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether to enable the instance for stop protection. For more information, \n see Enable stop protection in the Amazon EC2 User Guide.\n

" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set to true, you can. \n

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the instance is optimized for Amazon EBS I/O. \n

" + } + }, + "ElasticGpuSpecificationSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetList", + "traits": { + "smithy.api#documentation": "

\n Provides details about Elastic Graphics accelerators to associate with the instance.\n

" + } + }, + "ElasticInferenceAcceleratorSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetList", + "traits": { + "smithy.api#documentation": "

\n The Amazon Elastic Inference accelerator for the instance.\n

" + } + }, + "EnclaveOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataEnclaveOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.\n

" + } + }, + "HibernationOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataHibernationOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies whether your Amazon EC2 instance is configured for hibernation. \n

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataIamInstanceProfileDetails", + "traits": { + "smithy.api#documentation": "

\n The name or Amazon Resource Name (ARN) of an IAM instance profile.\n

" + } + }, + "ImageId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the Amazon Machine Image (AMI).\n

" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Provides the options for specifying the instance initiated shutdown behavior.\n

" + } + }, + "InstanceMarketOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the market (purchasing) option for an instance.\n

" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsDetails", + "traits": { + "smithy.api#documentation": "

\n The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance \n types with these attributes. If you specify InstanceRequirements, you can't specify InstanceType.\n

" + } + }, + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify InstanceType, you can't \n specify InstanceRequirements.\n

" + } + }, + "KernelId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the kernel.\n

" + } + }, + "KeyName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the key pair that allows users to connect to the instance.\n

" + } + }, + "LicenseSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetList", + "traits": { + "smithy.api#documentation": "

\n Specifies a license configuration for an instance.\n

" + } + }, + "MaintenanceOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMaintenanceOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n The maintenance options of your instance.\n

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMetadataOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.\n

" + } + }, + "Monitoring": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMonitoringDetails", + "traits": { + "smithy.api#documentation": "

\n The monitoring for the instance.\n

" + } + }, + "NetworkInterfaceSet": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetList", + "traits": { + "smithy.api#documentation": "

\n Specifies the parameters for a network interface that is attached to the instance.\n

" + } + }, + "Placement": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPlacementDetails", + "traits": { + "smithy.api#documentation": "

\n Specifies the placement of an instance.\n

" + } + }, + "PrivateDnsNameOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n The options for the instance hostname.\n

" + } + }, + "RamDiskId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the RAM disk.\n

" + } + }, + "SecurityGroupIdSet": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n One or more security group IDs.\n

" + } + }, + "SecurityGroupSet": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.\n

" + } + }, + "UserData": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The user data to make available to the instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The information to include in an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of Elastic Graphics accelerator. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about an Elastic Graphics specification for an Amazon EC2 launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of Elastic Inference accelerators to attach to the instance.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of Elastic Inference accelerator.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details for an Amazon Elastic Inference accelerator.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataEnclaveOptionsDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataHibernationOptionsDetails": { + "type": "structure", + "members": { + "Configured": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n If you set this parameter to true, the instance is enabled for hibernation.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies whether your Amazon EC2 instance is configured for hibernation.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataIamInstanceProfileDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the instance profile.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the instance profile.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details for an Identity and Access Management (IAM) instance profile, which is a container for an IAM role for your instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails": { + "type": "structure", + "members": { + "MarketType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The market type.\n

" + } + }, + "SpotOptions": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails", + "traits": { + "smithy.api#documentation": "

\n The options for Spot Instances.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the market (purchasing) option for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails": { + "type": "structure", + "members": { + "BlockDurationMinutes": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n Deprecated.\n

" + } + }, + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The behavior when a Spot Instance is interrupted.\n

" + } + }, + "MaxPrice": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The maximum hourly price you're willing to pay for the Spot Instances.\n

" + } + }, + "SpotInstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Spot Instance request type.\n

" + } + }, + "ValidUntil": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for persistent requests.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the market (purchasing) options for Spot Instances.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum number of accelerators. If this parameter isn't specified, there's no maximum limit. To exclude accelerator-enabled instance types, set Max to 0.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum number of accelerators. If this parameter isn't specified, there's no minimum limit.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum amount of memory, in MiB. If this parameter isn't specified, there's no maximum limit.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum amount of memory, in MiB. If 0 is specified, there's no maximum limit.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB, for the accelerators on an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's no maximum limit.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum baseline bandwidth, in Mbps. If this parameter is omitted, there's no minimum limit.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum baseline bandwidth to Amazon Elastic Block Store (Amazon EBS), in Mbps. For more information, \n see Amazon EBS–optimized instances in the Amazon EC2 User Guide.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsDetails": { + "type": "structure", + "members": { + "AcceleratorCount": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.\n

" + } + }, + "AcceleratorManufacturers": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific manufacturers.\n

" + } + }, + "AcceleratorNames": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The accelerators that must be on the instance type.\n

" + } + }, + "AcceleratorTotalMemoryMiB": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of total accelerator memory, in MiB.\n

" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The accelerator types that must be on the instance type.\n

" + } + }, + "BareMetal": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether bare metal instance types must be included, excluded, or required.\n

" + } + }, + "BaselineEbsBandwidthMbps": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.\n

" + } + }, + "BurstablePerformance": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.\n

" + } + }, + "CpuManufacturers": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The CPU manufacturers to include.\n

" + } + }, + "ExcludedInstanceTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The instance types to exclude.\n

" + } + }, + "InstanceGenerations": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n Indicates whether current or previous generation instance types are included.\n

" + } + }, + "LocalStorage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.\n

" + } + }, + "LocalStorageTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The type of local storage that is required.\n

" + } + }, + "MemoryGiBPerVCpu": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory per vCPU, in GiB.\n

" + } + }, + "MemoryMiB": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB.\n

" + } + }, + "NetworkInterfaceCount": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of network interfaces.\n

" + } + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

A high value, such as 999999, turns off price protection.

" + } + }, + "RequireHibernateSupport": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether instance types must support hibernation for On-Demand Instances.\n

" + } + }, + "SpotMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a \n percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When \n Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.\n

\n

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

\n

A high value, such as 999999, turns off price protection.

" + } + }, + "TotalLocalStorageGB": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of total local storage, in GB.\n

" + } + }, + "VCpuCount": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails", + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of vCPUs.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The attributes for the Amazon EC2 instance types.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory per vCPU, in GiB.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum amount of memory, in MiB.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum amount of memory, in MiB. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of memory, in MiB, for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum number of network interfaces. \n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum number of network interfaces.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of network interfaces to be attached to an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum amount of total local storage, in GB.\n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum amount of total local storage, in GB.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum amount of total local storage, in GB, that an Amazon EC2 instance uses.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails": { + "type": "structure", + "members": { + "Max": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The maximum number of vCPUs. \n

" + } + }, + "Min": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The minimum number of vCPUs.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The minimum and maximum number of vCPUs for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetDetails": { + "type": "structure", + "members": { + "LicenseConfigurationArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the license configuration.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the license configuration for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataLicenseSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMaintenanceOptionsDetails": { + "type": "structure", + "members": { + "AutoRecovery": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Disables the automatic recovery behavior of your instance or sets it to default.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The maintenance options of an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMetadataOptionsDetails": { + "type": "structure", + "members": { + "HttpEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled, and you won’t be able to access your instance metadata.\n

" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Enables or disables the IPv6 endpoint for the instance metadata service.\n

" + } + }, + "HttpTokens": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The state of token usage for your instance metadata requests.\n

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The desired HTTP PUT response hop limit for instance metadata requests. The larger \n the number, the further instance metadata requests can travel.\n

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n When set to enabled, this parameter allows access to instance tags from the instance metadata. When set to disabled, it turns off access to instance tags from the instance metadata. For more information, see \nWork with instance tags in instance metadata in the Amazon EC2 User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the metadata options for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataMonitoringDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Enables detailed monitoring when true is specified. Otherwise, basic monitoring is enabled. \n For more information about detailed monitoring, see \n Enable or turn off detailed monitoring for your instances in the Amazon EC2 User Guide. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The monitoring for an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails": { + "type": "structure", + "members": { + "AssociateCarrierIpAddress": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether to associate a Carrier IP address with eth0 for a new network interface. \n You use this option when you launch an instance in a Wavelength Zone and want to \n associate a Carrier IP address with the network interface. For more information, see \n Carrier IP address in the Wavelength Developer Guide.\n

" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Associates a public IPv4 address with eth0 for a new network interface.\n

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the network interface is deleted when the instance is terminated.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A description for the network interface.\n

" + } + }, + "DeviceIndex": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The device index for the network interface attachment.\n

" + } + }, + "Groups": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The IDs of one or more security groups.\n

" + } + }, + "InterfaceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of network interface.\n

" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of IPv4 prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv4Prefixes option.\n

" + } + }, + "Ipv4Prefixes": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesList", + "traits": { + "smithy.api#documentation": "

\n One or more IPv4 prefixes to be assigned to the network interface. You cannot use \n this option if you use the Ipv4PrefixCount option.\n

" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of IPv6 addresses to assign to a network interface. Amazon EC2 \n automatically selects the IPv6 addresses from the subnet range. You can't use this \n option if you use Ipv6Addresses.\n

" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesList", + "traits": { + "smithy.api#documentation": "

\n One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. \n You can't use this option if you use Ipv6AddressCount.\n

" + } + }, + "Ipv6PrefixCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of IPv6 prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv6Prefix option.\n

" + } + }, + "Ipv6Prefixes": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesList", + "traits": { + "smithy.api#documentation": "

\n One or more IPv6 prefixes to be assigned to the network interface. You cannot use \n this option if you use the Ipv6PrefixCount option.\n

" + } + }, + "NetworkCardIndex": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. The default \n is network card index 0.\n

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the network interface.\n

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The primary private IPv4 address of the network interface.\n

" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesList", + "traits": { + "smithy.api#documentation": "

\n One or more private IPv4 addresses.\n

" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of secondary private IPv4 addresses to assign to a network interface.\n

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the subnet for the network interface.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n One or more network interfaces to attach to an Amazon EC2 instance. If you specify a network interface, you must specify \n security groups and subnets as part of the network interface.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails": { + "type": "structure", + "members": { + "Ipv4Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The IPv4 prefix. For more information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details on one or more IPv4 prefixes for a network interface. \n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails": { + "type": "structure", + "members": { + "Ipv6Address": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies an IPv6 address in an Amazon EC2 launch template.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails": { + "type": "structure", + "members": { + "Ipv6Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The IPv6 prefix.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details on one or more IPv6 prefixes to be assigned to the network interface.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails": { + "type": "structure", + "members": { + "Primary": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.\n

" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The private IPv4 address.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n One or more private IPv4 addresses.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPlacementDetails": { + "type": "structure", + "members": { + "Affinity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The affinity setting for an instance on an EC2 Dedicated Host.\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Availability Zone for the instance.\n

" + } + }, + "GroupName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the placement group for the instance.\n

" + } + }, + "HostId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the Dedicated Host for the instance.\n

" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the host resource group in which to launch the instances. \n

" + } + }, + "PartitionNumber": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of the partition the instance should launch in.\n

" + } + }, + "SpreadDomain": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Reserved for future use.\n

" + } + }, + "Tenancy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about the placement of an Amazon EC2 instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails": { + "type": "structure", + "members": { + "EnableResourceNameDnsAAAARecord": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\n

" + } + }, + "EnableResourceNameDnsARecord": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether to respond to DNS queries for instance hostnames with DNS A records.\n

" + } + }, + "HostnameType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of hostname for EC2 instances. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes the options for Amazon EC2 instance hostnames.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2LaunchTemplateDetails": { + "type": "structure", + "members": { + "LaunchTemplateName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A name for the launch template.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n An ID for the launch template.\n

" + } + }, + "LaunchTemplateData": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDataDetails", + "traits": { + "smithy.api#documentation": "

\n The information to include in the launch template.\n

" + } + }, + "DefaultVersionNumber": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The default version of the launch template.\n

" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The latest version of the launch template.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the properties for creating an Amazon Elastic Compute Cloud (Amazon EC2) launch template.\n

" + } + }, "com.amazonaws.securityhub#AwsEc2NetworkAclAssociation": { "type": "structure", "members": { @@ -5105,7 +6377,7 @@ "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The attachment state of the volume. Valid values are as follows:

\n \t
    \n
  • \n

    \n attaching\n

    \n
    • \n
  • \n

    \n attached\n

    \n
    • \n
  • \n

    \n busy\n

    \n
    • \n
  • \n

    \n detaching\n

    \n
    • \n
  • \n

    \n detached\n

    \n
    • \n
" + "smithy.api#documentation": "

The attachment state of the volume. Valid values are as follows:

\n
    \n
  • \n

    \n attaching\n

    \n
    • \n
  • \n

    \n attached\n

    \n
    • \n
  • \n

    \n busy\n

    \n
    • \n
  • \n

    \n detaching\n

    \n
    • \n
  • \n

    \n detached\n

    \n
    • \n
" } } }, @@ -5157,7 +6429,7 @@ "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The volume state. Valid values are as follows:

\n \t
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n creating\n

    \n
    • \n
  • \n

    \n deleted\n

    \n
    • \n
  • \n

    \n deleting\n

    \n
    • \n
  • \n

    \n error\n

    \n
    • \n
  • \n

    \n in-use\n

    \n
    • \n
" + "smithy.api#documentation": "

The volume state. Valid values are as follows:

\n
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n creating\n

    \n
    • \n
  • \n

    \n deleted\n

    \n
    • \n
  • \n

    \n deleting\n

    \n
    • \n
  • \n

    \n error\n

    \n
    • \n
  • \n

    \n in-use\n

    \n
    • \n
" } }, "KmsKeyId": { @@ -5289,7 +6561,7 @@ "ServiceState": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The current state of the service. Valid values are as follows:

\n \t
    \n
  • \n

    \n Available\n

    \n
    • \n
  • \n

    \n Deleted\n

    \n
    • \n
  • \n

    \n Deleting\n

    \n
    • \n
  • \n

    \n Failed\n

    \n
    • \n
  • \n

    \n Pending\n

    \n
    • \n
" + "smithy.api#documentation": "

The current state of the service. Valid values are as follows:

\n
    \n
  • \n

    \n Available\n

    \n
    • \n
  • \n

    \n Deleted\n

    \n
    • \n
  • \n

    \n Deleting\n

    \n
    • \n
  • \n

    \n Failed\n

    \n
    • \n
  • \n

    \n Pending\n

    \n
    • \n
" } }, "ServiceType": { @@ -5443,7 +6715,7 @@ "State": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The current state of the VPN connection. Valid values are as follows:

\n \t
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n deleted\n

    \n
    • \n
  • \n

    \n deleting\n

    \n
    • \n
  • \n

    \n pending\n

    \n
    • \n
" + "smithy.api#documentation": "

The current state of the VPN connection. Valid values are as follows:

\n
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n deleted\n

    \n
    • \n
  • \n

    \n deleting\n

    \n
    • \n
  • \n

    \n pending\n

    \n
    • \n
" } }, "CustomerGatewayId": { @@ -5737,7 +7009,7 @@ "Architecture": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The architecture of the image. Valid values are as follows:

\n \t
    \n
  • \n

    \n arm64\n

    \n
    • \n
  • \n

    \n i386\n

    \n
    • \n
  • \n

    \n x86_64\n

    \n
    • \n
" + "smithy.api#documentation": "

The architecture of the image. Valid values are as follows:

\n
    \n
  • \n

    \n arm64\n

    \n
    • \n
  • \n

    \n i386\n

    \n
    • \n
  • \n

    \n x86_64\n

    \n
    • \n
" } }, "ImageDigest": { @@ -6511,7 +7783,7 @@ "Condition": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start. Valid values are as follows:

\n \t
    \n
  • \n

    \n COMPLETE\n

    \n
    • \n
  • \n

    \n HEALTHY\n

    \n
    • \n
  • \n

    \n SUCCESS\n

    \n
    • \n
  • \n

    \n START\n

    \n
    • \n
" + "smithy.api#documentation": "

The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start. Valid values are as follows:

\n
    \n
  • \n

    \n COMPLETE\n

    \n
    • \n
  • \n

    \n HEALTHY\n

    \n
    • \n
  • \n

    \n SUCCESS\n

    \n
    • \n
  • \n

    \n START\n

    \n
    • \n
" } }, "ContainerName": { @@ -6930,13 +8202,13 @@ "Add": { "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are added to the default configuration provided by Docker. Valid values are as follows:

\n \t

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" |\n \t\t\"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" |\n \t\t\"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" |\n \t\t\"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n \t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" |\n \t\t\t\"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n \t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" |\n \t\t\"SETFCAP\" | \"SETGID\" | \"SETPCAP\" |\n \t\t\"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" |\n \t\t\"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" |\n \t\t\"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" |\n \t\t\"SYSLOG\" | \"WAKE_ALARM\"\n

" + "smithy.api#documentation": "

The Linux capabilities for the container that are added to the default configuration provided by Docker. Valid values are as follows:

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" |\n \t\t\"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" |\n \t\t\"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" |\n \t\t\"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n \t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" |\n \t\t\t\"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n \t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" |\n \t\t\"SETFCAP\" | \"SETGID\" | \"SETPCAP\" |\n \t\t\"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" |\n \t\t\"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" |\n \t\t\"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" |\n \t\t\"SYSLOG\" | \"WAKE_ALARM\"\n

" } }, "Drop": { "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are dropped from the default configuration provided by Docker.

\n \t

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" |\n \t\t\"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" |\n \t\t\"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" |\n \t\t\"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n \t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" |\n \t\t\t\"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n \t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" |\n \t\t\"SETFCAP\" | \"SETGID\" | \"SETPCAP\" |\n \t\t\"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" |\n \t\t\"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" |\n \t\t\"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" |\n \t\t\"SYSLOG\" | \"WAKE_ALARM\"\n

" + "smithy.api#documentation": "

The Linux capabilities for the container that are dropped from the default configuration provided by Docker.

\n

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" |\n \t\t\"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" |\n \t\t\"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" |\n \t\t\"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" |\n \t\t\"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" |\n \t\t\t\"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" |\n \t\t\"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" |\n \t\t\"SETFCAP\" | \"SETGID\" | \"SETPCAP\" |\n \t\t\"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" |\n \t\t\"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" |\n \t\t\"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" |\n \t\t\"SYSLOG\" | \"WAKE_ALARM\"\n

" } } }, @@ -7042,7 +8314,7 @@ "MountOptions": { "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

The list of tmpfs volume mount options.

\n \t

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" |\n \t\t\"nosuid\" | \"dev\" | \"nodev\" | \"exec\" |\n \t\t\"noexec\" | \"sync\" | \"async\" | \"dirsync\"\n \t\t| \"remount\" | \"mand\" | \"nomand\" | \"atime\"\n \t\t| \"noatime\" | \"diratime\" | \"nodiratime\" |\n \t\t\"bind\" | \"rbind\" | \"unbindable\" |\n \t\t\"runbindable\" | \"private\" | \"rprivate\" |\n \t\t\"shared\" | \"rshared\" | \"slave\" |\n \t\t\"rslave\" | \"relatime\" | \"norelatime\" |\n \t\t\"strictatime\" | \"nostrictatime\" | \"mode\" |\n \t\t\"uid\" | \"gid\" | \"nr_inodes\" |\n \t\t\t\"nr_blocks\" | \"mpol\"\n

" + "smithy.api#documentation": "

The list of tmpfs volume mount options.

\n

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" |\n \t\t\"nosuid\" | \"dev\" | \"nodev\" | \"exec\" |\n \t\t\"noexec\" | \"sync\" | \"async\" | \"dirsync\"\n \t\t| \"remount\" | \"mand\" | \"nomand\" | \"atime\"\n \t\t| \"noatime\" | \"diratime\" | \"nodiratime\" |\n \t\t\"bind\" | \"rbind\" | \"unbindable\" |\n \t\t\"runbindable\" | \"private\" | \"rprivate\" |\n \t\t\"shared\" | \"rshared\" | \"slave\" |\n \t\t\"rslave\" | \"relatime\" | \"norelatime\" |\n \t\t\"strictatime\" | \"nostrictatime\" | \"mode\" |\n \t\t\"uid\" | \"gid\" | \"nr_inodes\" |\n \t\t\t\"nr_blocks\" | \"mpol\"\n

" } }, "Size": { @@ -7075,7 +8347,7 @@ "LogDriver": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The log driver to use for the container.

\n \t

Valid values on Fargate are as follows:

\n \t
    \n
  • \n

    \n awsfirelens\n

    \n
    • \n
  • \n

    \n awslogs\n

    \n
    • \n
  • \n

    \n splunk\n

    \n
    • \n
\n \t

Valid values on Amazon EC2 are as follows:

\n \t
    \n
  • \n

    \n awsfirelens\n

    \n
    • \n
  • \n

    \n awslogs\n

    \n
    • \n
  • \n

    \n fluentd\n

    \n
    • \n
  • \n

    \n gelf\n

    \n
    • \n
  • \n

    \n journald\n

    \n
    • \n
  • \n

    \n json-file\n

    \n
    • \n
  • \n

    \n logentries\n

    \n
    • \n
  • \n

    \n splunk\n

    \n
    • \n
  • \n

    \n syslog\n

    \n
    • \n
" + "smithy.api#documentation": "

The log driver to use for the container.

\n

Valid values on Fargate are as follows:

\n
    \n
  • \n

    \n awsfirelens\n

    \n
    • \n
  • \n

    \n awslogs\n

    \n
    • \n
  • \n

    \n splunk\n

    \n
    • \n
\n

Valid values on Amazon EC2 are as follows:

\n
    \n
  • \n

    \n awsfirelens\n

    \n
    • \n
  • \n

    \n awslogs\n

    \n
    • \n
  • \n

    \n fluentd\n

    \n
    • \n
  • \n

    \n gelf\n

    \n
    • \n
  • \n

    \n journald\n

    \n
    • \n
  • \n

    \n json-file\n

    \n
    • \n
  • \n

    \n logentries\n

    \n
    • \n
  • \n

    \n splunk\n

    \n
    • \n
  • \n

    \n syslog\n

    \n
    • \n
" } }, "Options": { @@ -7293,7 +8565,7 @@ "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of the ulimit. Valid values are as follows:

\n \t
    \n
  • \n

    \n core\n

    \n
    • \n
  • \n

    \n cpu\n

    \n
    • \n
  • \n

    \n data\n

    \n
    • \n
  • \n

    \n fsize\n

    \n
    • \n
  • \n

    \n locks\n

    \n
    • \n
  • \n

    \n memlock\n

    \n
    • \n
  • \n

    \n msgqueue\n

    \n
    • \n
  • \n

    \n nice\n

    \n
    • \n
  • \n

    \n nofile\n

    \n
    • \n
  • \n

    \n nproc\n

    \n
    • \n
  • \n

    \n rss\n

    \n
    • \n
  • \n

    \n rtprio\n

    \n
    • \n
  • \n

    \n rttime\n

    \n
    • \n
  • \n

    \n sigpending\n

    \n
    • \n
  • \n

    \n stack\n

    \n
    • \n
" + "smithy.api#documentation": "

The type of the ulimit. Valid values are as follows:

\n
    \n
  • \n

    \n core\n

    \n
    • \n
  • \n

    \n cpu\n

    \n
    • \n
  • \n

    \n data\n

    \n
    • \n
  • \n

    \n fsize\n

    \n
    • \n
  • \n

    \n locks\n

    \n
    • \n
  • \n

    \n memlock\n

    \n
    • \n
  • \n

    \n msgqueue\n

    \n
    • \n
  • \n

    \n nice\n

    \n
    • \n
  • \n

    \n nofile\n

    \n
    • \n
  • \n

    \n nproc\n

    \n
    • \n
  • \n

    \n rss\n

    \n
    • \n
  • \n

    \n rtprio\n

    \n
    • \n
  • \n

    \n rttime\n

    \n
    • \n
  • \n

    \n sigpending\n

    \n
    • \n
  • \n

    \n stack\n

    \n
    • \n
" } }, "SoftLimit": { @@ -7353,7 +8625,7 @@ "Cpu": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The number of CPU units used by the task.Valid values are as follows:

\n \t
    \n
  • \n

    \n 256 (.25 vCPU)\n

    \n
    • \n
  • \n

    \n 512 (.5 vCPU)\n

    \n
    • \n
  • \n

    \n 1024 (1 vCPU)\n

    \n
    • \n
  • \n

    \n 2048 (2 vCPU)\n

    \n
    • \n
  • \n

    \n 4096 (4 vCPU)\n

    \n
    • \n
" + "smithy.api#documentation": "

The number of CPU units used by the task.Valid values are as follows:

\n
    \n
  • \n

    \n 256 (.25 vCPU)\n

    \n
    • \n
  • \n

    \n 512 (.5 vCPU)\n

    \n
    • \n
  • \n

    \n 1024 (1 vCPU)\n

    \n
    • \n
  • \n

    \n 2048 (2 vCPU)\n

    \n
    • \n
  • \n

    \n 4096 (4 vCPU)\n

    \n
    • \n
" } }, "ExecutionRoleArn": { @@ -7377,7 +8649,7 @@ "IpcMode": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

\n \t
    \n
  • \n

    \n host\n

    \n
    • \n
  • \n

    \n none\n

    \n
    • \n
  • \n

    \n task\n

    \n
    • \n
" + "smithy.api#documentation": "

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

\n
    \n
  • \n

    \n host\n

    \n
    • \n
  • \n

    \n none\n

    \n
    • \n
  • \n

    \n task\n

    \n
    • \n
" } }, "Memory": { @@ -7389,7 +8661,7 @@ "NetworkMode": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. Valid values are as follows:

\n \t
    \n
  • \n

    \n awsvpc\n

    \n
    • \n
  • \n

    \n bridge\n

    \n
    • \n
  • \n

    \n host\n

    \n
    • \n
  • \n

    \n none\n

    \n
    • \n
" + "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task. Valid values are as follows:

\n
    \n
  • \n

    \n awsvpc\n

    \n
    • \n
  • \n

    \n bridge\n

    \n
    • \n
  • \n

    \n host\n

    \n
    • \n
  • \n

    \n none\n

    \n
    • \n
" } }, "PidMode": { @@ -7923,7 +9195,7 @@ "ClusterStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The status of the cluster. Valid values are as follows:

\n \t
    \n
  • \n

    \n ACTIVE\n

    \n
    • \n
  • \n

    \n CREATING\n

    \n
    • \n
  • \n

    \n DELETING\n

    \n
    • \n
  • \n

    \n FAILED\n

    \n
    • \n
  • \n

    \n PENDING\n

    \n
    • \n
  • \n

    \n UPDATING\n

    \n
    • \n
" + "smithy.api#documentation": "

The status of the cluster. Valid values are as follows:

\n
    \n
  • \n

    \n ACTIVE\n

    \n
    • \n
  • \n

    \n CREATING\n

    \n
    • \n
  • \n

    \n DELETING\n

    \n
    • \n
  • \n

    \n FAILED\n

    \n
    • \n
  • \n

    \n PENDING\n

    \n
    • \n
  • \n

    \n UPDATING\n

    \n
    • \n
" } }, "Endpoint": { @@ -7980,7 +9252,7 @@ "Types": { "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

A list of logging types. Valid values are as follows:

\n \t
    \n
  • \n

    \n api\n

    \n
    • \n
  • \n

    \n audit\n

    \n
    • \n
  • \n

    \n authenticator\n

    \n
    • \n
  • \n

    \n controllerManager\n

    \n
    • \n
  • \n

    \n scheduler\n

    \n
    • \n
" + "smithy.api#documentation": "

A list of logging types. Valid values are as follows:

\n
    \n
  • \n

    \n api\n

    \n
    • \n
  • \n

    \n audit\n

    \n
    • \n
  • \n

    \n authenticator\n

    \n
    • \n
  • \n

    \n controllerManager\n

    \n
    • \n
  • \n

    \n scheduler\n

    \n
    • \n
" } } }, @@ -8112,7 +9384,7 @@ "Status": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The current operational status of the environment. Valid values are as follows:

\n \t
    \n
  • \n

    \n Aborting\n

    \n
    • \n
  • \n

    \n Launching\n

    \n
    • \n
  • \n

    \n LinkingFrom\n

    \n
    • \n
  • \n

    \n LinkingTo\n

    \n
    • \n
  • \n

    \n Ready\n

    \n
    • \n
  • \n

    \n Terminated\n

    \n
    • \n
  • \n

    \n Terminating\n

    \n
    • \n
  • \n

    \n Updating\n

    \n
    • \n
" + "smithy.api#documentation": "

The current operational status of the environment. Valid values are as follows:

\n
    \n
  • \n

    \n Aborting\n

    \n
    • \n
  • \n

    \n Launching\n

    \n
    • \n
  • \n

    \n LinkingFrom\n

    \n
    • \n
  • \n

    \n LinkingTo\n

    \n
    • \n
  • \n

    \n Ready\n

    \n
    • \n
  • \n

    \n Terminated\n

    \n
    • \n
  • \n

    \n Terminating\n

    \n
    • \n
  • \n

    \n Updating\n

    \n
    • \n
" } }, "Tier": { @@ -8349,7 +9621,7 @@ "DedicatedMasterType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The hardware configuration of the computer that hosts the dedicated master node. A sample value is m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled must be true.

\n \t

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" + "smithy.api#documentation": "

The hardware configuration of the computer that hosts the dedicated master node. A sample value is m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled must be true.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" } }, "InstanceCount": { @@ -8362,7 +9634,7 @@ "InstanceType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The instance type for your data nodes. For example, m3.medium.elasticsearch.

\n \t

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" + "smithy.api#documentation": "

The instance type for your data nodes. For example, m3.medium.elasticsearch.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" } }, "ZoneAwarenessConfig": { @@ -8522,7 +9794,7 @@ "UpdateStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The status of the service software update. Valid values are as follows:

\n \t
    \n
  • \n

    \n COMPLETED\n

    \n
    • \n
  • \n

    \n ELIGIBLE\n

    \n
    • \n
  • \n

    \n IN_PROGRESS\n

    \n
    • \n
  • \n

    \n NOT_ELIGIBLE\n

    \n
    • \n
  • \n

    \n PENDING_UPDATE\n

    \n
    • \n
" + "smithy.api#documentation": "

The status of the service software update. Valid values are as follows:

\n
    \n
  • \n

    \n COMPLETED\n

    \n
    • \n
  • \n

    \n ELIGIBLE\n

    \n
    • \n
  • \n

    \n IN_PROGRESS\n

    \n
    • \n
  • \n

    \n NOT_ELIGIBLE\n

    \n
    • \n
  • \n

    \n PENDING_UPDATE\n

    \n
    • \n
" } } }, @@ -9920,7 +11192,7 @@ "KeyState": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The state of the KMS key. Valid values are as follows:

\n \t
    \n
  • \n

    \n Disabled\n

    \n
    • \n
  • \n

    \n Enabled\n

    \n
    • \n
  • \n

    \n PendingDeletion\n

    \n
    • \n
  • \n

    \n PendingImport\n

    \n
    • \n
  • \n

    \n Unavailable\n

    \n
    • \n
" + "smithy.api#documentation": "

The state of the KMS key. Valid values are as follows:

\n
    \n
  • \n

    \n Disabled\n

    \n
    • \n
  • \n

    \n Enabled\n

    \n
    • \n
  • \n

    \n PendingDeletion\n

    \n
    • \n
  • \n

    \n PendingImport\n

    \n
    • \n
  • \n

    \n Unavailable\n

    \n
    • \n
" } }, "Origin": { @@ -10544,7 +11816,7 @@ "InstanceType": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The instance type for your data nodes.

\n \t

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" + "smithy.api#documentation": "

The instance type for your data nodes.

\n

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

" } }, "WarmType": { @@ -10877,7 +12149,7 @@ "UpdateStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The status of the service software update. Valid values are as follows:

\n \t
    \n
  • \n

    \n COMPLETED\n

    \n
    • \n
  • \n

    \n ELIGIBLE\n

    \n
    • \n
  • \n

    \n IN_PROGRESS\n

    \n
    • \n
  • \n

    \n NOT_ELIGIBLE\n

    \n
    • \n
  • \n

    \n PENDING_UPDATE\n

    \n
    • \n
" + "smithy.api#documentation": "

The status of the service software update. Valid values are as follows:

\n
    \n
  • \n

    \n COMPLETED\n

    \n
    • \n
  • \n

    \n ELIGIBLE\n

    \n
    • \n
  • \n

    \n IN_PROGRESS\n

    \n
    • \n
  • \n

    \n NOT_ELIGIBLE\n

    \n
    • \n
  • \n

    \n PENDING_UPDATE\n

    \n
    • \n
" } }, "OptionalDeployment": { @@ -11113,7 +12385,7 @@ "ActivityStreamStatus": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The status of the database activity stream. Valid values are as follows:

\n \t
    \n
  • \n

    \n started\n

    \n
    • \n
  • \n

    \n starting\n

    \n
    • \n
  • \n

    \n stopped\n

    \n
    • \n
  • \n

    \n stopping\n

    \n
    • \n
" + "smithy.api#documentation": "

The status of the database activity stream. Valid values are as follows:

\n
    \n
  • \n

    \n started\n

    \n
    • \n
  • \n

    \n starting\n

    \n
    • \n
  • \n

    \n stopped\n

    \n
    • \n
  • \n

    \n stopping\n

    \n
    • \n
" } }, "CopyTagsToSnapshot": { @@ -14121,12 +15393,155 @@ "SSEKMSKeyId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The identifier of the KMS symmetric customer managed key that was used for the object.

" + "smithy.api#documentation": "

The identifier of the KMS symmetric customer managed key that was used for the object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Amazon S3 object.

" + } + }, + "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceDetails": { + "type": "structure", + "members": { + "AcceleratorTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance. \n

" + } + }, + "AdditionalCodeRepositories": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. \n These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.\n

" + } + }, + "DefaultCodeRepository": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. \n When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.\n

" + } + }, + "DirectInternetAccess": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled, this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.\n

" + } + }, + "FailureReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n If status of the instance is Failed, the reason it failed.\n

" + } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails", + "traits": { + "smithy.api#documentation": "

\n Information on the IMDS configuration of the notebook instance.\n

" + } + }, + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of machine learning (ML) compute instance to launch for the notebook instance.\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see \n Enabling and disabling keys in the Key Management Service Developer Guide.\n

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The network interface ID that SageMaker created when the instance was created.\n

" + } + }, + "NotebookInstanceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the notebook instance.\n

" + } + }, + "NotebookInstanceLifecycleConfigName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of a notebook instance lifecycle configuration.\n

" + } + }, + "NotebookInstanceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the new notebook instance.\n

" + } + }, + "NotebookInstanceStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The status of the notebook instance.\n

" + } + }, + "PlatformIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The platform identifier of the notebook instance runtime environment.\n

" + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role associated with the instance.\n

" + } + }, + "RootAccess": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Whether root access is enabled or disabled for users of the notebook instance. \n

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

\n The VPC security group IDs.\n

" + } + }, + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The ID of the VPC subnet to which you have a connectivity from your ML compute instance.\n

" + } + }, + "Url": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.\n

" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The size, in GB, of the ML storage volume to attach to the notebook instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Provides details about an Amazon SageMaker notebook instance.\n

" + } + }, + "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails": { + "type": "structure", + "members": { + "MinimumInstanceMetadataServiceVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Indicates the minimum IMDS version that the notebook instance supports.\n

" } } }, "traits": { - "smithy.api#documentation": "

Details about an Amazon S3 object.

" + "smithy.api#documentation": "

\n Information on the instance metadata service (IMDS) configuration of the notebook instance.\n

" } }, "com.amazonaws.securityhub#AwsSecretsManagerSecretDetails": { @@ -15539,51 +16954,312 @@ "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate" } }, - "com.amazonaws.securityhub#AwsWafRegionalRuleDetails": { + "com.amazonaws.securityhub#AwsWafRegionalRuleDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for the rule. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name for the rule.\n

" + } + }, + "PredicateList": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList", + "traits": { + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet,\n SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,\n GeoMatchSet, and SizeConstraintSet objects that you want to\n add to a rule and, for each object, indicates whether you want to negate the settings.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an WAF Regional rule. This rule identifies the web requests that you want to allow, block, or count.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for this rule group.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The descriptive name of the rule group.\n

" + } + }, + "RuleGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the rule group.\n

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList", + "traits": { + "smithy.api#documentation": "

Provides information about the rule statements used to identify the web requests that you want to allow, block, or \ncount. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an WAF Regional rule group. The rule group is a collection of rules for inspecting and controlling web\n requests.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, \nGeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the action that WAF should take on a web request when it matches the criteria defined in the rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the criteria defined in the rule.

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in\n order based on the value of Priority.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID for a rule.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of rule in the rule group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the rules attached to a rule group\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails": { + "type": "structure", + "members": { + "DataId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.\n

" + } + }, + "Negated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of predicate in a rule, such as ByteMatch or IPSet.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclDetails": { + "type": "structure", + "members": { + "DefaultAction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match. \n

" + } + }, + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for this web ACL. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name for the web ACL. \n

" + } + }, + "RulesList": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList", + "traits": { + "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of \nthe rule.\n

" + } + }, + "WebAclId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the web ACL.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the web access control list (web ACL). The web ACL contains the rules that identify the requests that you\n want to allow, block, or count.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the\n rule, such as allow, block, or count the request.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails", + "traits": { + "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n

" + } + }, + "OverrideAction": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails", + "traits": { + "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group. \n

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The order in which WAF evaluates the rules in a web ACL.\n

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of an WAF Regional rule to associate with a web ACL.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web \nrequest matches all conditions in a rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet \nobjects that identify the web requests that you want to allow, block, or count. \n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the action to use in the place of the action that results from the rule group \nevaluation. \n

" + } + }, + "com.amazonaws.securityhub#AwsWafRuleDetails": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A name for the metrics for the rule. \n

" + "smithy.api#documentation": "

The name of the metrics for this rule.\n

" } }, "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A descriptive name for the rule.\n

" + "smithy.api#documentation": "

A descriptive name for the rule. \n

" } }, "PredicateList": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList", + "target": "com.amazonaws.securityhub#AwsWafRulePredicateList", "traits": { - "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet,\n SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,\n GeoMatchSet, and SizeConstraintSet objects that you want to\n add to a rule and, for each object, indicates whether you want to negate the settings.

" + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \n for each object, indicates whether you want to negate the settings.\n

" } }, "RuleId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the rule.\n

" + "smithy.api#documentation": "

The ID of the WAF rule. \n

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about an WAF Regional rule. This rule identifies the web requests that you want to allow, block, or count.

" + "smithy.api#documentation": "

Provides information about a WAF rule. This rule specifies the web requests that you want to allow, block, or count.\n

" } }, - "com.amazonaws.securityhub#AwsWafRegionalRuleGroupDetails": { + "com.amazonaws.securityhub#AwsWafRuleGroupDetails": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A name for the metrics for this rule group.\n

" + "smithy.api#documentation": "

The name of the metrics for this rule group. \n

" } }, "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The descriptive name of the rule group.\n

" + "smithy.api#documentation": "

The name of the rule group. \n

" } }, "RuleGroupId": { @@ -15593,76 +17269,76 @@ } }, "Rules": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList", + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesList", "traits": { - "smithy.api#documentation": "

Provides information about the rule statements used to identify the web requests that you want to allow, block, or \ncount. \n

" + "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \nallow, block, or count. \n

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about an WAF Regional rule group. The rule group is a collection of rules for inspecting and controlling web\n requests.

" + "smithy.api#documentation": "

Provides information about an WAF rule group. A rule group is a collection of rules for inspecting and controlling web requests. \n

" } }, - "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails": { + "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, \nGeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

" + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule's\n statement.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the action that WAF should take on a web request when it matches the criteria defined in the rule.\n

" + "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" } }, - "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails": { + "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails": { "type": "structure", "members": { "Action": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails", + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails", "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the criteria defined in the rule.

" + "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" } }, "Priority": { "target": "com.amazonaws.securityhub#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in\n order based on the value of Priority.

" + "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order\n based on the value of Priority.

" } }, "RuleId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID for a rule.\n

" + "smithy.api#documentation": "

The rule ID for a rule.\n

" } }, "Type": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of rule in the rule group.\n

" + "smithy.api#documentation": "

The type of rule.\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about the rules attached to a rule group\n

" + "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \n allow, block, or count. \n

" } }, - "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList": { + "com.amazonaws.securityhub#AwsWafRuleGroupRulesList": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails" + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails" } }, - "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList": { + "com.amazonaws.securityhub#AwsWafRulePredicateList": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails" + "target": "com.amazonaws.securityhub#AwsWafRulePredicateListDetails" } }, - "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails": { + "com.amazonaws.securityhub#AwsWafRulePredicateListDetails": { "type": "structure", "members": { "DataId": { @@ -15686,351 +17362,494 @@ } }, "traits": { - "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.\n

" + "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \nfor each object, indicates whether you want to negate the settings.\n

" } }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclDetails": { + "com.amazonaws.securityhub#AwsWafWebAclDetails": { "type": "structure", "members": { - "DefaultAction": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match. \n

" - } - }, - "MetricName": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A name for the metrics for this web ACL. \n

" + "smithy.api#documentation": "

A friendly name or description of the web ACL. You can't change the name of a web ACL after you create it.

" } }, - "Name": { + "DefaultAction": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A descriptive name for the web ACL. \n

" + "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match.

" } }, - "RulesList": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList", + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafWebAclRuleList", "traits": { - "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of \nthe rule.\n

" + "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.

" } }, "WebAclId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the web ACL.\n

" + "smithy.api#documentation": "

A unique identifier for a web ACL.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about the web access control list (web ACL). The web ACL contains the rules that identify the requests that you\n want to allow, block, or count.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails" + "smithy.api#documentation": "

Provides information about an WAF web access control list (web ACL).

" } }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails": { + "com.amazonaws.securityhub#AwsWafWebAclRule": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Action": { + "target": "com.amazonaws.securityhub#WafAction", "traits": { - "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.\n

" + "smithy.api#documentation": "

Specifies the action that CloudFront or WAF takes when a web request matches the\n conditions in the rule.

" } - } - }, - "traits": { - "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the\n rule, such as allow, block, or count the request.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails", + }, + "ExcludedRules": { + "target": "com.amazonaws.securityhub#WafExcludedRuleList", "traits": { - "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n

" + "smithy.api#documentation": "

Rules to exclude from a rule group.

" } }, "OverrideAction": { - "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails", + "target": "com.amazonaws.securityhub#WafOverrideAction", "traits": { - "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group. \n

" + "smithy.api#documentation": "

Use the OverrideAction to test your RuleGroup.

\n

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to\n None, the RuleGroup blocks a request if any individual rule in the RuleGroup\n matches the request and is configured to block that request.

\n

However, if you first want to test the RuleGroup,\n set the OverrideAction to Count. The RuleGroup\n then overrides any block action specified by individual rules contained within the group.\n Instead of blocking matching requests, those requests are counted.

\n

\n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup\n to a web ACL. In this case you do not use ActivatedRule\n Action. For all other update requests,\n ActivatedRule\n Action is used instead of ActivatedRule\n OverrideAction.

" } }, "Priority": { "target": "com.amazonaws.securityhub#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The order in which WAF evaluates the rules in a web ACL.\n

" + "smithy.api#documentation": "

Specifies the order in which the rules in a web\n ACL are evaluated. Rules with a lower value for Priority are\n evaluated before rules with a higher value. The value must be a unique integer. If you add\n multiple rules to a web ACL, the values do not need to be consecutive.

" } }, "RuleId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of an WAF Regional rule to associate with a web ACL.

" + "smithy.api#documentation": "

The identifier for a rule.

" } }, "Type": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web \nrequest matches all conditions in a rule.\n

" + "smithy.api#documentation": "

The rule type.

\n

Valid values: REGULAR | RATE_BASED | GROUP\n

\n

The default is REGULAR.

" } } }, "traits": { - "smithy.api#documentation": "

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet \nobjects that identify the web requests that you want to allow, block, or count. \n

" + "smithy.api#documentation": "

Details for a rule in an WAF web ACL.

" } }, - "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails": { + "com.amazonaws.securityhub#AwsWafWebAclRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafWebAclRule" + } + }, + "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "CustomRequestHandling": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", "traits": { - "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group.\n

" + "smithy.api#documentation": "

\n Defines custom handling for the web request. For information about customizing web requests and responses, see \n Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides details about the action to use in the place of the action that results from the rule group \nevaluation. \n

" + "smithy.api#documentation": "

\n Specifies that WAF should allow the request and optionally defines additional custom handling for the request.\n

" } }, - "com.amazonaws.securityhub#AwsWafRuleDetails": { + "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails": { "type": "structure", "members": { - "MetricName": { + "CustomResponse": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomResponseDetails", + "traits": { + "smithy.api#documentation": "

\n Defines a custom response for the web request. For information, see \n Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2CustomHttpHeader": { + "type": "structure", + "members": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the metrics for this rule.\n

" + "smithy.api#documentation": "

\n The name of the custom header.\n

" } }, - "Name": { + "Value": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A descriptive name for the rule. \n

" + "smithy.api#documentation": "

\n The value of the custom header.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A custom header for custom request and response handling.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails": { + "type": "structure", + "members": { + "InsertHeaders": { + "target": "com.amazonaws.securityhub#AwsWafv2InsertHeadersList", + "traits": { + "smithy.api#documentation": "

\n The HTTP headers to insert into the request.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Custom request handling behavior that inserts custom headers into a web request. WAF uses custom request handling when the rule action doesn't block the request.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2CustomResponseDetails": { + "type": "structure", + "members": { + "CustomResponseBodyKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.\n

" } }, - "PredicateList": { - "target": "com.amazonaws.securityhub#AwsWafRulePredicateList", + "ResponseCode": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \n for each object, indicates whether you want to negate the settings.\n

" + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see \n Supported status codes for custom response in the WAF Developer Guide.\n

" } }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ResponseHeaders": { + "target": "com.amazonaws.securityhub#AwsWafv2InsertHeadersList", "traits": { - "smithy.api#documentation": "

The ID of the WAF rule. \n

" + "smithy.api#documentation": "

\n The HTTP headers to use in the response.\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about a WAF rule. This rule specifies the web requests that you want to allow, block, or count.\n

" + "smithy.api#documentation": "

\n A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to block.\n

" } }, - "com.amazonaws.securityhub#AwsWafRuleGroupDetails": { + "com.amazonaws.securityhub#AwsWafv2InsertHeadersList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomHttpHeader" + } + }, + "com.amazonaws.securityhub#AwsWafv2RuleGroupDetails": { "type": "structure", "members": { - "MetricName": { + "Capacity": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The web ACL capacity units (WCUs) required for this rule group. \n

" + } + }, + "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the metrics for this rule group. \n

" + "smithy.api#documentation": "

\n A description of the rule group that helps with identification.\n

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A unique identifier for the rule group. \n

" } }, "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the rule group. \n

" + "smithy.api#documentation": "

\n The name of the rule group. You cannot change the name of a rule group after you create it.\n

" } }, - "RuleGroupId": { + "Arn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of the rule group.\n

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the entity.\n

" } }, "Rules": { - "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesList", + "target": "com.amazonaws.securityhub#AwsWafv2RulesList", "traits": { - "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \nallow, block, or count. \n

" + "smithy.api#documentation": "

\n The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one \n top-level statement that WAF uses to identify matching web requests, and parameters that govern how \n WAF handles them.\n

" + } + }, + "Scope": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. \n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync \n GraphQL API, or an Amazon Cognito user pool.\n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", + "traits": { + "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about an WAF rule group. A rule group is a collection of rules for inspecting and controlling web requests. \n

" + "smithy.api#documentation": "

\n Details about an WAFv2 rule group.\n

" } }, - "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails": { + "com.amazonaws.securityhub#AwsWafv2RulesActionCaptchaDetails": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "CustomRequestHandling": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule's\n statement.

" + "smithy.api#documentation": "

\n Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired. For more information, \n see Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" + "smithy.api#documentation": "

\n Specifies that WAF should run a CAPTCHA check against the request.\n

" } }, - "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails": { + "com.amazonaws.securityhub#AwsWafv2RulesActionCountDetails": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.securityhub#AwsWafv2CustomRequestHandlingDetails", + "traits": { + "smithy.api#documentation": "

\n Defines custom handling for the web request. For more information, \n see Customizing web requests and responses in WAF in the WAF Developer Guide..\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies that WAF should count the request.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2RulesActionDetails": { + "type": "structure", + "members": { + "Allow": { + "target": "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails", + "traits": { + "smithy.api#documentation": "

\n Instructs WAF to allow the web request.\n

" + } + }, + "Block": { + "target": "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails", + "traits": { + "smithy.api#documentation": "

\n Instructs WAF to block the web request.\n

" + } + }, + "Captcha": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesActionCaptchaDetails", + "traits": { + "smithy.api#documentation": "

\n Instructs WAF to run a CAPTCHA check against the web request.\n

" + } + }, + "Count": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesActionCountDetails", + "traits": { + "smithy.api#documentation": "

\n Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The action that WAF should take on a web request when it matches a rule's statement. \n Settings at the web ACL level can override the rule action setting.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2RulesDetails": { "type": "structure", "members": { "Action": { - "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails", + "target": "com.amazonaws.securityhub#AwsWafv2RulesActionDetails", "traits": { - "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" + "smithy.api#documentation": "

\n The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.\n

" } }, - "Priority": { - "target": "com.amazonaws.securityhub#Integer", + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order\n based on the value of Priority.

" + "smithy.api#documentation": "

\n The name of the rule. \n

" } }, - "RuleId": { + "OverrideAction": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The rule ID for a rule.\n

" + "smithy.api#documentation": "

\n The action to use in the place of the action that results from the rule group evaluation. \n

" } }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Priority": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The type of rule.\n

" + "smithy.api#default": 0, + "smithy.api#documentation": "

\n If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. \n WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.\n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", + "traits": { + "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \n allow, block, or count. \n

" - } - }, - "com.amazonaws.securityhub#AwsWafRuleGroupRulesList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails" + "smithy.api#documentation": "

\n Provides details about rules in a rule group. A rule identifies web requests that you want to allow, block, or count. Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.\n

" } }, - "com.amazonaws.securityhub#AwsWafRulePredicateList": { + "com.amazonaws.securityhub#AwsWafv2RulesList": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsWafRulePredicateListDetails" + "target": "com.amazonaws.securityhub#AwsWafv2RulesDetails" } }, - "com.amazonaws.securityhub#AwsWafRulePredicateListDetails": { + "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails": { "type": "structure", "members": { - "DataId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.\n

" - } - }, - "Negated": { + "CloudWatchMetricsEnabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n

" + "smithy.api#documentation": "

\n A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available \n metrics, see WAF metrics and dimensions in the WAF Developer Guide.\n

" } }, - "Type": { + "MetricName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of predicate in a rule, such as ByteMatch or IPSet.\n

" + "smithy.api#documentation": "

\n A name of the Amazon CloudWatch metric. \n

" + } + }, + "SampledRequestsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n A boolean indicating whether WAF should store a sampling of the web requests that match the rules. \n You can view the sampled requests through the WAF console.\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \nfor each object, indicates whether you want to negate the settings.\n

" + "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" } }, - "com.amazonaws.securityhub#AwsWafWebAclDetails": { + "com.amazonaws.securityhub#AwsWafv2WebAclActionDetails": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Allow": { + "target": "com.amazonaws.securityhub#AwsWafv2ActionAllowDetails", "traits": { - "smithy.api#documentation": "

A friendly name or description of the web ACL. You can't change the name of a web ACL after you create it.

" + "smithy.api#documentation": "

\n Specifies that WAF should allow requests by default.\n

" } }, - "DefaultAction": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Block": { + "target": "com.amazonaws.securityhub#AwsWafv2ActionBlockDetails", "traits": { - "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match.

" + "smithy.api#documentation": "

\n Specifies that WAF should block requests by default.\n

" } - }, - "Rules": { - "target": "com.amazonaws.securityhub#AwsWafWebAclRuleList", + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies the action that Amazon CloudFront or WAF takes when a web request matches the conditions in the rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigDetails": { + "type": "structure", + "members": { + "ImmunityTimeProperty": { + "target": "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails", "traits": { - "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.

" + "smithy.api#documentation": "

\n Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.\n

" } - }, - "WebAclId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + } + }, + "traits": { + "smithy.api#documentation": "

\n Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails": { + "type": "structure", + "members": { + "ImmunityTime": { + "target": "com.amazonaws.securityhub#Long", "traits": { - "smithy.api#documentation": "

A unique identifier for a web ACL.

" + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF.\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about an WAF web access control list (web ACL).

" + "smithy.api#documentation": "

\n Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA or challenge response.\n

" } }, - "com.amazonaws.securityhub#AwsWafWebAclRule": { + "com.amazonaws.securityhub#AwsWafv2WebAclDetails": { "type": "structure", "members": { - "Action": { - "target": "com.amazonaws.securityhub#WafAction", + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Specifies the action that CloudFront or WAF takes when a web request matches the\n conditions in the rule.

" + "smithy.api#documentation": "

\n The name of the web ACL.\n

" } }, - "ExcludedRules": { - "target": "com.amazonaws.securityhub#WafExcludedRuleList", + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Rules to exclude from a rule group.

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.\n

" } }, - "OverrideAction": { - "target": "com.amazonaws.securityhub#WafOverrideAction", + "ManagedbyFirewallManager": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Use the OverrideAction to test your RuleGroup.

\n

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to\n None, the RuleGroup blocks a request if any individual rule in the RuleGroup\n matches the request and is configured to block that request.

\n

However, if you first want to test the RuleGroup,\n set the OverrideAction to Count. The RuleGroup\n then overrides any block action specified by individual rules contained within the group.\n Instead of blocking matching requests, those requests are counted.

\n

\n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup\n to a web ACL. In this case you do not use ActivatedRule \n Action. For all other update requests,\n ActivatedRule \n Action is used instead of ActivatedRule \n OverrideAction.

" + "smithy.api#default": false, + "smithy.api#documentation": "

\n Indicates whether this web ACL is managed by Firewall Manager. \n

" } }, - "Priority": { - "target": "com.amazonaws.securityhub#Integer", + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n A unique identifier for the web ACL.\n

" + } + }, + "Capacity": { + "target": "com.amazonaws.securityhub#Long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the order in which the rules in a web\n ACL are evaluated. Rules with a lower value for Priority are\n evaluated before rules with a higher value. The value must be a unique integer. If you add\n multiple rules to a web ACL, the values do not need to be consecutive.

" + "smithy.api#documentation": "

\n The web ACL capacity units (WCUs) currently being used by this web ACL.\n

" } }, - "RuleId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "CaptchaConfig": { + "target": "com.amazonaws.securityhub#AwsWafv2WebAclCaptchaConfigDetails", "traits": { - "smithy.api#documentation": "

The identifier for a rule.

" + "smithy.api#documentation": "

\n Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own \n CaptchaConfig settings.\n

" } }, - "Type": { + "DefaultAction": { + "target": "com.amazonaws.securityhub#AwsWafv2WebAclActionDetails", + "traits": { + "smithy.api#documentation": "

\n The action to perform if none of the Rules contained in the web ACL match.\n

" + } + }, + "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The rule type.

\n

Valid values: REGULAR | RATE_BASED | GROUP\n

\n

The default is REGULAR.

" + "smithy.api#documentation": "

\n A description of the web ACL that helps with identification.\n

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafv2RulesList", + "traits": { + "smithy.api#documentation": "

\n The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one \n top-level statement that WAF uses to identify matching web requests, and parameters that govern how \n WAF handles them.\n

" + } + }, + "VisibilityConfig": { + "target": "com.amazonaws.securityhub#AwsWafv2VisibilityConfigDetails", + "traits": { + "smithy.api#documentation": "

\n Defines and enables Amazon CloudWatch metrics and web request sample collection.\n

" } } }, "traits": { - "smithy.api#documentation": "

Details for a rule in an WAF web ACL.

" - } - }, - "com.amazonaws.securityhub#AwsWafWebAclRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafWebAclRule" + "smithy.api#documentation": "

\n Details about an WAFv2 web Access Control List (ACL).\n

" } }, "com.amazonaws.securityhub#AwsXrayEncryptionConfigDetails": { @@ -16384,7 +18203,7 @@ "ErrorMessage": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The message associated with the error. Possible values are:

\n
    \n
  • \n

    \n Concurrent finding updates detected\n

    \n
    • \n
  • \n

    \n Finding Identifier is duplicated\n

    \n
    • \n
  • \n

    \n Finding Not Found\n

    \n
    • \n
  • \n

    \n Finding size exceeded 240 KB\n

    \n
    • \n
  • \n

    \n Internal service failure\n

    \n
    • \n
  • \n

    \n Invalid Input\n

    \n
    • \n
", + "smithy.api#documentation": "

The message associated with the error. Possible values are:

\n
    \n
  • \n

    \n Concurrent finding updates detected\n

    \n
    • \n
  • \n

    \n Finding Identifier is duplicated\n

    \n
    • \n
  • \n

    \n Finding Not Found\n

    \n
    • \n
  • \n

    \n Finding size exceeded 240 KB\n

    \n
    • \n
  • \n

    \n Internal service failure\n

    \n
    • \n
  • \n

    \n Invalid Input\n

    \n
    • \n
", "smithy.api#required": {} } } @@ -17749,7 +19568,7 @@ "AutoEnableStandards": { "target": "com.amazonaws.securityhub#AutoEnableStandards", "traits": { - "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

The default value of this parameter is equal to DEFAULT.

\n

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to NONE, then default standards are not automatically enabled for new member \n accounts.

" + "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

The default value of this parameter is equal to DEFAULT.

\n

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to NONE, then default standards are not automatically enabled for new member \n accounts.

" } } } @@ -19532,7 +21351,7 @@ } }, "traits": { - "smithy.api#documentation": "

There is an issue with the account used to make the request. Either Security Hub is not enabled\n for the account, or the account does not have permission to perform this action.

", + "smithy.api#documentation": "

The account doesn't have permission to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } @@ -19719,7 +21538,7 @@ "CidrBlockState": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about the state of the CIDR block. Valid values are as follows:

\n\t\t
    \n
  • \n

    \n associating\n

    \n
    • \n
  • \n

    \n associated\n

    \n
    • \n
  • \n

    \n disassociating\n

    \n
    • \n
  • \n

    \n disassociated\n

    \n
    • \n
  • \n

    \n failed\n

    \n
    • \n
  • \n

    \n failing\n

    \n
    • \n
" + "smithy.api#documentation": "

Information about the state of the CIDR block. Valid values are as follows:

\n
    \n
  • \n

    \n associating\n

    \n
    • \n
  • \n

    \n associated\n

    \n
    • \n
  • \n

    \n disassociating\n

    \n
    • \n
  • \n

    \n disassociated\n

    \n
    • \n
  • \n

    \n failed\n

    \n
    • \n
  • \n

    \n failing\n

    \n
    • \n
" } } }, @@ -21941,6 +23760,18 @@ "traits": { "smithy.api#documentation": "

Provides details about an Backup backup, or recovery point.\n

" } + }, + "AwsEc2LaunchTemplate": { + "target": "com.amazonaws.securityhub#AwsEc2LaunchTemplateDetails" + }, + "AwsSageMakerNotebookInstance": { + "target": "com.amazonaws.securityhub#AwsSageMakerNotebookInstanceDetails" + }, + "AwsWafv2WebAcl": { + "target": "com.amazonaws.securityhub#AwsWafv2WebAclDetails" + }, + "AwsWafv2RuleGroup": { + "target": "com.amazonaws.securityhub#AwsWafv2RuleGroupDetails" } }, "traits": { @@ -22685,7 +24516,7 @@ "name": "securityhub" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .

\n

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

\n

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

\n
    \n
  • \n

    \n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.

    \n
    • \n
  • \n

    \n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.

    \n
    • \n
  • \n

    \n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
  • \n

    \n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
  • \n

    \n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.

    \n
    • \n
  • \n

    All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
", + "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .

\n

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

\n

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

\n
    \n
  • \n

    \n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.

    \n
    • \n
  • \n

    \n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.

    \n
    • \n
  • \n

    \n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
  • \n

    \n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
  • \n

    \n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.

    \n
    • \n
  • \n

    All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
", "smithy.api#title": "AWS SecurityHub", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -22741,15 +24572,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -23012,9 +24834,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -23025,9 +24847,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -23038,9 +24860,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -23051,9 +24873,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -23064,9 +24886,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -23077,9 +24899,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -23090,9 +24912,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": true } }, { @@ -23103,9 +24925,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-south-1" + "Region": "eu-south-1", + "UseDualStack": false } }, { @@ -23116,9 +24938,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -23129,9 +24951,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -23142,9 +24964,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -23155,9 +24977,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -23168,9 +24990,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -23181,9 +25003,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -23194,9 +25016,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": true } }, { @@ -23207,9 +25029,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-central-1" + "Region": "me-central-1", + "UseDualStack": false } }, { @@ -23220,9 +25042,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -23233,9 +25055,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -23246,9 +25068,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -23259,9 +25081,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -23272,9 +25094,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -23285,9 +25107,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -23298,9 +25120,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -23311,9 +25133,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -23324,9 +25146,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -23337,9 +25159,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -23350,9 +25172,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -23363,9 +25185,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -23376,9 +25198,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -23389,9 +25211,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -23402,9 +25224,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -23415,9 +25237,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -23428,9 +25250,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -23441,9 +25263,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -23454,9 +25276,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -23467,9 +25289,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -23480,9 +25302,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -23493,9 +25315,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -23506,9 +25328,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -23519,9 +25341,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -23532,9 +25354,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -23545,9 +25367,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -23558,9 +25380,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -23571,9 +25393,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -23584,9 +25406,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -23597,9 +25419,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -23610,9 +25432,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -23623,9 +25445,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -23636,9 +25458,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -23649,9 +25471,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -23662,9 +25484,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -23675,9 +25497,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -23688,9 +25510,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -23701,9 +25523,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -23714,9 +25536,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": true } }, { @@ -23727,9 +25549,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-3" + "Region": "ap-northeast-3", + "UseDualStack": false } }, { @@ -23740,9 +25562,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -23753,9 +25575,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -23766,9 +25588,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -23779,9 +25601,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -23792,9 +25614,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -23805,9 +25627,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -23818,9 +25640,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -23831,9 +25653,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -23844,9 +25666,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -23857,9 +25679,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -23870,9 +25692,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -23883,9 +25705,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -23896,9 +25718,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -23909,9 +25731,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -23922,9 +25744,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -23935,9 +25757,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -23948,9 +25770,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -23961,9 +25783,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -23974,9 +25796,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -23987,9 +25809,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -24000,9 +25822,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -24013,9 +25835,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -24026,9 +25848,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -24039,9 +25861,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -24052,9 +25874,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -24065,9 +25887,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -24078,9 +25900,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -24091,9 +25913,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -24104,9 +25926,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -24117,9 +25939,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -24130,9 +25952,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -24143,9 +25965,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -24156,9 +25978,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -24169,9 +25991,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -24182,9 +26004,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -24195,9 +26017,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -24208,9 +26030,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -24221,9 +26043,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -24234,9 +26056,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": true } }, { @@ -24247,9 +26069,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-3" + "Region": "ap-southeast-3", + "UseDualStack": false } }, { @@ -24260,9 +26082,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -24273,9 +26095,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -24286,9 +26108,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -24299,9 +26121,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -24312,9 +26134,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -24325,9 +26147,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -24338,9 +26160,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -24351,9 +26173,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -24364,9 +26186,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -24377,9 +26199,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -24390,9 +26212,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -24403,9 +26225,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -24416,9 +26238,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -24428,9 +26250,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -24440,9 +26262,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/codegen/sdk-codegen/aws-models/securitylake.2018-05-10.json b/codegen/sdk-codegen/aws-models/securitylake.2018-05-10.json index 106f42f9562..cbf538dd323 100644 --- a/codegen/sdk-codegen/aws-models/securitylake.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/securitylake.2018-05-10.json @@ -4282,4 +4282,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/simspaceweaver.2022-10-28.json b/codegen/sdk-codegen/aws-models/simspaceweaver.2022-10-28.json index 0e775eb5a7b..038502925a1 100644 --- a/codegen/sdk-codegen/aws-models/simspaceweaver.2022-10-28.json +++ b/codegen/sdk-codegen/aws-models/simspaceweaver.2022-10-28.json @@ -2619,4 +2619,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/ssm-incidents.2018-05-10.json b/codegen/sdk-codegen/aws-models/ssm-incidents.2018-05-10.json index 354da0822fd..15fd48e074c 100644 --- a/codegen/sdk-codegen/aws-models/ssm-incidents.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/ssm-incidents.2018-05-10.json @@ -5860,4 +5860,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/ssm-sap.2018-05-10.json b/codegen/sdk-codegen/aws-models/ssm-sap.2018-05-10.json index cfe3a3e9132..6ee2d394680 100644 --- a/codegen/sdk-codegen/aws-models/ssm-sap.2018-05-10.json +++ b/codegen/sdk-codegen/aws-models/ssm-sap.2018-05-10.json @@ -2581,4 +2581,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/support-app.2021-08-20.json b/codegen/sdk-codegen/aws-models/support-app.2021-08-20.json index 82c2149db89..58c9baf1bd3 100644 --- a/codegen/sdk-codegen/aws-models/support-app.2021-08-20.json +++ b/codegen/sdk-codegen/aws-models/support-app.2021-08-20.json @@ -1514,4 +1514,4 @@ } } } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json b/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json index ae8acd625c4..dc75131b695 100644 --- a/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json +++ b/codegen/sdk-codegen/aws-models/transcribe.2017-10-26.json @@ -58,7 +58,7 @@ } }, "traits": { - "smithy.api#documentation": "

A time range, in milliseconds, between two points in your media file.

\n

You can use StartTime and EndTime to search a custom\n segment. For example, setting StartTime to 10000 and EndTime\n to 50000 only searches for your specified criteria in the audio contained between the\n 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use\n StartTime and EndTime as a set; that is, if you include\n one, you must include both.

\n

You can use also First to search from the start of the audio until the\n time that you specify, or Last to search from the time that you specify\n until the end of the audio. For example, setting First to 50000 only\n searches for your specified criteria in the audio contained between the start of the\n media file to the 50,000 millisecond mark. You can use First and\n Last independently of each other.

\n

If you prefer to use percentage instead of milliseconds, see .

" + "smithy.api#documentation": "

A time range, in milliseconds, between two points in your media file.

\n

You can use StartTime and EndTime to search a custom\n segment. For example, setting StartTime to 10000 and EndTime\n to 50000 only searches for your specified criteria in the audio contained between the\n 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use\n StartTime and EndTime as a set; that is, if you include\n one, you must include both.

\n

You can use also First to search from the start of the audio until the\n time that you specify, or Last to search from the time that you specify\n until the end of the audio. For example, setting First to 50000 only\n searches for your specified criteria in the audio contained between the start of the\n media file to the 50,000 millisecond mark. You can use First and\n Last independently of each other.

\n

If you prefer to use percentage instead of milliseconds, see .

" } }, "com.amazonaws.transcribe#BadRequestException": { @@ -153,13 +153,13 @@ "CallAnalyticsJobStatus": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "

Provides the status of the specified Call Analytics job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.

" + "smithy.api#documentation": "

Provides the status of the specified Call Analytics job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code used to create your Call Analytics job. For a list of supported\n languages and their associated language codes, refer to the Supported languages\n table.

\n

If you don't know the language spoken in your media file, you can omit this field and\n let Amazon Transcribe automatically identify the language of your media. To improve the\n accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

" + "smithy.api#documentation": "

The language code used to create your Call Analytics job. For a list of supported\n languages and their associated language codes, refer to the Supported languages\n table.

\n

If you don't know the language spoken in your media file, you can omit this field and\n let Amazon Transcribe automatically identify the language of your media. To improve the\n accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

" } }, "MediaSampleRateHertz": { @@ -186,25 +186,25 @@ "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified Call Analytics job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified Call Analytics job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified Call Analytics job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If CallAnalyticsJobStatus is FAILED,\n FailureReason contains information about why the Call Analytics job\n request failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media\n format.

    \n

    The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample\n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
" + "smithy.api#documentation": "

If CallAnalyticsJobStatus is FAILED,\n FailureReason contains information about why the Call Analytics job\n request failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media\n format.

    \n

    The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample\n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
" } }, "DataAccessRoleArn": { @@ -216,7 +216,7 @@ "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

The confidence score associated with the language identified in your media\n file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.

" + "smithy.api#documentation": "

The confidence score associated with the language identified in your media\n file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.

" } }, "Settings": { @@ -233,7 +233,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides detailed information about a Call Analytics job.

\n

To view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.

\n

If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.

\n

If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in the RedactedMediaFileUri field of your\n response.

" + "smithy.api#documentation": "

Provides detailed information about a Call Analytics job.

\n

To view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.

\n

If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.

\n

If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in the RedactedMediaFileUri field of your\n response.

" } }, "com.amazonaws.transcribe#CallAnalyticsJobName": { @@ -258,19 +258,19 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary filter you want to include in your Call Analytics\n transcription request. Custom vocabulary filter names are case sensitive.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to include in your Call Analytics\n transcription request. Custom vocabulary filter names are case sensitive.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribe#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "

Specify how you want your custom vocabulary filter applied to your transcript.

\n

To replace words with ***, choose mask.

\n

To delete words, choose remove.

\n

To flag words without changing them, choose tag.

" + "smithy.api#documentation": "

Specify how you want your custom vocabulary filter applied to your transcript.

\n

To replace words with ***, choose mask.

\n

To delete words, choose remove.

\n

To flag words without changing them, choose tag.

" } }, "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model you want to use when processing your Call\n Analytics job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your Call\n Analytics job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" } }, "ContentRedaction": { @@ -279,13 +279,13 @@ "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.

\n

Including language options can improve the accuracy of language identification.

\n

For a list of languages supported with Call Analytics, refer to the Supported\n languages table.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.

" + "smithy.api#documentation": "

You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.

\n

Including language options can improve the accuracy of language identification.

\n

For a list of languages supported with Call Analytics, refer to the Supported\n languages table.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.

" } }, "LanguageIdSettings": { "target": "com.amazonaws.transcribe#LanguageIdSettingsMap", "traits": { - "smithy.api#documentation": "

If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName).

\n

\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.

\n

It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.

\n

If you want to include a custom language model, custom vocabulary, or custom\n vocabulary filter with your request but do not want to\n use automatic language identification, use instead the parameter with the\n LanguageModelName, VocabularyName, or\n VocabularyFilterName sub-parameters.

\n

For a list of languages supported with Call Analytics, refer to Supported languages and \n language-specific features.

" + "smithy.api#documentation": "

If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName).

\n

\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.

\n

It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.

\n

If you want to include a custom language model, custom vocabulary, or custom\n vocabulary filter with your request but do not want to\n use automatic language identification, use instead the parameter with the\n LanguageModelName, VocabularyName, or\n VocabularyFilterName sub-parameters.

\n

For a list of languages supported with Call Analytics, refer to Supported languages and \n language-specific features.

" } } }, @@ -340,19 +340,19 @@ "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified Call Analytics job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time your Call Analytics job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time your Call Analytics job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified Call Analytics job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "LanguageCode": { @@ -364,7 +364,7 @@ "CallAnalyticsJobStatus": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "

Provides the status of your Call Analytics job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.

" + "smithy.api#documentation": "

Provides the status of your Call Analytics job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.

" } }, "FailureReason": { @@ -406,13 +406,13 @@ "CreateTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified Call Analytics category was created.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics category was created.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "LastUpdateTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified Call Analytics category was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May\n 5, 2022.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics category was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May\n 5, 2022.

" } }, "InputType": { @@ -501,7 +501,7 @@ "RedactionOutput": { "target": "com.amazonaws.transcribe#RedactionOutput", "traits": { - "smithy.api#documentation": "

Specify if you want only a redacted transcript, or if you want a redacted and an\n unredacted transcript.

\n

When you choose redacted\n Amazon Transcribe creates only a redacted transcript.

\n

When you choose redacted_and_unredacted\n Amazon Transcribe creates a redacted and an unredacted transcript (as two separate\n files).

", + "smithy.api#documentation": "

Specify if you want only a redacted transcript, or if you want a redacted and an\n unredacted transcript.

\n

When you choose redacted\n Amazon Transcribe creates only a redacted transcript.

\n

When you choose redacted_and_unredacted\n Amazon Transcribe creates a redacted and an unredacted transcript (as two separate\n files).

", "smithy.api#required": {} } }, @@ -539,7 +539,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Call Analytics category.

\n

All categories are automatically applied to your Call Analytics transcriptions. Note that in\n order to apply categories to your transcriptions, you must create them before submitting your\n transcription request, as categories cannot be applied retroactively.

\n

When creating a new category, you can use the InputType parameter to \n label the category as a batch category (POST_CALL) or a streaming category \n (REAL_TIME). Batch categories can only be applied to batch transcriptions and \n streaming categories can only be applied to streaming transcriptions. If you do not include \n InputType, your category is created as a batch category by default.

\n

Call Analytics categories are composed of rules. For each category, you must create\n between 1 and 20 rules. Rules can include these parameters: , , , and .

\n

To update an existing category, see .

\n

To learn more about Call Analytics categories, see Creating categories for batch\n transcriptions and Creating categories for\n streaming transcriptions.

", + "smithy.api#documentation": "

Creates a new Call Analytics category.

\n

All categories are automatically applied to your Call Analytics transcriptions. Note that in\n order to apply categories to your transcriptions, you must create them before submitting your\n transcription request, as categories cannot be applied retroactively.

\n

When creating a new category, you can use the InputType parameter to \n label the category as a batch category (POST_CALL) or a streaming category \n (REAL_TIME). Batch categories can only be applied to batch transcriptions and \n streaming categories can only be applied to streaming transcriptions. If you do not include \n InputType, your category is created as a batch category by default.

\n

Call Analytics categories are composed of rules. For each category, you must create\n between 1 and 20 rules. Rules can include these parameters: , , , and .

\n

To update an existing category, see .

\n

To learn more about Call Analytics categories, see Creating categories for batch\n transcriptions and Creating categories for\n streaming transcriptions.

", "smithy.api#http": { "method": "PUT", "uri": "/callanalyticscategories/{CategoryName}", @@ -553,7 +553,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your Call Analytics category. It's helpful to use a\n detailed naming system that will make sense to you in the future. For example, it's\n better to use sentiment-positive-last30seconds for a category over a\n generic name like test-category.

\n

Category names are case sensitive.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your Call Analytics category. It's helpful to use a\n detailed naming system that will make sense to you in the future. For example, it's\n better to use sentiment-positive-last30seconds for a category over a\n generic name like test-category.

\n

Category names are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -568,7 +568,7 @@ "InputType": { "target": "com.amazonaws.transcribe#InputType", "traits": { - "smithy.api#documentation": "

Choose whether you want to create a streaming or a batch category for your Call Analytics \n transcription.

\n

Specifying POST_CALL assigns your category to batch transcriptions; \n categories with this input type cannot be applied to streaming (real-time) \n transcriptions.

\n

Specifying REAL_TIME assigns your category to streaming transcriptions; \n categories with this input type cannot be applied to batch (post-call)\n transcriptions.

\n

If you do not include InputType, your category is created as a batch \n category by default.

" + "smithy.api#documentation": "

Choose whether you want to create a streaming or a batch category for your Call Analytics \n transcription.

\n

Specifying POST_CALL assigns your category to batch transcriptions; \n categories with this input type cannot be applied to streaming (real-time) \n transcriptions.

\n

Specifying REAL_TIME assigns your category to streaming transcriptions; \n categories with this input type cannot be applied to batch (post-call)\n transcriptions.

\n

If you do not include InputType, your category is created as a batch \n category by default.

" } } } @@ -607,7 +607,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom language model.

\n

When creating a new custom language model, you must specify:

\n
    \n
  • \n

    If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband\n (audio sample rates under 16,000 Hz) base model

    \n
    • \n
  • \n

    The location of your training and tuning files (this must be an Amazon S3 URI)

    \n
    • \n
  • \n

    The language of your model

    \n
    • \n
  • \n

    A unique name for your model

    \n
    • \n
", + "smithy.api#documentation": "

Creates a new custom language model.

\n

When creating a new custom language model, you must specify:

\n
    \n
  • \n

    If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband\n (audio sample rates under 16,000 Hz) base model

    \n
    • \n
  • \n

    The location of your training and tuning files (this must be an Amazon S3 URI)

    \n
    • \n
  • \n

    The language of your model

    \n
    • \n
  • \n

    A unique name for your model

    \n
    • \n
", "smithy.api#http": { "method": "PUT", "uri": "/languagemodels/{ModelName}", @@ -621,21 +621,21 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language of your model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that\n US English\n (en-US) is the only language supported with Amazon Transcribe\n Medical.

\n

A custom language model can only be used to transcribe files in the same language as\n the model. For example, if you create a custom language model using US English\n (en-US), you can only apply this model to files that contain English\n audio.

", + "smithy.api#documentation": "

The language code that represents the language of your model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that\n US English\n (en-US) is the only language supported with Amazon Transcribe\n Medical.

\n

A custom language model can only be used to transcribe files in the same language as\n the model. For example, if you create a custom language model using US English\n (en-US), you can only apply this model to files that contain English\n audio.

", "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\n custom language model. Amazon Transcribe offers two options for base models: Wideband\n and Narrowband.

\n

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose\n WideBand. To transcribe audio with a sample rate less than 16,000 Hz,\n 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\n and Narrowband.

\n

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose\n WideBand. To transcribe audio with a sample rate less than 16,000 Hz,\n choose NarrowBand.

", "smithy.api#required": {} } }, "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your 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 new custom language model with\n the same name as an existing custom language model, you get a\n ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your 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 new custom language model with\n the same name as an existing custom language model, you get a\n ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -643,14 +643,14 @@ "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

Contains the Amazon S3 location of the training data you want to use to create\n a new custom language model, and permissions to access this location.

\n

When using InputDataConfig, you must include these sub-parameters:\n S3Uri, which is the Amazon S3 location of your training data,\n and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role\n that has permission to access your specified Amazon S3 location. You can\n optionally include TuningDataS3Uri, which is the Amazon S3 location\n of your tuning data. If you specify different Amazon S3 locations for training\n and tuning data, the ARN you use must have permissions to access both locations.

", + "smithy.api#documentation": "

Contains the Amazon S3 location of the training data you want to use to create\n a new custom language model, and permissions to access this location.

\n

When using InputDataConfig, you must include these sub-parameters:\n S3Uri, which is the Amazon S3 location of your training data,\n and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role\n that has permission to access your specified Amazon S3 location. You can\n optionally include TuningDataS3Uri, which is the Amazon S3 location\n of your tuning data. If you specify different Amazon S3 locations for training\n and tuning data, the ARN you use must have permissions to access both locations.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n language model at the time you create this new model.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n language model at the time you create this new model.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" } } } @@ -713,7 +713,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom medical vocabulary.

\n

Before creating a new custom medical vocabulary, you must first upload a text file\n that contains your new entries, phrases, and terms into an Amazon S3 bucket.\n Note that this differs from , where you can\n include a list of terms within your request using the Phrases flag;\n CreateMedicalVocabulary does not support the Phrases\n flag.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary request\n fails. Refer to Character Sets for Custom Vocabularies to get the character set for your\n language.

\n

For more information, see Custom\n vocabularies.

", + "smithy.api#documentation": "

Creates a new custom medical vocabulary.

\n

Before creating a new custom medical vocabulary, you must first upload a text file\n that contains your new entries, phrases, and terms into an Amazon S3 bucket.\n Note that this differs from , where you can\n include a list of terms within your request using the Phrases flag;\n CreateMedicalVocabulary does not support the Phrases\n flag.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary request\n fails. Refer to Character Sets for Custom Vocabularies to get the character set for your\n language.

\n

For more information, see Custom\n vocabularies.

", "smithy.api#http": { "method": "PUT", "uri": "/medicalvocabularies/{VocabularyName}", @@ -727,7 +727,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your new custom medical 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 new custom medical vocabulary\n with the same name as an existing custom medical vocabulary, you get a\n ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your new custom medical 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 new custom medical vocabulary\n with the same name as an existing custom medical vocabulary, you get a\n ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -742,14 +742,14 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location (URI) of the text file that contains your custom\n medical vocabulary. The URI must be in the same Amazon Web Services Region as the\n resource you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

", + "smithy.api#documentation": "

The Amazon S3 location (URI) of the text file that contains your custom\n medical vocabulary. The URI must be in the same Amazon Web Services Region as the\n resource you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n medical vocabulary at the time you create this new custom vocabulary.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n medical vocabulary at the time you create this new custom vocabulary.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" } } } @@ -778,7 +778,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time you created your custom medical vocabulary.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time you created your custom medical vocabulary.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "FailureReason": { @@ -812,7 +812,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom vocabulary.

\n

When creating a new custom vocabulary, you can either upload a text file that contains\n your new entries, phrases, and terms into an Amazon S3 bucket and include the\n URI in your request. Or you can include a list of terms directly in your request using\n the Phrases flag.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary request\n fails. Refer to Character Sets for Custom Vocabularies to get the character set for your\n language.

\n

For more information, see Custom\n vocabularies.

", + "smithy.api#documentation": "

Creates a new custom vocabulary.

\n

When creating a new custom vocabulary, you can either upload a text file that contains\n your new entries, phrases, and terms into an Amazon S3 bucket and include the\n URI in your request. Or you can include a list of terms directly in your request using\n the Phrases flag.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary request\n fails. Refer to Character Sets for Custom Vocabularies to get the character set for your\n language.

\n

For more information, see Custom\n vocabularies.

", "smithy.api#http": { "method": "PUT", "uri": "/vocabularies/{VocabularyName}", @@ -843,7 +843,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom vocabulary filter.

\n

You can use custom vocabulary filters to mask, delete, or flag specific words from\n your transcript. Custom vocabulary filters are commonly used to mask profanity in\n transcripts.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

\n

For more information, see Vocabulary\n filtering.

", + "smithy.api#documentation": "

Creates a new custom vocabulary filter.

\n

You can use custom vocabulary filters to mask, delete, or flag specific words from\n your transcript. Custom vocabulary filters are commonly used to mask profanity in\n transcripts.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

\n

For more information, see Vocabulary\n filtering.

", "smithy.api#http": { "method": "POST", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -857,7 +857,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your new custom 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 new custom vocabulary filter with\n the same name as an existing custom vocabulary filter, you get a\n ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your new custom 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 new custom vocabulary filter with\n the same name as an existing custom vocabulary filter, you get a\n ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -865,26 +865,26 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language of the entries in your vocabulary\n filter. Each custom vocabulary filter must contain terms in only one language.

\n

A custom vocabulary filter can only be used to transcribe files in the same language\n as the filter. For example, if you create a custom vocabulary filter using US English\n (en-US), you can only apply this filter to files that contain English\n audio.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

", + "smithy.api#documentation": "

The language code that represents the language of the entries in your vocabulary\n filter. Each custom vocabulary filter must contain terms in only one language.

\n

A custom vocabulary filter can only be used to transcribe files in the same language\n as the filter. For example, if you create a custom vocabulary filter using US English\n (en-US), you can only apply this filter to files that contain English\n audio.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

", "smithy.api#required": {} } }, "Words": { "target": "com.amazonaws.transcribe#Words", "traits": { - "smithy.api#documentation": "

Use this parameter if you want to create your custom vocabulary filter by including\n all desired terms, as comma-separated values, within your request. The other option for\n creating your vocabulary filter is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFilterFileUri parameter.

\n

Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

" + "smithy.api#documentation": "

Use this parameter if you want to create your custom vocabulary filter by including\n all desired terms, as comma-separated values, within your request. The other option for\n creating your vocabulary filter is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFilterFileUri parameter.

\n

Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary\n filter terms. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n

\n

Note that if you include VocabularyFilterFileUri in your request, you\n cannot use Words; you must choose one or the other.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary\n filter terms. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n

\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 custom tags, each in the form of a key:value pair, to a new custom\n vocabulary filter at the time you create this new vocabulary filter.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n vocabulary filter at the time you create this new vocabulary filter.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" } } } @@ -907,7 +907,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time you created your custom vocabulary filter.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time you created your custom vocabulary filter.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } } } @@ -918,7 +918,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your new custom 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 new custom vocabulary with the\n same name as an existing custom vocabulary, you get a ConflictException\n error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your new custom 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 new custom vocabulary with the\n same name as an existing custom vocabulary, you get a ConflictException\n error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -926,26 +926,26 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language of the entries in your custom\n vocabulary. Each custom vocabulary must contain terms in only one language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

", + "smithy.api#documentation": "

The language code that represents the language of the entries in your custom\n vocabulary. Each custom vocabulary must contain terms in only one language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

", "smithy.api#required": {} } }, "Phrases": { "target": "com.amazonaws.transcribe#Phrases", "traits": { - "smithy.api#documentation": "

Use this parameter if you want to create your custom vocabulary by including all\n desired terms, as comma-separated values, within your request. The other option for\n creating your custom vocabulary is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFileUri parameter.

\n

Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

" + "smithy.api#documentation": "

Use this parameter if you want to create your custom vocabulary by including all\n desired terms, as comma-separated values, within your request. The other option for\n creating your custom vocabulary is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFileUri parameter.

\n

Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

" } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary.\n The URI must be located in the same Amazon Web Services Region as the resource you're\n calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

\n

Note that if you include VocabularyFileUri in your request, you cannot\n use the Phrases flag; you must choose one or the other.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary.\n The URI must be located in the same Amazon Web Services Region as the resource you're\n calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

\n

Note that if you include VocabularyFileUri in your request, you cannot\n 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 custom tags, each in the form of a key:value pair, to a new custom\n vocabulary at the time you create this new custom vocabulary.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n vocabulary at the time you create this new custom vocabulary.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" } } } @@ -974,7 +974,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time you created your custom vocabulary.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time you created your custom vocabulary.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "FailureReason": { @@ -1369,7 +1369,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the specified custom language model.

\n

This operation also shows if the base language model that you used to create your\n custom language model has been updated. If Amazon Transcribe has updated the base\n model, you can create a 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 DescribeLanguageModel to help identify the reason for this\n failure.

", + "smithy.api#documentation": "

Provides information about the specified custom language model.

\n

This operation also shows if the base language model that you used to create your\n custom language model has been updated. If Amazon Transcribe has updated the base\n model, you can create a 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 DescribeLanguageModel to help identify the reason for this\n failure.

", "smithy.api#http": { "method": "GET", "uri": "/languagemodels/{ModelName}", @@ -1396,7 +1396,7 @@ "LanguageModel": { "target": "com.amazonaws.transcribe#LanguageModel", "traits": { - "smithy.api#documentation": "

Provides information about the specified custom language\n model.

\n

This parameter 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\n can create a 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 DescribeLanguageModel to help identify the reason for this\n failure.

" + "smithy.api#documentation": "

Provides information about the specified custom language\n model.

\n

This parameter 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\n can create a 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 DescribeLanguageModel to help identify the reason for this\n failure.

" } } } @@ -1430,7 +1430,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the specified Call Analytics category.

\n

To get a list of your Call Analytics categories, use the operation.

", + "smithy.api#documentation": "

Provides information about the specified Call Analytics category.

\n

To get a list of your Call Analytics categories, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticscategories/{CategoryName}", @@ -1485,7 +1485,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the specified Call Analytics job.

\n

To view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.

\n

If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.

\n

If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in RedactedMediaFileUri.

\n

To get a list of your Call Analytics jobs, use the operation.

", + "smithy.api#documentation": "

Provides information about the specified Call Analytics job.

\n

To view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.

\n

If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.

\n

If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in RedactedMediaFileUri.

\n

To get a list of your Call Analytics jobs, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -1540,7 +1540,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the specified medical transcription job.

\n

To view the status of the specified medical transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.

\n

To get a list of your medical transcription jobs, use the operation.

", + "smithy.api#documentation": "

Provides information about the specified medical transcription job.

\n

To view the status of the specified medical transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.

\n

To get a list of your medical transcription jobs, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -1595,7 +1595,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the specified custom medical vocabulary.

\n

To view the status of the specified custom medical vocabulary, check the\n VocabularyState field. If the status is READY, your custom\n vocabulary is available to use. If the status is FAILED,\n FailureReason provides details on why your vocabulary failed.

\n

To get a list of your custom medical vocabularies, use the operation.

", + "smithy.api#documentation": "

Provides information about the specified custom medical vocabulary.

\n

To view the status of the specified custom medical vocabulary, check the\n VocabularyState field. If the status is READY, your custom\n vocabulary is available to use. If the status is FAILED,\n FailureReason provides details on why your vocabulary failed.

\n

To get a list of your custom medical vocabularies, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/medicalvocabularies/{VocabularyName}", @@ -1640,7 +1640,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom medical vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom medical vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "FailureReason": { @@ -1680,7 +1680,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the specified transcription job.

\n

To view the status of the specified transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.

\n

If you enabled content redaction, the redacted transcript can be found at the location\n specified in RedactedTranscriptFileUri.

\n

To get a list of your transcription jobs, use the operation.

", + "smithy.api#documentation": "

Provides information about the specified transcription job.

\n

To view the status of the specified transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.

\n

If you enabled content redaction, the redacted transcript can be found at the location\n specified in RedactedTranscriptFileUri.

\n

To get a list of your transcription jobs, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -1735,7 +1735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the specified custom vocabulary.

\n

To view the status of the specified custom vocabulary, check the\n VocabularyState field. If the status is READY, your custom\n vocabulary is available to use. If the status is FAILED,\n FailureReason provides details on why your custom vocabulary\n failed.

\n

To get a list of your custom vocabularies, use the operation.

", + "smithy.api#documentation": "

Provides information about the specified custom vocabulary.

\n

To view the status of the specified custom vocabulary, check the\n VocabularyState field. If the status is READY, your custom\n vocabulary is available to use. If the status is FAILED,\n FailureReason provides details on why your custom vocabulary\n failed.

\n

To get a list of your custom vocabularies, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularies/{VocabularyName}", @@ -1766,7 +1766,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the specified custom vocabulary filter.

\n

To get a list of your custom vocabulary filters, use the operation.

", + "smithy.api#documentation": "

Provides information about the specified custom vocabulary filter.

\n

To get a list of your custom vocabulary filters, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -1805,7 +1805,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom vocabulary filter was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom vocabulary filter was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "DownloadUri": { @@ -1853,7 +1853,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "FailureReason": { @@ -1879,26 +1879,26 @@ "S3Uri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location (URI) of the text files you want to use to train your\n custom language model.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-model-training-data/\n

", + "smithy.api#documentation": "

The Amazon S3 location (URI) of the text files you want to use to train your\n custom language model.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-model-training-data/\n

", "smithy.api#required": {} } }, "TuningDataS3Uri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location (URI) of the text files you want to use to tune your\n custom language model.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/\n

" + "smithy.api#documentation": "

The Amazon S3 location (URI) of the text files you want to use to tune your\n custom language model.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/\n

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM\n ARNs.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM\n ARNs.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains the Amazon S3 location of the training data you want to use to create\n a new custom language model, and permissions to access this location.

\n

When using InputDataConfig, you must include these sub-parameters:\n S3Uri and DataAccessRoleArn. You can optionally include\n TuningDataS3Uri.

" + "smithy.api#documentation": "

Contains the Amazon S3 location of the training data you want to use to create\n a new custom language model, and permissions to access this location.

\n

When using InputDataConfig, you must include these sub-parameters:\n S3Uri and DataAccessRoleArn. You can optionally include\n TuningDataS3Uri.

" } }, "com.amazonaws.transcribe#InputType": { @@ -1966,7 +1966,7 @@ } }, "traits": { - "smithy.api#documentation": "

Flag the presence or absence of interruptions in your Call Analytics transcription\n output.

\n

Rules using InterruptionFilter are designed to match:

\n
    \n
  • \n

    Instances where an agent interrupts a customer

    \n
    • \n
  • \n

    Instances where a customer interrupts an agent

    \n
    • \n
  • \n

    Either participant interrupting the other

    \n
    • \n
  • \n

    A lack of interruptions

    \n
    • \n
\n

See Rule criteria for batch \n categories for usage examples.

" + "smithy.api#documentation": "

Flag the presence or absence of interruptions in your Call Analytics transcription\n output.

\n

Rules using InterruptionFilter are designed to match:

\n
    \n
  • \n

    Instances where an agent interrupts a customer

    \n
    • \n
  • \n

    Instances where a customer interrupts an agent

    \n
    • \n
  • \n

    Either participant interrupting the other

    \n
    • \n
  • \n

    A lack of interruptions

    \n
    • \n
\n

See Rule criteria for batch \n categories for usage examples.

" } }, "com.amazonaws.transcribe#JobExecutionSettings": { @@ -1975,18 +1975,18 @@ "AllowDeferredExecution": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Makes it possible to enable job queuing when your concurrent request limit is\n exceeded. When AllowDeferredExecution is set to true,\n transcription job requests are placed in a queue until the number of jobs falls below\n the concurrent request limit. If AllowDeferredExecution is set to\n false and the number of transcription job requests exceed the\n concurrent request limit, you get a LimitExceededException error.

\n

Note that job queuing is enabled by default for Call Analytics jobs.

\n

If you include AllowDeferredExecution in your request, you must also\n include DataAccessRoleArn.

" + "smithy.api#documentation": "

Makes it possible to enable job queuing when your concurrent request limit is\n exceeded. When AllowDeferredExecution is set to true,\n transcription job requests are placed in a queue until the number of jobs falls below\n the concurrent request limit. If AllowDeferredExecution is set to\n false and the number of transcription job requests exceed the\n concurrent request limit, you get a LimitExceededException error.

\n

Note that job queuing is enabled by default for Call Analytics jobs.

\n

If you include AllowDeferredExecution in your request, you must also\n include DataAccessRoleArn.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 \n location, your request fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin. For more information, see IAM\n ARNs.

\n

Note that if you include DataAccessRoleArn in your request, you must also\n include AllowDeferredExecution.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 \n location, your request fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin. For more information, see IAM\n ARNs.

\n

Note that if you include DataAccessRoleArn in your request, you must also\n include AllowDeferredExecution.

" } } }, "traits": { - "smithy.api#documentation": "

Makes it possible to control how your transcription job is processed. Currently, the\n only JobExecutionSettings modification you can choose is enabling job\n queueing using the AllowDeferredExecution sub-parameter.

\n

If you include JobExecutionSettings in your request, you must also\n include the sub-parameters: AllowDeferredExecution and\n DataAccessRoleArn.

" + "smithy.api#documentation": "

Makes it possible to control how your transcription job is processed. Currently, the\n only JobExecutionSettings modification you can choose is enabling job\n queueing using the AllowDeferredExecution sub-parameter.

\n

If you include JobExecutionSettings in your request, you must also\n include the sub-parameters: AllowDeferredExecution and\n DataAccessRoleArn.

" } }, "com.amazonaws.transcribe#KMSEncryptionContextMap": { @@ -2238,6 +2238,18 @@ "traits": { "smithy.api#enumValue": "en-NZ" } + }, + "VI_VN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vi-VN" + } + }, + "SV_SE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sv-SE" + } } } }, @@ -2273,24 +2285,24 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your transcription\n job. Custom vocabulary names are case sensitive.

\n

The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch.

" + "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your transcription\n job. Custom vocabulary names are case sensitive.

\n

The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch.

" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary filter you want to use when processing your\n transcription job. Custom vocabulary filter names are case sensitive.

\n

The language of the specified custom vocabulary filter must match the language code\n that you specify in your transcription request. If the languages don't match, the custom\n vocabulary filter isn't applied. There are no errors or warnings associated with a\n language mismatch.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to use when processing your\n transcription job. Custom vocabulary filter names are case sensitive.

\n

The language of the specified custom vocabulary filter must match the language code\n that you specify in your transcription request. If the languages don't match, the custom\n vocabulary filter isn't applied. There are no errors or warnings associated with a\n language mismatch.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" } }, "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" } } }, "traits": { - "smithy.api#documentation": "

If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). Note that multi-language identification\n (IdentifyMultipleLanguages) doesn't support custom language\n models.

\n

\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.

\n

It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.

\n

If you want to include a custom language model with your request but do not want to use automatic language identification, use\n instead the parameter with the\n LanguageModelName sub-parameter. If you want to include a custom\n vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use\n instead the parameter with the\n VocabularyName or VocabularyFilterName (or both)\n sub-parameter.

" + "smithy.api#documentation": "

If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). Note that multi-language identification\n (IdentifyMultipleLanguages) doesn't support custom language\n models.

\n

\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.

\n

It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.

\n

If you want to include a custom language model with your request but do not want to use automatic language identification, use\n instead the parameter with the\n LanguageModelName sub-parameter. If you want to include a custom\n vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use\n instead the parameter with the\n VocabularyName or VocabularyFilterName (or both)\n sub-parameter.

" } }, "com.amazonaws.transcribe#LanguageIdSettingsMap": { @@ -2314,25 +2326,25 @@ "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your custom language model.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account.

" + "smithy.api#documentation": "

A unique name, chosen by you, for your custom language model.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account.

" } }, "CreateTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom language model was created.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom language model was created.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom language model was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom language model was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

The language code used to create your custom language model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that U.S. English (en-US) is\n the only language supported with Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The language code used to create your custom language model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that U.S. English (en-US) is\n the only language supported with Amazon Transcribe Medical.

" } }, "BaseModelName": { @@ -2350,7 +2362,7 @@ "UpgradeAvailability": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Shows if a more current base model is available for use with the specified custom\n language model.

\n

If false, your custom language model is using the most up-to-date base\n model.

\n

If true, there is a newer base model available than the one your language\n model is using.

\n

Note that to update a base model, you must recreate the custom language model using\n the new base model. Base model upgrades for existing custom language models are not\n supported.

" + "smithy.api#documentation": "

Shows if a more current base model is available for use with the specified custom\n language model.

\n

If false, your custom language model is using the most up-to-date base\n model.

\n

If true, there is a newer base model available than the one your language\n model is using.

\n

Note that to update a base model, you must recreate the custom language model using\n the new base model. Base model upgrades for existing custom language models are not\n supported.

" } }, "FailureReason": { @@ -2414,7 +2426,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of Call Analytics categories, including all rules that make up each\n category.

\n

To get detailed information about a specific Call Analytics category, use the operation.

", + "smithy.api#documentation": "

Provides a list of Call Analytics categories, including all rules that make up each\n category.

\n

To get detailed information about a specific Call Analytics category, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticscategories", @@ -2483,7 +2495,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of Call Analytics jobs that match the specified criteria. If no\n criteria are specified, all Call Analytics jobs are returned.

\n

To get detailed information about a specific Call Analytics job, use the operation.

", + "smithy.api#documentation": "

Provides a list of Call Analytics jobs that match the specified criteria. If no\n criteria are specified, all Call Analytics jobs are returned.

\n

To get detailed information about a specific Call Analytics job, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticsjobs", @@ -2572,7 +2584,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of custom language models that match the specified criteria. If no\n criteria are specified, all custom language models are returned.

\n

To get detailed information about a specific custom language model, use the operation.

", + "smithy.api#documentation": "

Provides a list of custom language models that match the specified criteria. If no\n criteria are specified, all custom language models are returned.

\n

To get detailed information about a specific custom language model, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/languagemodels", @@ -2655,7 +2667,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of medical transcription jobs that match the specified criteria. If no\n criteria are specified, all medical transcription jobs are returned.

\n

To get detailed information about a specific medical transcription job, use the operation.

", + "smithy.api#documentation": "

Provides a list of medical transcription jobs that match the specified criteria. If no\n criteria are specified, all medical transcription jobs are returned.

\n

To get detailed information about a specific medical transcription job, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs", @@ -2744,7 +2756,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of custom medical vocabularies that match the specified criteria. If\n no criteria are specified, all custom medical vocabularies are returned.

\n

To get detailed information about a specific custom medical vocabulary, use the operation.

", + "smithy.api#documentation": "

Provides a list of custom medical vocabularies that match the specified criteria. If\n no criteria are specified, all custom medical vocabularies are returned.

\n

To get detailed information about a specific custom medical vocabulary, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/medicalvocabularies", @@ -2836,7 +2848,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags associated with the specified transcription job, vocabulary, model, or\n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

", + "smithy.api#documentation": "

Lists all tags associated with the specified transcription job, vocabulary, model, or\n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -2850,7 +2862,7 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "

Returns a list of all tags associated with the specified Amazon Resource Name (ARN).\n ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.

", + "smithy.api#documentation": "

Returns a list of all tags associated with the specified Amazon Resource Name (ARN).\n ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2894,7 +2906,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of transcription jobs that match the specified criteria. If no\n criteria are specified, all transcription jobs are returned.

\n

To get detailed information about a specific transcription job, use the operation.

", + "smithy.api#documentation": "

Provides a list of transcription jobs that match the specified criteria. If no\n criteria are specified, all transcription jobs are returned.

\n

To get detailed information about a specific transcription job, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/transcriptionjobs", @@ -2983,7 +2995,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of custom vocabularies that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.

\n

To get detailed information about a specific custom vocabulary, use the operation.

", + "smithy.api#documentation": "

Provides a list of custom vocabularies that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.

\n

To get detailed information about a specific custom vocabulary, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularies", @@ -3072,7 +3084,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of custom vocabulary filters that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.

\n

To get detailed information about a specific custom vocabulary filter, use the operation.

", + "smithy.api#documentation": "

Provides a list of custom vocabulary filters that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.

\n

To get detailed information about a specific custom vocabulary filter, use the operation.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularyFilters", @@ -3161,18 +3173,18 @@ "MediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the media file you want to transcribe. For\n example:

\n
    \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n

    \n
    • \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n

    \n
    • \n
\n

Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription\n request.

" + "smithy.api#documentation": "

The Amazon S3 location of the media file you want to transcribe. For\n example:

\n
    \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n

    \n
    • \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n

    \n
    • \n
\n

Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription\n request.

" } }, "RedactedMediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the media file you want to redact. For\n example:

\n
    \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n

    \n
    • \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n

    \n
    • \n
\n

Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription\n request.

\n \n

\n RedactedMediaFileUri produces a redacted audio file in addition to a \n redacted transcript. It is only supported for Call Analytics\n (StartCallAnalyticsJob) transcription requests.

\n " + "smithy.api#documentation": "

The Amazon S3 location of the media file you want to redact. For\n example:

\n
    \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n

    \n
    • \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n

    \n
    • \n
\n

Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription\n request.

\n \n

\n RedactedMediaFileUri produces a redacted audio file in addition to a \n redacted transcript. It is only supported for Call Analytics\n (StartCallAnalyticsJob) transcription requests.

\n " } } }, "traits": { - "smithy.api#documentation": "

Describes the Amazon S3 location of the media file you want to use in your\n request.

\n

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section \n in the Amazon S3 Developer Guide.

" + "smithy.api#documentation": "

Describes the Amazon S3 location of the media file you want to use in your\n request.

\n

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section \n in the Amazon S3 Developer Guide.

" } }, "com.amazonaws.transcribe#MediaFormat": { @@ -3257,7 +3269,7 @@ "TranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or\n download your transcript.

\n

Note that this is the Amazon S3 location you specified in your request using the \n OutputBucketName parameter.

" + "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or\n download your transcript.

\n

Note that this is the Amazon S3 location you specified in your request using the \n OutputBucketName parameter.

" } } }, @@ -3277,7 +3289,7 @@ "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

Provides the status of the specified medical transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.

" + "smithy.api#documentation": "

Provides the status of the specified medical transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.

" } }, "LanguageCode": { @@ -3310,25 +3322,25 @@ "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified medical transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified medical transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified medical transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media\n format.

    \n

    The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 16,000 and 48,000 hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample\n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
" + "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media\n format.

    \n

    The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 16,000 and 48,000 hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample\n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
" } }, "Settings": { @@ -3363,7 +3375,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides detailed information about a medical transcription job.

\n

To view the status of the specified medical transcription 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\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.

" + "smithy.api#documentation": "

Provides detailed information about a medical transcription job.

\n

To view the status of the specified medical transcription 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\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.

" } }, "com.amazonaws.transcribe#MedicalTranscriptionJobSummaries": { @@ -3384,19 +3396,19 @@ "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified medical transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time your medical transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time your medical transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified medical transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "LanguageCode": { @@ -3408,7 +3420,7 @@ "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

Provides the status of your medical transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.

" + "smithy.api#documentation": "

Provides the status of your medical transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.

" } }, "FailureReason": { @@ -3420,7 +3432,7 @@ "OutputLocationType": { "target": "com.amazonaws.transcribe#OutputLocationType", "traits": { - "smithy.api#documentation": "

Indicates where the specified medical transcription output is stored.

\n

If the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your request. If you also included\n OutputKey in your request, your output is located in the path you\n specified in your request.

\n

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the\n URI shown in the TranscriptFileUri field.

" + "smithy.api#documentation": "

Indicates where the specified medical transcription output is stored.

\n

If the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your request. If you also included\n OutputKey in your request, your output is located in the path you\n specified in your request.

\n

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the\n URI shown in the TranscriptFileUri field.

" } }, "Specialty": { @@ -3452,37 +3464,37 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

You can't include ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Partitioning speakers\n (diarization).

" + "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

You can't include ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Partitioning speakers\n (diarization).

" } }, "MaxSpeakerLabels": { "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "

Specify the maximum number of speakers you want to partition in your media.

\n

Note that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.

\n

If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" + "smithy.api#documentation": "

Specify the maximum number of speakers you want to partition in your media.

\n

Note that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.

\n

If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" } }, "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Transcribing multi-channel\n audio.

" + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Transcribing multi-channel\n audio.

" } }, "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.

\n

If you include ShowAlternatives, you must also include\n MaxAlternatives, which is the maximum number of alternative\n transcriptions you want Amazon Transcribe Medical to generate.

\n

For more information, see Alternative\n transcriptions.

" + "smithy.api#documentation": "

To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.

\n

If you include ShowAlternatives, you must also include\n MaxAlternatives, which is the maximum number of alternative\n transcriptions you want Amazon Transcribe Medical to generate.

\n

For more information, see Alternative\n transcriptions.

" } }, "MaxAlternatives": { "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe\n Medical to include in your transcript.

\n

If you select a number greater than the number of alternative transcriptions generated\n by Amazon Transcribe Medical, only the actual number of alternative transcriptions are\n included.

\n

If you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.

\n

For more information, see Alternative\n transcriptions.

" + "smithy.api#documentation": "

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe\n Medical to include in your transcript.

\n

If you select a number greater than the number of alternative transcriptions generated\n by Amazon Transcribe Medical, only the actual number of alternative transcriptions are\n included.

\n

If you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.

\n

For more information, see Alternative\n transcriptions.

" } }, "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your medical\n transcription job. Custom vocabulary names are case sensitive.

\n

The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your medical\n transcription job. Custom vocabulary names are case sensitive.

\n

The language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.

" } } }, @@ -3506,12 +3518,12 @@ "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.

\n

The language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.

" } } }, "traits": { - "smithy.api#documentation": "

Provides the name of the custom language model that was included in the specified\n transcription job.

\n

Only use ModelSettings with the LanguageModelName\n sub-parameter if you're not using automatic language\n identification (). If using\n LanguageIdSettings in your request, this parameter contains a\n LanguageModelName sub-parameter.

" + "smithy.api#documentation": "

Provides the name of the custom language model that was included in the specified\n transcription job.

\n

Only use ModelSettings with the LanguageModelName\n sub-parameter if you're not using automatic language\n identification (). If using\n LanguageIdSettings in your request, this parameter contains a\n LanguageModelName sub-parameter.

" } }, "com.amazonaws.transcribe#ModelStatus": { @@ -3592,7 +3604,7 @@ } }, "traits": { - "smithy.api#documentation": "

Flag the presence or absence of periods of silence in your Call Analytics\n transcription output.

\n

Rules using NonTalkTimeFilter are designed to match:

\n
    \n
  • \n

    The presence of silence at specified periods throughout the call

    \n
    • \n
  • \n

    The presence of speech at specified periods throughout the call

    \n
    • \n
\n

See Rule criteria for batch \n categories for usage examples.

" + "smithy.api#documentation": "

Flag the presence or absence of periods of silence in your Call Analytics\n transcription output.

\n

Rules using NonTalkTimeFilter are designed to match:

\n
    \n
  • \n

    The presence of silence at specified periods throughout the call

    \n
    • \n
  • \n

    The presence of speech at specified periods throughout the call

    \n
    • \n
\n

See Rule criteria for batch \n categories for usage examples.

" } }, "com.amazonaws.transcribe#NotFoundException": { @@ -3833,7 +3845,7 @@ } }, "traits": { - "smithy.api#documentation": "

A time range, in percentage, between two points in your media file.

\n

You can use StartPercentage and EndPercentage to search a\n custom segment. For example, setting StartPercentage to 10 and\n EndPercentage to 50 only searches for your specified criteria in the\n audio contained between the 10 percent mark and the 50 percent mark of your media\n file.

\n

You can use also First to search from the start of the media file until\n the time that you specify. Or use Last to search from the time that you\n specify until the end of the media file. For example, setting First to 10\n only searches for your specified criteria in the audio contained in the first 10 percent\n of the media file.

\n

If you prefer to use milliseconds instead of percentage, see .

" + "smithy.api#documentation": "

A time range, in percentage, between two points in your media file.

\n

You can use StartPercentage and EndPercentage to search a\n custom segment. For example, setting StartPercentage to 10 and\n EndPercentage to 50 only searches for your specified criteria in the\n audio contained between the 10 percent mark and the 50 percent mark of your media\n file.

\n

You can use also First to search from the start of the media file until\n the time that you specify. Or use Last to search from the time that you\n specify until the end of the media file. For example, setting First to 10\n only searches for your specified criteria in the audio contained in the first 10 percent\n of the media file.

\n

If you prefer to use milliseconds instead of percentage, see .

" } }, "com.amazonaws.transcribe#Rule": { @@ -3865,7 +3877,7 @@ } }, "traits": { - "smithy.api#documentation": "

A rule is a set of criteria that you can specify to flag an attribute in your Call\n Analytics output. Rules define a Call Analytics category.

\n

Rules can include these parameters: , , , and .

\n

To learn more about Call Analytics rules and categories, see Creating categories for batch\n transcriptions and Creating categories for\n streaming transcriptions.

\n

To learn more about Call Analytics, see Analyzing call center audio with Call\n Analytics.

" + "smithy.api#documentation": "

A rule is a set of criteria that you can specify to flag an attribute in your Call\n Analytics output. Rules define a Call Analytics category.

\n

Rules can include these parameters: , , , and .

\n

To learn more about Call Analytics rules and categories, see Creating categories for batch\n transcriptions and Creating categories for\n streaming transcriptions.

\n

To learn more about Call Analytics, see Analyzing call center audio with Call\n Analytics.

" } }, "com.amazonaws.transcribe#RuleList": { @@ -3916,7 +3928,7 @@ } }, "traits": { - "smithy.api#documentation": "

Flag the presence or absence of specific sentiments detected in your Call Analytics\n transcription output.

\n

Rules using SentimentFilter are designed to match:

\n
    \n
  • \n

    The presence or absence of a positive sentiment felt by the customer, agent,\n or both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a negative sentiment felt by the customer, agent,\n or both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a neutral sentiment felt by the customer, agent, or\n both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a mixed sentiment felt by the customer, the agent,\n or both at specified points in the call

    \n
    • \n
\n

See Rule criteria for batch \n categories for usage examples.

" + "smithy.api#documentation": "

Flag the presence or absence of specific sentiments detected in your Call Analytics\n transcription output.

\n

Rules using SentimentFilter are designed to match:

\n
    \n
  • \n

    The presence or absence of a positive sentiment felt by the customer, agent,\n or both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a negative sentiment felt by the customer, agent,\n or both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a neutral sentiment felt by the customer, agent, or\n both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a mixed sentiment felt by the customer, the agent,\n or both at specified points in the call

    \n
    • \n
\n

See Rule criteria for batch \n categories for usage examples.

" } }, "com.amazonaws.transcribe#SentimentValue": { @@ -3972,43 +3984,43 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Partitioning speakers\n (diarization).

" + "smithy.api#documentation": "

Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Partitioning speakers\n (diarization).

" } }, "MaxSpeakerLabels": { "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "

Specify the maximum number of speakers you want to partition in your media.

\n

Note that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.

\n

If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" + "smithy.api#documentation": "

Specify the maximum number of speakers you want to partition in your media.

\n

Note that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.

\n

If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" } }, "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Transcribing multi-channel\n audio.

" + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.

\n

You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.

\n

For more information, see Transcribing multi-channel\n audio.

" } }, "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.

\n

If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.

\n

If you include ShowAlternatives, you must also include\n MaxAlternatives, which is the maximum number of alternative\n transcriptions you want Amazon Transcribe to generate.

\n

For more information, see Alternative\n transcriptions.

" + "smithy.api#documentation": "

To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.

\n

If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.

\n

If you include ShowAlternatives, you must also include\n MaxAlternatives, which is the maximum number of alternative\n transcriptions you want Amazon Transcribe to generate.

\n

For more information, see Alternative\n transcriptions.

" } }, "MaxAlternatives": { "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe\n to include in your transcript.

\n

If you select a number greater than the number of alternative transcriptions generated\n by Amazon Transcribe, only the actual number of alternative transcriptions are\n included.

\n

If you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.

\n

For more information, see Alternative\n transcriptions.

" + "smithy.api#documentation": "

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe\n to include in your transcript.

\n

If you select a number greater than the number of alternative transcriptions generated\n by Amazon Transcribe, only the actual number of alternative transcriptions are\n included.

\n

If you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.

\n

For more information, see Alternative\n transcriptions.

" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary filter you want to use in your transcription job\n request. This name is case sensitive, cannot contain spaces, and must be unique within\n an Amazon Web Services account.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to use in your transcription job\n request. This name is case sensitive, cannot contain spaces, and must be unique within\n an Amazon Web Services account.

\n

Note that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.

" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribe#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "

Specify how you want your custom vocabulary filter applied to your transcript.

\n

To replace words with ***, choose mask.

\n

To delete words, choose remove.

\n

To flag words without changing them, choose tag.

" + "smithy.api#documentation": "

Specify how you want your custom vocabulary filter applied to your transcript.

\n

To replace words with ***, choose mask.

\n

To delete words, choose remove.

\n

To flag words without changing them, choose tag.

" } } }, @@ -4050,7 +4062,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transcribes the audio from a customer service call and applies any additional Request\n Parameters you choose to include in your request.

\n

In addition to many standard transcription features, Call Analytics provides you with\n call characteristics, call summarization, speaker sentiment, and optional redaction of\n your text transcript and your audio file. You can also apply custom categories to flag\n specified conditions. To learn more about these features and insights, refer to Analyzing call\n center audio with Call Analytics.

\n

If you want to apply categories to your Call Analytics job, you must create them\n before submitting your job request. Categories cannot be retroactively applied to a job.\n To create a new category, use the \n operation. To learn more about Call Analytics categories, see Creating categories for batch \n transcriptions and Creating categories for \n streaming transcriptions.

\n

To make a StartCallAnalyticsJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.

\n

You must include the following parameters in your StartCallAnalyticsJob\n request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

    \n
    • \n
  • \n

    \n CallAnalyticsJobName: A custom name that you create for your\n transcription job that's unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role\n that has permissions to access the Amazon S3 bucket that contains your\n input files.

    \n
    • \n
  • \n

    \n Media (MediaFileUri or\n RedactedMediaFileUri): The Amazon S3 location of your\n media file.

    \n
    • \n
\n \n

With Call Analytics, you can redact the audio contained in your media file by\n including RedactedMediaFileUri, instead of MediaFileUri,\n to specify the location of your input audio. If you choose to redact your audio, you\n can find your redacted media at the location specified in the\n RedactedMediaFileUri field of your response.

\n ", + "smithy.api#documentation": "

Transcribes the audio from a customer service call and applies any additional Request\n Parameters you choose to include in your request.

\n

In addition to many standard transcription features, Call Analytics provides you with\n call characteristics, call summarization, speaker sentiment, and optional redaction of\n your text transcript and your audio file. You can also apply custom categories to flag\n specified conditions. To learn more about these features and insights, refer to Analyzing call\n center audio with Call Analytics.

\n

If you want to apply categories to your Call Analytics job, you must create them\n before submitting your job request. Categories cannot be retroactively applied to a job.\n To create a new category, use the \n operation. To learn more about Call Analytics categories, see Creating categories for batch \n transcriptions and Creating categories for \n streaming transcriptions.

\n

To make a StartCallAnalyticsJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.

\n

You must include the following parameters in your StartCallAnalyticsJob\n request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

    \n
    • \n
  • \n

    \n CallAnalyticsJobName: A custom name that you create for your\n transcription job that's unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role\n that has permissions to access the Amazon S3 bucket that contains your\n input files.

    \n
    • \n
  • \n

    \n Media (MediaFileUri or\n RedactedMediaFileUri): The Amazon S3 location of your\n media file.

    \n
    • \n
\n \n

With Call Analytics, you can redact the audio contained in your media file by\n including RedactedMediaFileUri, instead of MediaFileUri,\n to specify the location of your input audio. If you choose to redact your audio, you\n can find your redacted media at the location specified in the\n RedactedMediaFileUri field of your response.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -4064,7 +4076,7 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your Call Analytics job.

\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 new job with the same name as an\n existing job, you get a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your Call Analytics job.

\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 new job with the same name as an\n existing job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4079,19 +4091,19 @@ "OutputLocation": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location where you want your Call Analytics transcription output\n stored. You can use any of the following formats to specify the output location:

\n
    \n
  1. \n

    s3://DOC-EXAMPLE-BUCKET

    \n
    2. \n
  2. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/

    \n
    3. \n
  3. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

    \n
    4. \n
\n

Unless you specify a file name (option 3), the name of your output file has a default\n value that matches the name you specified for your transcription job using the\n CallAnalyticsJobName parameter.

\n

You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for\n server-side encryption.

\n

If you don't specify OutputLocation, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

" + "smithy.api#documentation": "

The Amazon S3 location where you want your Call Analytics transcription output\n stored. You can use any of the following formats to specify the output location:

\n
    \n
  1. \n

    s3://DOC-EXAMPLE-BUCKET

    \n
    2. \n
  2. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/

    \n
    3. \n
  3. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

    \n
    4. \n
\n

Unless you specify a file name (option 3), the name of your output file has a default\n value that matches the name you specified for your transcription job using the\n CallAnalyticsJobName parameter.

\n

You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for\n server-side encryption.

\n

If you don't specify OutputLocation, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The KMS key you want to use to encrypt your Call Analytics\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the user making the request must\n have permission to use the specified KMS key.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your Call Analytics\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the user making the request must\n have permission to use the specified KMS key.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM\n ARNs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM\n ARNs.

" } }, "Settings": { @@ -4142,7 +4154,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transcribes the audio from a medical dictation or conversation and applies any\n additional Request Parameters you choose to include in your request.

\n

In addition to many standard transcription features, Amazon Transcribe Medical\n provides you with a robust medical vocabulary and, optionally, content identification,\n which adds flags to personal health information (PHI). To learn more about these\n features, refer to How Amazon Transcribe Medical\n works.

\n

To make a StartMedicalTranscriptionJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the S3 location\n of the file using the Media parameter.

\n

You must include the following parameters in your\n StartMedicalTranscriptionJob request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

    \n
    • \n
  • \n

    \n MedicalTranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

    \n
    • \n
  • \n

    \n LanguageCode: This must be en-US.

    \n
    • \n
  • \n

    \n OutputBucketName: The Amazon S3 bucket where you want\n your transcript stored. If you want your output stored in a sub-folder of this\n bucket, you must also include OutputKey.

    \n
    • \n
  • \n

    \n Specialty: This must be PRIMARYCARE.

    \n
    • \n
  • \n

    \n Type: Choose whether your audio is a conversation or a\n dictation.

    \n
    • \n
", + "smithy.api#documentation": "

Transcribes the audio from a medical dictation or conversation and applies any\n additional Request Parameters you choose to include in your request.

\n

In addition to many standard transcription features, Amazon Transcribe Medical\n provides you with a robust medical vocabulary and, optionally, content identification,\n which adds flags to personal health information (PHI). To learn more about these\n features, refer to How Amazon Transcribe Medical\n works.

\n

To make a StartMedicalTranscriptionJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the S3 location\n of the file using the Media parameter.

\n

You must include the following parameters in your\n StartMedicalTranscriptionJob request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

    \n
    • \n
  • \n

    \n MedicalTranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

    \n
    • \n
  • \n

    \n LanguageCode: This must be en-US.

    \n
    • \n
  • \n

    \n OutputBucketName: The Amazon S3 bucket where you want\n your transcript stored. If you want your output stored in a sub-folder of this\n bucket, you must also include OutputKey.

    \n
    • \n
  • \n

    \n Specialty: This must be PRIMARYCARE.

    \n
    • \n
  • \n

    \n Type: Choose whether your audio is a conversation or a\n dictation.

    \n
    • \n
", "smithy.api#http": { "method": "PUT", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -4156,7 +4168,7 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your medical transcription job. The name that you\n specify is also used as the default name of your transcription output file. If you want\n to specify a different name for your transcription output, use the\n OutputKey parameter.

\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 new job with the same name as an\n existing job, you get a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your medical transcription job. The name that you\n specify is also used as the default name of your transcription output file. If you want\n to specify a different name for your transcription output, use the\n OutputKey parameter.

\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 new job with the same name as an\n existing job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4171,7 +4183,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MedicalMediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in hertz, of the audio track in your input media file.

\n

If you don't specify the media sample rate, Amazon Transcribe Medical determines it\n for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the\n value detected, your job fails. Therefore, in most cases, it's advised to omit\n MediaSampleRateHertz and let Amazon Transcribe Medical determine the\n sample rate.

" + "smithy.api#documentation": "

The sample rate, in hertz, of the audio track in your input media file.

\n

If you don't specify the media sample rate, Amazon Transcribe Medical determines it\n for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the\n value detected, your job fails. Therefore, in most cases, it's advised to omit\n MediaSampleRateHertz and let Amazon Transcribe Medical determine the\n sample rate.

" } }, "MediaFormat": { @@ -4189,20 +4201,20 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your medical transcription\n output stored. Do not include the S3:// prefix of the specified\n bucket.

\n

If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.

\n

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

\n

Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

", + "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your medical transcription\n output stored. Do not include the S3:// prefix of the specified\n bucket.

\n

If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.

\n

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

\n

Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

", "smithy.api#required": {} } }, "OutputKey": { "target": "com.amazonaws.transcribe#OutputKey", "traits": { - "smithy.api#documentation": "

Use in combination with OutputBucketName to specify the output location\n of your transcript and, optionally, a unique name for your output file. The default name\n for your transcription output is the same as the name you specified for your medical\n transcription job (MedicalTranscriptionJobName).

\n

Here are some examples of how you can use OutputKey:

\n
    \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'my-transcript.json' as the OutputKey, your transcription output\n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the\n MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

    \n
    • \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'test-files/my-transcript.json' as the OutputKey, your\n transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the\n MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'test-files/my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

    \n
    • \n
\n

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,\n one is created for you.

" + "smithy.api#documentation": "

Use in combination with OutputBucketName to specify the output location\n of your transcript and, optionally, a unique name for your output file. The default name\n for your transcription output is the same as the name you specified for your medical\n transcription job (MedicalTranscriptionJobName).

\n

Here are some examples of how you can use OutputKey:

\n
    \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'my-transcript.json' as the OutputKey, your transcription output\n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the\n MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

    \n
    • \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'test-files/my-transcript.json' as the OutputKey, your\n transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the\n MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'test-files/my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

    \n
    • \n
\n

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,\n one is created for you.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The KMS key you want to use to encrypt your medical transcription\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the user making the request must\n have permission to use the specified KMS key.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your medical transcription\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the user making the request must\n have permission to use the specified KMS key.

" } }, "KMSEncryptionContext": { @@ -4233,14 +4245,14 @@ "Type": { "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "

Specify whether your input media contains only one person (DICTATION) or\n contains a conversation between two people (CONVERSATION).

\n

For example, DICTATION could be used for a medical professional wanting\n to transcribe voice memos; CONVERSATION could be used for transcribing the\n doctor-patient dialogue during the patient's office visit.

", + "smithy.api#documentation": "

Specify whether your input media contains only one person (DICTATION) or\n contains a conversation between two people (CONVERSATION).

\n

For example, DICTATION could be used for a medical professional wanting\n to transcribe voice memos; CONVERSATION could be used for transcribing the\n doctor-patient dialogue during the patient's office visit.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new medical\n transcription job at the time you start this new job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new medical\n transcription job at the time you start this new job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" } } } @@ -4279,7 +4291,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transcribes the audio from a media file and applies any additional Request Parameters\n you choose to include in your request.

\n

To make a StartTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.

\n

You must include the following parameters in your StartTranscriptionJob\n request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

    \n
    • \n
  • \n

    \n TranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

    \n
    • \n
  • \n

    One of LanguageCode, IdentifyLanguage, or\n IdentifyMultipleLanguages: If you know the language of your\n media file, specify it using the LanguageCode parameter; you can\n find all valid language codes in the Supported\n languages table. If you don't know the languages spoken in your\n media, use either IdentifyLanguage or\n IdentifyMultipleLanguages and let Amazon Transcribe identify\n the languages for you.

    \n
    • \n
", + "smithy.api#documentation": "

Transcribes the audio from a media file and applies any additional Request Parameters\n you choose to include in your request.

\n

To make a StartTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.

\n

You must include the following parameters in your StartTranscriptionJob\n request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.

    \n
    • \n
  • \n

    \n TranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n Media (MediaFileUri): The Amazon S3 location\n of your media file.

    \n
    • \n
  • \n

    One of LanguageCode, IdentifyLanguage, or\n IdentifyMultipleLanguages: If you know the language of your\n media file, specify it using the LanguageCode parameter; you can\n find all valid language codes in the Supported\n languages table. If you don't know the languages spoken in your\n media, use either IdentifyLanguage or\n IdentifyMultipleLanguages and let Amazon Transcribe identify\n the languages for you.

    \n
    • \n
", "smithy.api#http": { "method": "PUT", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -4293,7 +4305,7 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your transcription job. The name that you specify is\n also used as the default name of your transcription output file. If you want to specify\n a different name for your transcription output, use the OutputKey\n parameter.

\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 new job with the same name as an\n existing job, you get a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your transcription job. The name that you specify is\n also used as the default name of your transcription output file. If you want to specify\n a different name for your transcription output, use the OutputKey\n parameter.

\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 new job with the same name as an\n existing job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4301,13 +4313,13 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language spoken in the input media file.

\n

If you're unsure of the language spoken in your media file, consider using\n IdentifyLanguage or IdentifyMultipleLanguages to enable\n automatic language identification.

\n

Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

\n \n

To transcribe speech in Modern Standard Arabic (ar-SA), your media\n file must be encoded at a sample rate of 16,000 Hz or higher.

\n " + "smithy.api#documentation": "

The language code that represents the language spoken in the input media file.

\n

If you're unsure of the language spoken in your media file, consider using\n IdentifyLanguage or IdentifyMultipleLanguages to enable\n automatic language identification.

\n

Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

\n \n

To transcribe speech in Modern Standard Arabic (ar-SA), your media\n file must be encoded at a sample rate of 16,000 Hz or higher.

\n " } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in hertz, of the audio track in your input media file.

\n

If you don't specify the media sample rate, Amazon Transcribe determines it for you.\n If you specify the sample rate, it must match the rate detected by Amazon Transcribe.\n If there's a mismatch between the value that you specify and the value detected, your\n job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

" + "smithy.api#documentation": "

The sample rate, in hertz, of the audio track in your input media file.

\n

If you don't specify the media sample rate, Amazon Transcribe determines it for you.\n If you specify the sample rate, it must match the rate detected by Amazon Transcribe.\n If there's a mismatch between the value that you specify and the value detected, your\n job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.

" } }, "MediaFormat": { @@ -4326,19 +4338,19 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your transcription output\n stored. Do not include the S3:// prefix of the specified bucket.

\n

If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.

\n

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

\n

Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

\n

If you don't specify OutputBucketName, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

" + "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your transcription output\n stored. Do not include the S3:// prefix of the specified bucket.

\n

If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.

\n

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

\n

Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.

\n

If you don't specify OutputBucketName, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.

" } }, "OutputKey": { "target": "com.amazonaws.transcribe#OutputKey", "traits": { - "smithy.api#documentation": "

Use in combination with OutputBucketName to specify the output location\n of your transcript and, optionally, a unique name for your output file. The default name\n for your transcription output is the same as the name you specified for your\n transcription job (TranscriptionJobName).

\n

Here are some examples of how you can use OutputKey:

\n
    \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'my-transcript.json' as the OutputKey, your transcription output\n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the\n TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

    \n
    • \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'test-files/my-transcript.json' as the OutputKey, your\n transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the\n TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'test-files/my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

    \n
    • \n
\n

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,\n one is created for you.

" + "smithy.api#documentation": "

Use in combination with OutputBucketName to specify the output location\n of your transcript and, optionally, a unique name for your output file. The default name\n for your transcription output is the same as the name you specified for your\n transcription job (TranscriptionJobName).

\n

Here are some examples of how you can use OutputKey:

\n
    \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'my-transcript.json' as the OutputKey, your transcription output\n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the\n TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

    \n
    • \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'test-files/my-transcript.json' as the OutputKey, your\n transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the\n TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'test-files/my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

    \n
    • \n
\n

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,\n one is created for you.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The KMS key you want to use to encrypt your transcription\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the user making the request must\n have permission to use the specified KMS key.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your transcription\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.

\n

Note that the user making the request must\n have permission to use the specified KMS key.

" } }, "KMSEncryptionContext": { @@ -4350,19 +4362,19 @@ "Settings": { "target": "com.amazonaws.transcribe#Settings", "traits": { - "smithy.api#documentation": "

Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker\n partitioning. You can use that to apply custom vocabularies and vocabulary filters.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both)\n with your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.

\n

If you're using automatic language identification with your request and want to\n include a custom language model, a custom vocabulary, or a custom vocabulary filter, use\n instead the parameter with the\n LanguageModelName, VocabularyName or\n VocabularyFilterName sub-parameters.

" + "smithy.api#documentation": "

Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker\n partitioning. You can use that to apply custom vocabularies and vocabulary filters.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both)\n with your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.

\n

If you're using automatic language identification with your request and want to\n include a custom language model, a custom vocabulary, or a custom vocabulary filter, use\n instead the parameter with the\n LanguageModelName, VocabularyName or\n VocabularyFilterName sub-parameters.

" } }, "ModelSettings": { "target": "com.amazonaws.transcribe#ModelSettings", "traits": { - "smithy.api#documentation": "

Specify the custom language model you want to include with your transcription job. If\n you include ModelSettings in your request, you must include the\n LanguageModelName sub-parameter.

\n

For more information, see Custom language\n models.

" + "smithy.api#documentation": "

Specify the custom language model you want to include with your transcription job. If\n you include ModelSettings in your request, you must include the\n LanguageModelName sub-parameter.

\n

For more information, see Custom language\n models.

" } }, "JobExecutionSettings": { "target": "com.amazonaws.transcribe#JobExecutionSettings", "traits": { - "smithy.api#documentation": "

Makes it possible to control how your transcription job is processed. Currently, the\n only JobExecutionSettings modification you can choose is enabling job\n queueing using the AllowDeferredExecution sub-parameter.

\n

If you include JobExecutionSettings in your request, you must also\n include the sub-parameters: AllowDeferredExecution and\n DataAccessRoleArn.

" + "smithy.api#documentation": "

Makes it possible to control how your transcription job is processed. Currently, the\n only JobExecutionSettings modification you can choose is enabling job\n queueing using the AllowDeferredExecution sub-parameter.

\n

If you include JobExecutionSettings in your request, you must also\n include the sub-parameters: AllowDeferredExecution and\n DataAccessRoleArn.

" } }, "ContentRedaction": { @@ -4374,19 +4386,19 @@ "IdentifyLanguage": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables automatic language identification in your transcription job request. Use this\n parameter if your media file contains only one language. If your media contains multiple\n languages, use IdentifyMultipleLanguages instead.

\n

If you include IdentifyLanguage, you can optionally include a list of\n language codes, using LanguageOptions, that you think may be present in\n your media file. Including LanguageOptions restricts\n IdentifyLanguage to only the language options that you specify, which\n can improve transcription accuracy.

\n

If you want to apply a custom language model, a custom vocabulary, or a custom\n vocabulary filter to your automatic language identification request, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). If you include LanguageIdSettings,\n also include LanguageOptions.

\n

Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.

" + "smithy.api#documentation": "

Enables automatic language identification in your transcription job request. Use this\n parameter if your media file contains only one language. If your media contains multiple\n languages, use IdentifyMultipleLanguages instead.

\n

If you include IdentifyLanguage, you can optionally include a list of\n language codes, using LanguageOptions, that you think may be present in\n your media file. Including LanguageOptions restricts\n IdentifyLanguage to only the language options that you specify, which\n can improve transcription accuracy.

\n

If you want to apply a custom language model, a custom vocabulary, or a custom\n vocabulary filter to your automatic language identification request, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). If you include LanguageIdSettings,\n also include LanguageOptions.

\n

Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.

" } }, "IdentifyMultipleLanguages": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Enables automatic multi-language identification in your transcription job request. Use\n this parameter if your media file contains more than one language. If your media\n contains only one language, use IdentifyLanguage instead.

\n

If you include IdentifyMultipleLanguages, you can optionally include a\n list of language codes, using LanguageOptions, that you think may be\n present in your media file. Including LanguageOptions restricts\n IdentifyLanguage to only the language options that you specify, which\n can improve transcription accuracy.

\n

If you want to apply a custom vocabulary or a custom vocabulary filter to your\n automatic language identification request, include LanguageIdSettings with\n the relevant sub-parameters (VocabularyName and\n VocabularyFilterName). If you include LanguageIdSettings,\n also include LanguageOptions.

\n

Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.

" + "smithy.api#documentation": "

Enables automatic multi-language identification in your transcription job request. Use\n this parameter if your media file contains more than one language. If your media\n contains only one language, use IdentifyLanguage instead.

\n

If you include IdentifyMultipleLanguages, you can optionally include a\n list of language codes, using LanguageOptions, that you think may be\n present in your media file. Including LanguageOptions restricts\n IdentifyLanguage to only the language options that you specify, which\n can improve transcription accuracy.

\n

If you want to apply a custom vocabulary or a custom vocabulary filter to your\n automatic language identification request, include LanguageIdSettings with\n the relevant sub-parameters (VocabularyName and\n VocabularyFilterName). If you include LanguageIdSettings,\n also include LanguageOptions.

\n

Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.

" } }, "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.

\n

If you include LanguageOptions in your request, you must also include\n IdentifyLanguage.

\n

For more information, refer to Supported\n languages.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.

" + "smithy.api#documentation": "

You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.

\n

If you include LanguageOptions in your request, you must also include\n IdentifyLanguage.

\n

For more information, refer to Supported\n languages.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.

" } }, "Subtitles": { @@ -4398,13 +4410,13 @@ "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new\n transcription job at the time you start this new job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new\n transcription job at the time you start this new job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

" } }, "LanguageIdSettings": { "target": "com.amazonaws.transcribe#LanguageIdSettingsMap", "traits": { - "smithy.api#documentation": "

If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). Note that multi-language identification\n (IdentifyMultipleLanguages) doesn't support custom language\n models.

\n

\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.

\n

It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.

\n

If you want to include a custom language model with your request but do not want to use automatic language identification, use\n instead the parameter with the\n LanguageModelName sub-parameter. If you want to include a custom\n vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use\n instead the parameter with the\n VocabularyName or VocabularyFilterName (or both)\n sub-parameter.

" + "smithy.api#documentation": "

If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). Note that multi-language identification\n (IdentifyMultipleLanguages) doesn't support custom language\n models.

\n

\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.

\n

It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.

\n

If you want to include a custom language model with your request but do not want to use automatic language identification, use\n instead the parameter with the\n LanguageModelName sub-parameter. If you want to include a custom\n vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use\n instead the parameter with the\n VocabularyName or VocabularyFilterName (or both)\n sub-parameter.

" } } } @@ -4484,12 +4496,12 @@ "OutputStartIndex": { "target": "com.amazonaws.transcribe#SubtitleOutputStartIndex", "traits": { - "smithy.api#documentation": "

Specify the starting value that is assigned to the first subtitle segment.

\n

The default start index for Amazon Transcribe is 0, which differs from\n the more widely used standard of 1. If you're uncertain which value to use,\n we recommend choosing 1, as this may improve compatibility with other\n services.

" + "smithy.api#documentation": "

Specify the starting value that is assigned to the first subtitle segment.

\n

The default start index for Amazon Transcribe is 0, which differs from\n the more widely used standard of 1. If you're uncertain which value to use,\n we recommend choosing 1, as this may improve compatibility with other\n services.

" } } }, "traits": { - "smithy.api#documentation": "

Generate subtitles for your media file with your transcription request.

\n

You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip\n (or both) as your output format.

\n

Note that your subtitle files are placed in the same location as your transcription\n output.

" + "smithy.api#documentation": "

Generate subtitles for your media file with your transcription request.

\n

You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip\n (or both) as your output format.

\n

Note that your subtitle files are placed in the same location as your transcription\n output.

" } }, "com.amazonaws.transcribe#SubtitlesOutput": { @@ -4504,7 +4516,7 @@ "SubtitleFileUris": { "target": "com.amazonaws.transcribe#SubtitleFileUris", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or\n download your subtitle file. Your subtitle file is stored in the same location as your\n transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are\n provided.

\n

If you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your subtitle file is stored in a service-managed bucket, and\n TranscriptFileUri provides you with a temporary URI you can use for\n secure access to your subtitle file.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.

\n " + "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or\n download your subtitle file. Your subtitle file is stored in the same location as your\n transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are\n provided.

\n

If you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your subtitle file is stored in a service-managed bucket, and\n TranscriptFileUri provides you with a temporary URI you can use for\n secure access to your subtitle file.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.

\n " } }, "OutputStartIndex": { @@ -4531,13 +4543,13 @@ "Value": { "target": "com.amazonaws.transcribe#TagValue", "traits": { - "smithy.api#documentation": "

The second part of a key:value pair that forms a tag associated with a given resource.\n For example, in the tag Department:Sales, the value is 'Sales'.

\n

Note that you can set the value of a tag to an empty string, but you can't set the\n value of a tag to null. Omitting the tag value is the same as using an empty\n string.

", + "smithy.api#documentation": "

The second part of a key:value pair that forms a tag associated with a given resource.\n For example, in the tag Department:Sales, the value is 'Sales'.

\n

Note that you can set the value of a tag to an empty string, but you can't set the\n value of a tag to null. Omitting the tag value is the same as using an empty\n string.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Adds metadata, in the form of a key:value pair, to the specified resource.

\n

For example, you could add the tag Department:Sales to a resource to\n indicate that it pertains to your organization's sales department. You can also use tags\n for tag-based access control.

\n

To learn more about tagging, see Tagging resources.

" + "smithy.api#documentation": "

Adds metadata, in the form of a key:value pair, to the specified resource.

\n

For example, you could add the tag Department:Sales to a resource to\n indicate that it pertains to your organization's sales department. You can also use tags\n for tag-based access control.

\n

To learn more about tagging, see Tagging resources.

" } }, "com.amazonaws.transcribe#TagKey": { @@ -4599,7 +4611,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the specified\n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

", + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the specified\n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

", "smithy.api#http": { "method": "PUT", "uri": "/tags/{ResourceArn}", @@ -4613,7 +4625,7 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4621,7 +4633,7 @@ "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the specified\n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

", + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the specified\n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.

", "smithy.api#required": {} } } @@ -4783,7 +4795,7 @@ "name": "transcribe" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and\n Call Analytics.

\n
    \n
  • \n

    \n Standard transcriptions are the most common\n option. Refer to for details.

    \n
    • \n
  • \n

    \n Medical transcriptions are tailored to\n medical professionals and incorporate medical terms. A common use case for this\n service is transcribing doctor-patient dialogue into after-visit notes. Refer to\n for details.

    \n
    • \n
  • \n

    \n Call Analytics transcriptions are designed\n for use with call center audio on two different channels; if you're looking for\n insight into customer service calls, use this option. Refer to for details.

    \n
    • \n
", + "smithy.api#documentation": "

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and\n Call Analytics.

\n
    \n
  • \n

    \n Standard transcriptions are the most common\n option. Refer to for details.

    \n
    • \n
  • \n

    \n Medical transcriptions are tailored to\n medical professionals and incorporate medical terms. A common use case for this\n service is transcribing doctor-patient dialogue into after-visit notes. Refer to\n for details.

    \n
    • \n
  • \n

    \n Call Analytics transcriptions are designed\n for use with call center audio on two different channels; if you're looking for\n insight into customer service calls, use this option. Refer to for details.

    \n
    • \n
", "smithy.api#title": "Amazon Transcribe Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4839,15 +4851,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -5204,9 +5207,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -5217,9 +5220,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -5230,9 +5233,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": true } }, { @@ -5243,9 +5246,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1" + "Region": "ap-south-1", + "UseDualStack": false } }, { @@ -5256,9 +5259,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -5269,9 +5272,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -5282,9 +5285,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -5295,9 +5298,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -5308,9 +5311,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -5321,9 +5324,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -5334,9 +5337,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": true } }, { @@ -5347,9 +5350,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1" + "Region": "ca-central-1", + "UseDualStack": false } }, { @@ -5360,9 +5363,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -5373,9 +5376,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -5386,9 +5389,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": true } }, { @@ -5399,9 +5402,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1" + "Region": "eu-central-1", + "UseDualStack": false } }, { @@ -5412,9 +5415,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -5425,9 +5428,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -5438,9 +5441,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": true } }, { @@ -5451,9 +5454,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-1" + "Region": "us-west-1", + "UseDualStack": false } }, { @@ -5464,9 +5467,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -5477,9 +5480,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -5490,9 +5493,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": true } }, { @@ -5503,9 +5506,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2" + "Region": "us-west-2", + "UseDualStack": false } }, { @@ -5516,9 +5519,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -5529,9 +5532,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -5542,9 +5545,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": true } }, { @@ -5555,9 +5558,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1" + "Region": "af-south-1", + "UseDualStack": false } }, { @@ -5568,9 +5571,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -5581,9 +5584,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -5594,9 +5597,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": true } }, { @@ -5607,9 +5610,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-north-1" + "Region": "eu-north-1", + "UseDualStack": false } }, { @@ -5620,9 +5623,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -5633,9 +5636,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -5646,9 +5649,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": true } }, { @@ -5659,9 +5662,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-3" + "Region": "eu-west-3", + "UseDualStack": false } }, { @@ -5672,9 +5675,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -5685,9 +5688,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -5698,9 +5701,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": true } }, { @@ -5711,9 +5714,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2" + "Region": "eu-west-2", + "UseDualStack": false } }, { @@ -5724,9 +5727,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -5737,9 +5740,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -5750,9 +5753,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": true } }, { @@ -5763,9 +5766,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-1" + "Region": "eu-west-1", + "UseDualStack": false } }, { @@ -5776,9 +5779,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -5789,9 +5792,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -5802,9 +5805,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": true } }, { @@ -5815,9 +5818,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-2" + "Region": "ap-northeast-2", + "UseDualStack": false } }, { @@ -5828,9 +5831,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -5841,9 +5844,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -5854,9 +5857,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": true } }, { @@ -5867,9 +5870,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1" + "Region": "ap-northeast-1", + "UseDualStack": false } }, { @@ -5880,9 +5883,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -5893,9 +5896,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -5906,9 +5909,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": true } }, { @@ -5919,9 +5922,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "me-south-1" + "Region": "me-south-1", + "UseDualStack": false } }, { @@ -5932,9 +5935,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -5945,9 +5948,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -5958,9 +5961,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": true } }, { @@ -5971,9 +5974,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "sa-east-1" + "Region": "sa-east-1", + "UseDualStack": false } }, { @@ -5984,9 +5987,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -5997,9 +6000,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -6010,9 +6013,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": true } }, { @@ -6023,9 +6026,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-east-1" + "Region": "ap-east-1", + "UseDualStack": false } }, { @@ -6036,9 +6039,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -6049,9 +6052,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -6062,9 +6065,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -6075,9 +6078,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -6088,9 +6091,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -6101,9 +6104,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -6114,9 +6117,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": true } }, { @@ -6127,9 +6130,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1" + "Region": "us-gov-west-1", + "UseDualStack": false } }, { @@ -6140,9 +6143,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -6153,9 +6156,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -6166,9 +6169,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": true } }, { @@ -6179,9 +6182,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1" + "Region": "ap-southeast-1", + "UseDualStack": false } }, { @@ -6192,9 +6195,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -6205,9 +6208,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -6218,9 +6221,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": true } }, { @@ -6231,9 +6234,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2" + "Region": "ap-southeast-2", + "UseDualStack": false } }, { @@ -6242,9 +6245,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -6255,9 +6258,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -6266,9 +6269,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -6279,9 +6282,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -6292,9 +6295,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -6305,9 +6308,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -6318,9 +6321,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -6331,9 +6334,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -6344,9 +6347,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -6357,9 +6360,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -6370,9 +6373,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": true } }, { @@ -6383,9 +6386,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-2" + "Region": "us-east-2", + "UseDualStack": false } }, { @@ -6396,9 +6399,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -6409,9 +6412,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -6422,9 +6425,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": true } }, { @@ -6435,9 +6438,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-northwest-1" + "Region": "cn-northwest-1", + "UseDualStack": false } }, { @@ -6448,9 +6451,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -6460,9 +6463,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -6472,9 +6475,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -6499,13 +6502,13 @@ "TranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or\n download your transcript.

\n

If you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and\n TranscriptFileUri provides you with a temporary URI you can use for\n secure access to your transcript.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.

\n " + "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or\n download your transcript.

\n

If you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and\n TranscriptFileUri provides you with a temporary URI you can use for\n secure access to your transcript.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.

\n " } }, "RedactedTranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of your redacted transcript. You can use this URI to\n access or download your transcript.

\n

If you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and\n RedactedTranscriptFileUri provides you with a temporary URI you can use\n for secure access to your transcript.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.

\n " + "smithy.api#documentation": "

The Amazon S3 location of your redacted transcript. You can use this URI to\n access or download your transcript.

\n

If you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and\n RedactedTranscriptFileUri provides you with a temporary URI you can use\n for secure access to your transcript.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.

\n " } } }, @@ -6519,7 +6522,7 @@ "TranscriptFilterType": { "target": "com.amazonaws.transcribe#TranscriptFilterType", "traits": { - "smithy.api#documentation": "

Flag the presence or absence of an exact match to the phrases that you specify. For\n example, if you specify the phrase \"speak to a manager\" as your Targets\n value, only that exact phrase is flagged.

\n

Note that semantic matching is not supported. For example, if your customer says\n \"speak to the manager\", instead of \"speak to a\n manager\", your content is not flagged.

", + "smithy.api#documentation": "

Flag the presence or absence of an exact match to the phrases that you specify. For\n example, if you specify the phrase \"speak to a manager\" as your Targets\n value, only that exact phrase is flagged.

\n

Note that semantic matching is not supported. For example, if your customer says\n \"speak to the manager\", instead of \"speak to a\n manager\", your content is not flagged.

", "smithy.api#required": {} } }, @@ -6556,7 +6559,7 @@ } }, "traits": { - "smithy.api#documentation": "

Flag the presence or absence of specific words or phrases detected in your Call\n Analytics transcription output.

\n

Rules using TranscriptFilter are designed to match:

\n
    \n
  • \n

    Custom words or phrases spoken by the agent, the customer, or both

    \n
    • \n
  • \n

    Custom words or phrases not spoken by the\n agent, the customer, or either

    \n
    • \n
  • \n

    Custom words or phrases that occur at a specific time frame

    \n
    • \n
\n

See Rule criteria for batch \n categories and Rule criteria for \n streaming categories for usage examples.

" + "smithy.api#documentation": "

Flag the presence or absence of specific words or phrases detected in your Call\n Analytics transcription output.

\n

Rules using TranscriptFilter are designed to match:

\n
    \n
  • \n

    Custom words or phrases spoken by the agent, the customer, or both

    \n
    • \n
  • \n

    Custom words or phrases not spoken by the\n agent, the customer, or either

    \n
    • \n
  • \n

    Custom words or phrases that occur at a specific time frame

    \n
    • \n
\n

See Rule criteria for batch \n categories and Rule criteria for \n streaming categories for usage examples.

" } }, "com.amazonaws.transcribe#TranscriptFilterType": { @@ -6582,7 +6585,7 @@ "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

Provides the status of the specified transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.

" + "smithy.api#documentation": "

Provides the status of the specified transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.

" } }, "LanguageCode": { @@ -6618,25 +6621,25 @@ "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media\n format.

    \n

    The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample\n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
" + "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media\n format.

    \n

    The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample\n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
" } }, "Settings": { @@ -6684,7 +6687,7 @@ "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

The confidence score associated with the language identified in your media\n file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.

" + "smithy.api#documentation": "

The confidence score associated with the language identified in your media\n file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.

" } }, "LanguageCodes": { @@ -6713,7 +6716,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides detailed information about a transcription job.

\n

To view the status of the specified transcription 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\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.

\n

If you enabled content redaction, the redacted transcript can be found at the location\n specified in RedactedTranscriptFileUri.

" + "smithy.api#documentation": "

Provides detailed information about a transcription job.

\n

To view the status of the specified transcription 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\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.

\n

If you enabled content redaction, the redacted transcript can be found at the location\n specified in RedactedTranscriptFileUri.

" } }, "com.amazonaws.transcribe#TranscriptionJobName": { @@ -6773,19 +6776,19 @@ "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time your transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time your transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "LanguageCode": { @@ -6797,7 +6800,7 @@ "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

Provides the status of your transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.

" + "smithy.api#documentation": "

Provides the status of your transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.

" } }, "FailureReason": { @@ -6809,7 +6812,7 @@ "OutputLocationType": { "target": "com.amazonaws.transcribe#OutputLocationType", "traits": { - "smithy.api#documentation": "

Indicates where the specified transcription output is stored.

\n

If the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your request. If you also included\n OutputKey in your request, your output is located in the path you\n specified in your request.

\n

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the\n URI shown in the TranscriptFileUri or\n RedactedTranscriptFileUri field.

" + "smithy.api#documentation": "

Indicates where the specified transcription output is stored.

\n

If the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your request. If you also included\n OutputKey in your request, your output is located in the path you\n specified in your request.

\n

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the\n URI shown in the TranscriptFileUri or\n RedactedTranscriptFileUri field.

" } }, "ContentRedaction": { @@ -6836,7 +6839,7 @@ "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

The confidence score associated with the language identified in your media\n file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.

" + "smithy.api#documentation": "

The confidence score associated with the language identified in your media\n file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.

" } }, "LanguageCodes": { @@ -6893,7 +6896,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified Amazon Transcribe resource.

\n

If you include UntagResource in your request, you must also include\n ResourceArn and TagKeys.

", + "smithy.api#documentation": "

Removes the specified tags from the specified Amazon Transcribe resource.

\n

If you include UntagResource in your request, you must also include\n ResourceArn and TagKeys.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{ResourceArn}", @@ -6907,7 +6910,7 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove\n tags from. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove\n tags from. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6951,7 +6954,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified Call Analytics category with new rules. Note that the\n UpdateCallAnalyticsCategory operation overwrites all existing rules\n contained in the specified category. You cannot append additional rules onto an existing\n category.

\n

To create a new category, see .

", + "smithy.api#documentation": "

Updates the specified Call Analytics category with new rules. Note that the\n UpdateCallAnalyticsCategory operation overwrites all existing rules\n contained in the specified category. You cannot append additional rules onto an existing\n category.

\n

To create a new category, see .

", "smithy.api#http": { "method": "PATCH", "uri": "/callanalyticscategories/{CategoryName}", @@ -7051,7 +7054,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom medical\n vocabulary. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

", + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom medical\n vocabulary. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

", "smithy.api#required": {} } } @@ -7075,7 +7078,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom medical vocabulary was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom medical vocabulary was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "VocabularyState": { @@ -7165,13 +7168,13 @@ "Words": { "target": "com.amazonaws.transcribe#Words", "traits": { - "smithy.api#documentation": "

Use this parameter if you want to update your custom vocabulary filter by including\n all desired terms, as comma-separated values, within your request. The other option for\n updating your vocabulary filter is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFilterFileUri parameter.

\n

Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

" + "smithy.api#documentation": "

Use this parameter if you want to update your custom vocabulary filter by including\n all desired terms, as comma-separated values, within your request. The other option for\n updating your vocabulary filter is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFilterFileUri parameter.

\n

Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary\n filter terms. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n

\n

Note that if you include VocabularyFilterFileUri in your request, you\n cannot use Words; you must choose one or the other.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary\n filter terms. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n

\n

Note that if you include VocabularyFilterFileUri in your request, you\n cannot use Words; you must choose one or the other.

" } } } @@ -7194,7 +7197,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom vocabulary filter was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom vocabulary filter was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } } } @@ -7213,20 +7216,20 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language of the entries in the custom vocabulary\n you want to update. Each custom vocabulary must contain terms in only one\n language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

", + "smithy.api#documentation": "

The language code that represents the language of the entries in the custom vocabulary\n you want to update. Each custom vocabulary must contain terms in only one\n language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

", "smithy.api#required": {} } }, "Phrases": { "target": "com.amazonaws.transcribe#Phrases", "traits": { - "smithy.api#documentation": "

Use this parameter if you want to update your custom vocabulary by including all\n desired terms, as comma-separated values, within your request. The other option for\n updating your custom vocabulary is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFileUri parameter.

\n

Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

" + "smithy.api#documentation": "

Use this parameter if you want to update your custom vocabulary by including all\n desired terms, as comma-separated values, within your request. The other option for\n updating your custom vocabulary is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFileUri parameter.

\n

Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.

" } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary.\n The URI must be located in the same Amazon Web Services Region as the resource you're\n calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

\n

Note that if you include VocabularyFileUri in your request, you cannot\n use the Phrases flag; you must choose one or the other.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary.\n The URI must be located in the same Amazon Web Services Region as the resource you're\n calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

\n

Note that if you include VocabularyFileUri in your request, you cannot\n use the Phrases flag; you must choose one or the other.

" } } } @@ -7249,7 +7252,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom vocabulary was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom vocabulary was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "VocabularyState": { @@ -7288,13 +7291,13 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language of the entries in your vocabulary\n filter. Each custom vocabulary filter must contain terms in only one language.

\n

A custom vocabulary filter can only be used to transcribe files in the same language\n as the filter. For example, if you create a custom vocabulary filter using US English\n (en-US), you can only apply this filter to files that contain English\n audio.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

" + "smithy.api#documentation": "

The language code that represents the language of the entries in your vocabulary\n filter. Each custom vocabulary filter must contain terms in only one language.

\n

A custom vocabulary filter can only be used to transcribe files in the same language\n as the filter. For example, if you create a custom vocabulary filter using US English\n (en-US), you can only apply this filter to files that contain English\n audio.

\n

For a list of supported languages and their associated language codes, refer to the\n Supported languages table.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom vocabulary filter was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom vocabulary filter was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } } }, @@ -7353,13 +7356,13 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code used to create your custom vocabulary. Each custom vocabulary must\n contain terms in only one language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.

" + "smithy.api#documentation": "

The language code used to create your custom vocabulary. Each custom vocabulary must\n contain terms in only one language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the specified custom vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" + "smithy.api#documentation": "

The date and time the specified custom vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.

" } }, "VocabularyState": { diff --git a/codegen/sdk-codegen/aws-models/translate.2017-07-01.json b/codegen/sdk-codegen/aws-models/translate.2017-07-01.json index 340e472fedf..991fedae091 100644 --- a/codegen/sdk-codegen/aws-models/translate.2017-07-01.json +++ b/codegen/sdk-codegen/aws-models/translate.2017-07-01.json @@ -100,14 +100,14 @@ "name": "translate" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Provides language translation for input text in the source language to the specified target language.

", + "smithy.api#documentation": "

Provides translation of the input content from the source language to the target language.

", "smithy.api#title": "Amazon Translate", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -156,15 +156,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -427,9 +418,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-south-1" } }, { @@ -440,9 +431,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-south-1" } }, { @@ -453,9 +444,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-south-1" } }, { @@ -466,9 +457,9 @@ } }, "params": { - "Region": "ap-south-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-south-1" } }, { @@ -479,9 +470,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -492,9 +483,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ca-central-1" } }, { @@ -505,9 +496,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -518,9 +509,9 @@ } }, "params": { - "Region": "ca-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ca-central-1" } }, { @@ -531,9 +522,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -544,9 +535,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-central-1" } }, { @@ -557,9 +548,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -570,9 +561,9 @@ } }, "params": { - "Region": "eu-central-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-central-1" } }, { @@ -583,9 +574,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-1" } }, { @@ -596,9 +587,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-1" } }, { @@ -609,9 +600,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-1" } }, { @@ -622,9 +613,9 @@ } }, "params": { - "Region": "us-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-1" } }, { @@ -635,9 +626,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -648,9 +639,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-west-2" } }, { @@ -661,9 +652,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -674,9 +665,9 @@ } }, "params": { - "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-west-2" } }, { @@ -687,9 +678,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-north-1" } }, { @@ -700,9 +691,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-north-1" } }, { @@ -713,9 +704,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-north-1" } }, { @@ -726,9 +717,9 @@ } }, "params": { - "Region": "eu-north-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-north-1" } }, { @@ -739,9 +730,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-3" } }, { @@ -752,9 +743,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-3" } }, { @@ -765,9 +756,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-3" } }, { @@ -778,9 +769,9 @@ } }, "params": { - "Region": "eu-west-3", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-3" } }, { @@ -791,9 +782,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -804,9 +795,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-2" } }, { @@ -817,9 +808,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -830,9 +821,9 @@ } }, "params": { - "Region": "eu-west-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-2" } }, { @@ -843,9 +834,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -856,9 +847,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "eu-west-1" } }, { @@ -869,9 +860,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -882,9 +873,9 @@ } }, "params": { - "Region": "eu-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "eu-west-1" } }, { @@ -895,9 +886,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -908,9 +899,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-2" } }, { @@ -921,9 +912,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -934,9 +925,9 @@ } }, "params": { - "Region": "ap-northeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-2" } }, { @@ -947,9 +938,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -960,9 +951,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-northeast-1" } }, { @@ -973,9 +964,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -986,9 +977,9 @@ } }, "params": { - "Region": "ap-northeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-northeast-1" } }, { @@ -999,9 +990,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-east-1" } }, { @@ -1012,9 +1003,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-east-1" } }, { @@ -1025,9 +1016,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-east-1" } }, { @@ -1038,9 +1029,9 @@ } }, "params": { - "Region": "ap-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-east-1" } }, { @@ -1051,9 +1042,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-gov-west-1" } }, { @@ -1064,9 +1055,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-gov-west-1" } }, { @@ -1077,9 +1068,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-gov-west-1" } }, { @@ -1090,9 +1081,9 @@ } }, "params": { - "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-gov-west-1" } }, { @@ -1103,9 +1094,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-1" } }, { @@ -1116,9 +1107,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-1" } }, { @@ -1129,9 +1120,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-1" } }, { @@ -1142,9 +1133,9 @@ } }, "params": { - "Region": "ap-southeast-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-1" } }, { @@ -1155,9 +1146,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -1168,9 +1159,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "ap-southeast-2" } }, { @@ -1181,9 +1172,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -1194,9 +1185,9 @@ } }, "params": { - "Region": "ap-southeast-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "ap-southeast-2" } }, { @@ -1205,9 +1196,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-iso-east-1" } }, { @@ -1218,9 +1209,9 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-iso-east-1" } }, { @@ -1229,9 +1220,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-iso-east-1" } }, { @@ -1242,9 +1233,9 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-iso-east-1" } }, { @@ -1255,9 +1246,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -1268,9 +1259,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-1" } }, { @@ -1281,9 +1272,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -1294,9 +1285,9 @@ } }, "params": { - "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-1" } }, { @@ -1307,9 +1298,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": true, - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -1320,9 +1311,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": true, "UseDualStack": false, - "UseFIPS": true + "Region": "us-east-2" } }, { @@ -1333,9 +1324,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": true, - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -1346,9 +1337,9 @@ } }, "params": { - "Region": "us-east-2", + "UseFIPS": false, "UseDualStack": false, - "UseFIPS": false + "Region": "us-east-2" } }, { @@ -1359,9 +1350,9 @@ } }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1371,9 +1362,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1383,9 +1374,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -1425,9 +1416,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5000 + "max": 10000 }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,5000}$" + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,10000}$" } }, "com.amazonaws.translate#ClientTokenString": { @@ -2126,7 +2117,7 @@ "S3Uri": { "target": "com.amazonaws.translate#S3Uri", "traits": { - "smithy.api#documentation": "

The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the\n files in the folder. The folder must be in the same Region as the API endpoint you are\n calling.

\n \n

The URI can also point to a single input document, or it can provide the prefix for a collection of\n input documents. For example. if you use the URI S3://bucketName/prefix and the\n prefix is a single file, Amazon Translate uses that files as input. If more than one file begins with the\n prefix, Amazon Translate uses all of them as input.

\n ", + "smithy.api#documentation": "

The URI of the AWS S3 folder that contains the input files. Amazon Translate translates all the\n files in the folder and all its sub-folders. The folder must be in the same Region as the API endpoint you are\n calling.

", "smithy.api#required": {} } }, @@ -2505,7 +2496,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags associated with a given Amazon Translate resource. \n For more information, see \n Tagging your resources.

" + "smithy.api#documentation": "

Lists all tags associated with a given Amazon Translate resource.\n For more information, see \n Tagging your resources.

" } }, "com.amazonaws.translate#ListTagsForResourceRequest": { @@ -3049,7 +3040,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an asynchronous batch translation job. Use batch translation jobs to\n translate large volumes of text across multiple documents at once. \n For batch translation, the input documents must share the same source language. You can specify one \n or more target languages. Batch translation translates each input document into each of the target languages.\n For more information, see\n Asynchronous batch processing \n

\n\n

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

\n \n

Amazon Translate does not support batch translation of multiple source languages at once.

\n " + "smithy.api#documentation": "

Starts an asynchronous batch translation job. Use batch translation jobs to\n translate large volumes of text across multiple documents at once.\n For batch translation, you can input documents with different source languages (specify auto\n as the source language). You can specify one\n or more target languages. Batch translation translates each input document into each of the target languages.\n For more information, see\n Asynchronous batch processing.

\n\n

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

" } }, "com.amazonaws.translate#StartTextTranslationJobRequest": { @@ -3078,21 +3069,21 @@ "DataAccessRoleArn": { "target": "com.amazonaws.translate#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role\n that grants Amazon Translate read access to your input data. For more information, see \n Identity and access management .

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role\n that grants Amazon Translate read access to your input data. For more information, see\n Identity and access management .

", "smithy.api#required": {} } }, "SourceLanguageCode": { "target": "com.amazonaws.translate#LanguageCodeString", "traits": { - "smithy.api#documentation": "

The language code of the input language. For a list of language codes, see \n Supported languages.

\n

Amazon Translate does not automatically detect a source language during batch translation jobs.

", + "smithy.api#documentation": "

The language code of the input language. Specify the language if all input documents share the same language.\n If you don't know the language of the source files, or your input documents contains different source\n languages, select auto. Amazon Translate auto detects the source language for each input document.\n For a list of supported language codes, see\n Supported languages.

", "smithy.api#required": {} } }, "TargetLanguageCodes": { "target": "com.amazonaws.translate#TargetLanguageCodeStringList", "traits": { - "smithy.api#documentation": "

The target languages of the translation job. Enter up to 10 language codes. \n Each input file is translated into each target language.

\n

Each language code is two or five characters long. For a list of language codes, see \n Supported languages.

", + "smithy.api#documentation": "

The target languages of the translation job. Enter up to 10 language codes.\n Each input file is translated into each target language.

\n

Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

", "smithy.api#required": {} } }, @@ -3105,7 +3096,7 @@ "ParallelDataNames": { "target": "com.amazonaws.translate#ResourceNameList", "traits": { - "smithy.api#documentation": "

The name of a parallel data resource to add to the translation job. This resource consists\n of examples that show how you want segments of text to be translated. \n If you specify multiple target languages for\n the job, the parallel data file must include translations for\n all the target languages.

\n

When you add parallel\n data to a translation job, you create an Active Custom Translation job.

\n

This parameter accepts only one parallel data resource.

\n \n

Active Custom Translation jobs are priced at a higher rate than other jobs that don't\n use parallel data. For more information, see Amazon Translate pricing.

\n \n

For a list of available parallel data resources, use the ListParallelData operation.

\n

For more information, see \n Customizing your translations with parallel data.

" + "smithy.api#documentation": "

The name of a parallel data resource to add to the translation job. This resource consists\n of examples that show how you want segments of text to be translated.\n If you specify multiple target languages for\n the job, the parallel data file must include translations for\n all the target languages.

\n

When you add parallel\n data to a translation job, you create an Active Custom Translation job.

\n

This parameter accepts only one parallel data resource.

\n \n

Active Custom Translation jobs are priced at a higher rate than other jobs that don't\n use parallel data. For more information, see Amazon Translate pricing.

\n \n

For a list of available parallel data resources, use the ListParallelData operation.

\n

For more information, see \n Customizing your translations with parallel data.

" } }, "ClientToken": { @@ -3284,7 +3275,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a specific tag with a resource. A tag is a key-value pair\n that adds as a metadata to a resource. \n For more information, see \n Tagging your resources.

" + "smithy.api#documentation": "

Associates a specific tag with a resource. A tag is a key-value pair\n that adds as a metadata to a resource.\n For more information, see \n Tagging your resources.

" } }, "com.amazonaws.translate#TagResourceRequest": { @@ -3390,7 +3381,7 @@ } }, "traits": { - "smithy.api#documentation": "

The data associated with the custom terminology. For information about the custom terminology file, see \n \n Creating a Custom Terminology.

" + "smithy.api#documentation": "

The data associated with the custom terminology. For information about the custom terminology file, see\n \n Creating a Custom Terminology.

" } }, "com.amazonaws.translate#TerminologyDataFormat": { @@ -3771,7 +3762,7 @@ "Text": { "target": "com.amazonaws.translate#BoundedLengthString", "traits": { - "smithy.api#documentation": "

The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on\n your character set, this may be fewer than 5,000 characters.

", + "smithy.api#documentation": "

The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on\n your character set, this may be fewer than 10,000 characters.

", "smithy.api#required": {} } }, @@ -3807,7 +3798,7 @@ "type": "structure", "members": { "TranslatedText": { - "target": "com.amazonaws.translate#String", + "target": "com.amazonaws.translate#TranslatedTextString", "traits": { "smithy.api#documentation": "

The translated text.

", "smithy.api#required": {} @@ -3841,24 +3832,34 @@ } } }, + "com.amazonaws.translate#TranslatedTextString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20000 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{0,20000}$" + } + }, "com.amazonaws.translate#TranslationSettings": { "type": "structure", "members": { "Formality": { "target": "com.amazonaws.translate#Formality", "traits": { - "smithy.api#documentation": "

You can optionally specify the desired level of formality for translations\n to supported target languages. The formality\n setting controls the level of formal language usage (also known as register) in the\n translation output. You can set the value to informal or formal. If you don't specify a value for\n formality, or if the target language doesn't support formality, the translation will\n ignore the formality setting.

\n

If you specify multiple target languages for the job, translate ignores\n the formality setting for any unsupported target language.

\n

For a list of target languages that support formality, see Setting Formality\n in the Amazon Translate Developer Guide.

" + "smithy.api#documentation": "

You can optionally specify the desired level of formality for translations\n to supported target languages. The formality\n setting controls the level of formal language usage (also known as register) in the\n translation output. You can set the value to informal or formal. If you don't specify a value for\n formality, or if the target language doesn't support formality, the translation will\n ignore the formality setting.

\n

If you specify multiple target languages for the job, translate ignores\n the formality setting for any unsupported target language.

\n

For a list of target languages that support formality, see Supported languages\n in the Amazon Translate Developer Guide.

" } }, "Profanity": { "target": "com.amazonaws.translate#Profanity", "traits": { - "smithy.api#documentation": "

Enable the profanity setting if you want Amazon Translate to mask profane words and\n phrases in your translation output.

\n

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string\n “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the\n length or number of words.

\n

Amazon Translate doesn't detect profanity in all of its supported languages. For languages\n that support profanity detection, see Masking\n profanity in the Amazon Translate Developer Guide.

\n

If you specify multiple target languages for the job, all the\n target languages must support profanity masking. If any of the\n target languages don't support profanity masking, the\n translation job won't mask profanity for any target\n language.

" + "smithy.api#documentation": "

Enable the profanity setting if you want Amazon Translate to mask profane words and\n phrases in your translation output.

\n

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string\n “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the\n length or number of words.

\n

Amazon Translate doesn't detect profanity in all of its supported languages. For languages\n that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.

\n

If you specify multiple target languages for the job, all the\n target languages must support profanity masking. If any of the\n target languages don't support profanity masking, the\n translation job won't mask profanity for any target\n language.

" } } }, "traits": { - "smithy.api#documentation": "

Optional settings that configure the translation output. Use these settings for \n real time translations and asynchronous translation jobs.

" + "smithy.api#documentation": "

Optional settings that configure the translation output. Use these settings for\n real time translations and asynchronous translation jobs.

" } }, "com.amazonaws.translate#UnboundedLengthString": { @@ -3931,7 +3932,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a specific tag associated with an Amazon Translate resource. \n For more information, see \n Tagging your resources.

" + "smithy.api#documentation": "

Removes a specific tag associated with an Amazon Translate resource.\n For more information, see \n Tagging your resources.

" } }, "com.amazonaws.translate#UntagResourceRequest": { diff --git a/codegen/sdk-codegen/aws-models/wafv2.2019-07-29.json b/codegen/sdk-codegen/aws-models/wafv2.2019-07-29.json index 7d7ecf34e1a..e33d1630659 100644 --- a/codegen/sdk-codegen/aws-models/wafv2.2019-07-29.json +++ b/codegen/sdk-codegen/aws-models/wafv2.2019-07-29.json @@ -215,7 +215,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -264,15 +264,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -536,8 +527,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-south-1" } }, { @@ -549,8 +540,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-south-1" } }, { @@ -562,8 +553,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-south-1" } }, { @@ -575,8 +566,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-south-1" } }, { @@ -588,8 +579,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-south-1" } }, { @@ -601,8 +592,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-south-1" } }, { @@ -614,8 +605,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-south-1" } }, { @@ -627,8 +618,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-south-1" } }, { @@ -640,8 +631,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { @@ -653,8 +644,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { @@ -666,8 +657,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { @@ -679,8 +670,60 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.me-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "me-central-1" + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2-fips.me-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "me-central-1" + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://wafv2.me-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "me-central-1" + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://wafv2.me-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "me-central-1" } }, { @@ -692,8 +735,8 @@ }, "params": { "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ca-central-1" } }, { @@ -705,8 +748,8 @@ }, "params": { "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ca-central-1" } }, { @@ -718,8 +761,8 @@ }, "params": { "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ca-central-1" } }, { @@ -731,8 +774,8 @@ }, "params": { "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ca-central-1" } }, { @@ -744,8 +787,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -757,8 +800,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -770,8 +813,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-central-1" } }, { @@ -783,8 +826,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { @@ -796,8 +839,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-1" } }, { @@ -809,8 +852,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-1" } }, { @@ -822,8 +865,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-1" } }, { @@ -835,8 +878,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-1" } }, { @@ -848,8 +891,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -861,8 +904,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -874,8 +917,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-west-2" } }, { @@ -887,8 +930,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-west-2" } }, { @@ -900,8 +943,8 @@ }, "params": { "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "af-south-1" } }, { @@ -913,8 +956,8 @@ }, "params": { "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "af-south-1" } }, { @@ -926,8 +969,8 @@ }, "params": { "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "af-south-1" } }, { @@ -939,8 +982,8 @@ }, "params": { "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "af-south-1" } }, { @@ -952,8 +995,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-north-1" } }, { @@ -965,8 +1008,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-north-1" } }, { @@ -978,8 +1021,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-north-1" } }, { @@ -991,8 +1034,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-north-1" } }, { @@ -1004,8 +1047,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-3" } }, { @@ -1017,8 +1060,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-3" } }, { @@ -1030,8 +1073,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-3" } }, { @@ -1043,8 +1086,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-3" } }, { @@ -1056,8 +1099,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-2" } }, { @@ -1069,8 +1112,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-2" } }, { @@ -1082,8 +1125,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-2" } }, { @@ -1095,8 +1138,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-2" } }, { @@ -1108,8 +1151,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-1" } }, { @@ -1121,8 +1164,8 @@ }, "params": { "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-1" } }, { @@ -1134,8 +1177,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "eu-west-1" } }, { @@ -1147,8 +1190,8 @@ }, "params": { "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-west-1" } }, { @@ -1160,8 +1203,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-3" } }, { @@ -1173,8 +1216,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-3" } }, { @@ -1186,8 +1229,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-3" } }, { @@ -1199,8 +1242,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-3" } }, { @@ -1212,8 +1255,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-2" } }, { @@ -1225,8 +1268,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-2" } }, { @@ -1238,8 +1281,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-2" } }, { @@ -1251,8 +1294,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-2" } }, { @@ -1264,8 +1307,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-1" } }, { @@ -1277,8 +1320,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { @@ -1290,8 +1333,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-northeast-1" } }, { @@ -1303,8 +1346,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { @@ -1316,8 +1359,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-south-1" } }, { @@ -1329,8 +1372,8 @@ }, "params": { "UseFIPS": true, - "Region": "me-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-south-1" } }, { @@ -1342,8 +1385,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-south-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "me-south-1" } }, { @@ -1355,8 +1398,8 @@ }, "params": { "UseFIPS": false, - "Region": "me-south-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "me-south-1" } }, { @@ -1368,8 +1411,8 @@ }, "params": { "UseFIPS": true, - "Region": "sa-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "sa-east-1" } }, { @@ -1381,8 +1424,8 @@ }, "params": { "UseFIPS": true, - "Region": "sa-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "sa-east-1" } }, { @@ -1394,8 +1437,8 @@ }, "params": { "UseFIPS": false, - "Region": "sa-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "sa-east-1" } }, { @@ -1407,8 +1450,8 @@ }, "params": { "UseFIPS": false, - "Region": "sa-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "sa-east-1" } }, { @@ -1420,8 +1463,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-east-1" } }, { @@ -1433,8 +1476,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-east-1" } }, { @@ -1446,8 +1489,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-east-1" } }, { @@ -1459,8 +1502,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-east-1" } }, { @@ -1472,8 +1515,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-north-1" } }, { @@ -1485,8 +1528,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { @@ -1498,8 +1541,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-north-1" } }, { @@ -1511,8 +1554,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { @@ -1524,8 +1567,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-west-1" } }, { @@ -1537,8 +1580,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-west-1" } }, { @@ -1550,8 +1593,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-gov-west-1" } }, { @@ -1563,8 +1606,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-west-1" } }, { @@ -1576,8 +1619,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -1589,8 +1632,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -1602,8 +1645,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-1" } }, { @@ -1615,8 +1658,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { @@ -1628,8 +1671,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -1641,8 +1684,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -1654,8 +1697,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-2" } }, { @@ -1667,8 +1710,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { @@ -1680,8 +1723,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-3" } }, { @@ -1693,8 +1736,8 @@ }, "params": { "UseFIPS": true, - "Region": "ap-southeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-3" } }, { @@ -1706,8 +1749,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-3", - "UseDualStack": true + "UseDualStack": true, + "Region": "ap-southeast-3" } }, { @@ -1719,8 +1762,8 @@ }, "params": { "UseFIPS": false, - "Region": "ap-southeast-3", - "UseDualStack": false + "UseDualStack": false, + "Region": "ap-southeast-3" } }, { @@ -1732,8 +1775,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -1745,8 +1788,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -1758,8 +1801,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-1" } }, { @@ -1771,8 +1814,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { @@ -1784,8 +1827,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-2" } }, { @@ -1797,8 +1840,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-2" } }, { @@ -1810,8 +1853,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": true + "UseDualStack": true, + "Region": "us-east-2" } }, { @@ -1823,8 +1866,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-2" } }, { @@ -1836,8 +1879,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-northwest-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-northwest-1" } }, { @@ -1849,8 +1892,8 @@ }, "params": { "UseFIPS": true, - "Region": "cn-northwest-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-northwest-1" } }, { @@ -1862,8 +1905,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-northwest-1", - "UseDualStack": true + "UseDualStack": true, + "Region": "cn-northwest-1" } }, { @@ -1875,8 +1918,8 @@ }, "params": { "UseFIPS": false, - "Region": "cn-northwest-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-northwest-1" } }, { @@ -1888,8 +1931,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1900,8 +1943,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1912,8 +1955,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -1985,14 +2028,14 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request\n component that you've identified in your FieldToMatch specifications.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"All\": {}\n

" + "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request\n component that you've identified in your FieldToMatch specifications.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"All\": {}\n

" } }, "com.amazonaws.wafv2#AllQueryArguments": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Inspect all query arguments of the web request.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"AllQueryArguments\": {}\n

" + "smithy.api#documentation": "

Inspect all query arguments of the web request.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"AllQueryArguments\": {}\n

" } }, "com.amazonaws.wafv2#AllowAction": { @@ -2050,7 +2093,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.

\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.

\n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" } }, "com.amazonaws.wafv2#AssociateWebACLRequest": { @@ -2066,7 +2109,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

\n \n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

\n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
", "smithy.api#required": {} } } @@ -2189,7 +2232,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies that WAF should run a CAPTCHA check against the request:

\n
    \n
  • \n

    If the request includes a valid, unexpired CAPTCHA token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.

    \n
    • \n
  • \n

    If the request doesn't include a valid, unexpired token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

    \n

    WAF generates a response that it sends back to the client, which includes the following:

    \n
      \n
    • \n

      The header x-amzn-waf-action with a value of captcha.

      \n
      • \n
    • \n

      The HTTP status code 405 Method Not Allowed.

      \n
      • \n
    • \n

      If the request contains an Accept header with a value of text/html, the response includes a CAPTCHA JavaScript page interstitial.

      \n
      • \n
    \n
    • \n
\n

You can configure the expiration time \n in the CaptchaConfig \n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" + "smithy.api#documentation": "

Specifies that WAF should run a CAPTCHA check against the request:

\n
    \n
  • \n

    If the request includes a valid, unexpired CAPTCHA token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.

    \n
    • \n
  • \n

    If the request doesn't include a valid, unexpired token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

    \n

    WAF generates a response that it sends back to the client, which includes the following:

    \n
      \n
    • \n

      The header x-amzn-waf-action with a value of captcha.

      \n
      • \n
    • \n

      The HTTP status code 405 Method Not Allowed.

      \n
      • \n
    • \n

      If the request contains an Accept header with a value of text/html, the response includes a CAPTCHA JavaScript page interstitial.

      \n
      • \n
    \n
    • \n
\n

You can configure the expiration time \n in the CaptchaConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" } }, "com.amazonaws.wafv2#CaptchaConfig": { @@ -2243,7 +2286,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

\n
    \n
  • \n

    If the request includes a valid, unexpired challenge token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.

    \n
    • \n
  • \n

    If the request doesn't include a valid, unexpired challenge token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

    \n

    WAF then generates a challenge response that it sends back to the client, which includes the following:

    \n
      \n
    • \n

      The header x-amzn-waf-action with a value of challenge.

      \n
      • \n
    • \n

      The HTTP status code 202 Request Accepted.

      \n
      • \n
    • \n

      If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.

      \n
      • \n
    \n

    Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.

    \n

    A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.

    \n

    After the client session successfully responds to \n the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.

    \n
    • \n
\n

You can configure the expiration time \n in the ChallengeConfig \n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" + "smithy.api#documentation": "

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

\n
    \n
  • \n

    If the request includes a valid, unexpired challenge token,\n WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to \n proceed to the next rule, similar to a CountAction.

    \n
    • \n
  • \n

    If the request doesn't include a valid, unexpired challenge token, WAF \n discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

    \n

    WAF then generates a challenge response that it sends back to the client, which includes the following:

    \n
      \n
    • \n

      The header x-amzn-waf-action with a value of challenge.

      \n
      • \n
    • \n

      The HTTP status code 202 Request Accepted.

      \n
      • \n
    • \n

      If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.

      \n
      • \n
    \n

    Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.

    \n

    A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.

    \n

    After the client session successfully responds to \n the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.

    \n
    • \n
\n

You can configure the expiration time \n in the ChallengeConfig\n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

" } }, "com.amazonaws.wafv2#ChallengeConfig": { @@ -2503,7 +2546,7 @@ } }, "traits": { - "smithy.api#documentation": "

Inspect the cookies in the web request. You can specify the parts of the cookies to\n inspect and you can narrow the set of cookies to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" + "smithy.api#documentation": "

Inspect the cookies in the web request. You can specify the parts of the cookies to\n inspect and you can narrow the set of cookies to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" } }, "com.amazonaws.wafv2#CountAction": { @@ -4110,7 +4153,7 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": [] \n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": []\n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", "smithy.api#required": {} } }, @@ -4288,7 +4331,7 @@ "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

", + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

", "smithy.api#required": {} } }, @@ -4320,7 +4363,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } } } @@ -4444,7 +4487,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } }, "CaptchaConfig": { @@ -4462,7 +4505,7 @@ "TokenDomains": { "target": "com.amazonaws.wafv2#TokenDomains", "traits": { - "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

" + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

" } } } @@ -5167,7 +5210,7 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n \n
    • \n
" + "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" } }, "AvailableLabels": { @@ -5216,7 +5259,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

\n \n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

\n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
", "smithy.api#required": {} } } @@ -5556,7 +5599,7 @@ "ManagedRuleGroupStatement": { "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.

\n " + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.

\n " } }, "RuleGroupReferenceStatement": { @@ -5576,20 +5619,20 @@ "HeaderName": { "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", "traits": { - "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", + "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", "smithy.api#required": {} } }, "FallbackBehavior": { "target": "com.amazonaws.wafv2#FallbackBehavior", "traits": { - "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n

You can specify the following fallback behaviors:

\n
    \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule statement.

    \n
    • \n
", + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

You can specify the following fallback behaviors:

\n
    \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule statement.

    \n
    • \n
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

WAF only evaluates the first IP address found in the specified HTTP header.\n

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

WAF only evaluates the first IP address found in the specified HTTP header.\n

" } }, "com.amazonaws.wafv2#ForwardedIPHeaderName": { @@ -5693,12 +5736,12 @@ "ForwardedIPConfig": { "target": "com.amazonaws.wafv2#ForwardedIPConfig", "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " } } }, "traits": { - "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n
    \n
  • \n

    To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.

    \n
    • \n
  • \n

    Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.

    \n
    • \n
\n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" + "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n
    \n
  • \n

    To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.

    \n
    • \n
  • \n

    Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.

    \n
    • \n
\n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" } }, "com.amazonaws.wafv2#GetIPSet": { @@ -5851,7 +5894,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", "smithy.api#required": {} } }, @@ -6362,7 +6405,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.

\n \n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.

\n

The ARN must be in one of the following formats:

\n
    \n
  • \n

    For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id\n \n

    \n
    • \n
  • \n

    For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name\n \n

    \n
    • \n
  • \n

    For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId\n \n

    \n
    • \n
  • \n

    For an Amazon Cognito user pool: arn:aws:cognito-idp:region:account-id:userpool/user-pool-id\n \n

    \n
    • \n
", "smithy.api#required": {} } } @@ -6574,7 +6617,7 @@ } }, "traits": { - "smithy.api#documentation": "

Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

If you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.

\n

Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" + "smithy.api#documentation": "

Inspect all headers in the web request. You can specify the parts of the headers to\n inspect and you can narrow the set of headers to inspect by including or excluding specific\n keys.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

If you want to inspect just the value of a single header, use the\n SingleHeader\n FieldToMatch setting instead.

\n

Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\",\n \"OversizeHandling\": \"MATCH\" }\n

" } }, "com.amazonaws.wafv2#IPAddress": { @@ -6650,7 +6693,7 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": [] \n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": []\n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", "smithy.api#required": {} } } @@ -6665,14 +6708,14 @@ "HeaderName": { "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", "traits": { - "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", + "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", "smithy.api#required": {} } }, "FallbackBehavior": { "target": "com.amazonaws.wafv2#FallbackBehavior", "traits": { - "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n

You can specify the following fallback behaviors:

\n
    \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule statement.

    \n
    • \n
", + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

You can specify the following fallback behaviors:

\n
    \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule statement.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -6685,7 +6728,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" } }, "com.amazonaws.wafv2#IPSetReferenceStatement": { @@ -6701,12 +6744,12 @@ "IPSetForwardedIPConfig": { "target": "com.amazonaws.wafv2#IPSetForwardedIPConfig", "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " } } }, "traits": { - "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" } }, "com.amazonaws.wafv2#IPSetSummaries": { @@ -6819,7 +6862,7 @@ } }, "traits": { - "smithy.api#documentation": "

Inspect the body of the web request as JSON. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.\n

\n

Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n

" + "smithy.api#documentation": "

Inspect the body of the web request as JSON. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you indicate.\n

\n

Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\"\n }\n

" } }, "com.amazonaws.wafv2#JsonMatchPattern": { @@ -7798,7 +7841,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.

\n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" + "smithy.api#documentation": "

Defines an association between logging destinations and a web ACL resource, for logging\n from WAF. As part of the association, you can specify parts of the standard logging\n fields to keep out of the logs and you can specify filters so that you log only a subset of\n the logging records.

\n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    \n

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    \n

    For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" } }, "com.amazonaws.wafv2#LoggingConfigurations": { @@ -7874,7 +7917,7 @@ } }, "traits": { - "smithy.api#documentation": "

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

\n

Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.

\n

For example specifications, see the examples section of CreateWebACL.

" + "smithy.api#documentation": "

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

\n

Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.

\n

For example specifications, see the examples section of CreateWebACL.

" } }, "com.amazonaws.wafv2#ManagedRuleGroupConfigs": { @@ -7937,7 +7980,7 @@ } }, "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.

\n " + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.

\n " } }, "com.amazonaws.wafv2#ManagedRuleGroupSummaries": { @@ -8011,7 +8054,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", "smithy.api#required": {} } }, @@ -8050,7 +8093,7 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n \n
    • \n
" + "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" } } }, @@ -8070,7 +8113,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

" + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

" } }, "Id": { @@ -8100,7 +8143,7 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n \n
    • \n
" + "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" } } }, @@ -8121,7 +8164,7 @@ "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" } }, "ForecastedLifetime": { @@ -8180,7 +8223,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"Method\": {}\n

" + "smithy.api#documentation": "

Inspect the HTTP method of the web request. The method indicates the type of operation\n that the request is asking the origin to perform.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"Method\": {}\n

" } }, "com.amazonaws.wafv2#MetricName": { @@ -8239,7 +8282,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

\n

JSON specification: \"None\": {}\n

" + "smithy.api#documentation": "

Specifies that WAF should do nothing. This is used for the\n OverrideAction setting on a Rule when the rule uses a\n rule group reference statement.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

\n

JSON specification: \"None\": {}\n

" } }, "com.amazonaws.wafv2#NotStatement": { @@ -8874,7 +8917,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.

\n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

\n \n

This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.

\n " + "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.

\n \n

You can define one logging destination per web ACL.

\n \n

You can access information about the traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.

    \n

    The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to configure additional settings or permissions.

    \n

    For configuration requirements and pricing information for each destination type, see \n Logging web ACL traffic \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n

For additional information about web ACL logging, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

\n \n

This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.

\n " } }, "com.amazonaws.wafv2#PutLoggingConfigurationRequest": { @@ -8926,7 +8969,7 @@ } ], "traits": { - "smithy.api#documentation": "

Defines the versions of your managed rule set that you are offering to the customers.\n Customers see your offerings as managed rule groups with versioning.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n \n

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your\n managed rule set is the name the customer sees for the corresponding managed rule group.\n Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group\n specification for each version. For each managed rule set, you must specify a version that\n you recommend using.

\n

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

" + "smithy.api#documentation": "

Defines the versions of your managed rule set that you are offering to the customers.\n Customers see your offerings as managed rule groups with versioning.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n \n

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your\n managed rule set is the name the customer sees for the corresponding managed rule group.\n Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group\n specification for each version. For each managed rule set, you must specify a version that\n you recommend using.

\n

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

" } }, "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest": { @@ -8935,7 +8978,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", "smithy.api#required": {} } }, @@ -9024,7 +9067,7 @@ "Policy": { "target": "com.amazonaws.wafv2#PolicyString", "traits": { - "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n \n

The policy specifications must conform to the following:

\n
    \n
  • \n

    The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.

    \n
    • \n
  • \n

    The policy must include specifications for Effect, Action, and Principal.

    \n
    • \n
  • \n

    \n Effect must specify Allow.

    \n
    • \n
  • \n

    \n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.

    \n
    • \n
  • \n

    The policy must not include a Resource parameter.

    \n
    • \n
\n

For more information, see IAM Policies.

", + "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n

The policy specifications must conform to the following:

\n
    \n
  • \n

    The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.

    \n
    • \n
  • \n

    The policy must include specifications for Effect, Action, and Principal.

    \n
    • \n
  • \n

    \n Effect must specify Allow.

    \n
    • \n
  • \n

    \n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.

    \n
    • \n
  • \n

    The policy must not include a Resource parameter.

    \n
    • \n
\n

For more information, see IAM Policies.

", "smithy.api#required": {} } } @@ -9038,7 +9081,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Inspect the query string of the web request. This is the part of a URL that appears\n after a ? character, if any.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"QueryString\": {}\n

" + "smithy.api#documentation": "

Inspect the query string of the web request. This is the part of a URL that appears\n after a ? character, if any.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"QueryString\": {}\n

" } }, "com.amazonaws.wafv2#RateBasedStatement": { @@ -9068,12 +9111,12 @@ "ForwardedIPConfig": { "target": "com.amazonaws.wafv2#ForwardedIPConfig", "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This is required if AggregateKeyType is set to\n FORWARDED_IP.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n

This is required if AggregateKeyType is set to\n FORWARDED_IP.

" } } }, "traits": { - "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

\n

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n
    \n
  • \n

    An IP match statement with an IP set that specified the address 192.0.2.44.

    \n
    • \n
  • \n

    A string match statement that searches in the User-Agent header for the string BadBot.

    \n
    • \n
\n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

" + "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

\n

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n
    \n
  • \n

    An IP match statement with an IP set that specified the address 192.0.2.44.

    \n
    • \n
  • \n

    A string match statement that searches in the User-Agent header for the string BadBot.

    \n
    • \n
\n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

" } }, "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType": { @@ -9242,7 +9285,7 @@ } }, "traits": { - "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" } }, "com.amazonaws.wafv2#RegexPatternSetSummaries": { @@ -9452,7 +9495,7 @@ "Action": { "target": "com.amazonaws.wafv2#RuleAction", "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

\n

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

You must specify either this Action setting or the rule OverrideAction setting, but not both:

\n
    \n
  • \n

    If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

    \n
    • \n
  • \n

    If the rule statement references a rule group, use the override action setting and not this action setting.

    \n
    • \n
" + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

\n

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

You must specify either this Action setting or the rule OverrideAction setting, but not both:

\n
    \n
  • \n

    If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.

    \n
    • \n
  • \n

    If the rule statement references a rule group, use the override action setting and not this action setting.

    \n
    • \n
" } }, "OverrideAction": { @@ -9584,7 +9627,7 @@ "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

", + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

", "smithy.api#required": {} } }, @@ -9617,13 +9660,13 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for your rule groups is the following:

    \n

    \n awswaf::rulegroup::\n

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n \n
    • \n
" + "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for your rule groups is the following:

    \n

    \n awswaf::rulegroup::\n

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" } }, "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } }, "AvailableLabels": { @@ -9906,7 +9949,7 @@ } }, "traits": { - "smithy.api#documentation": "

Inspect one of the headers in the web request, identified by name, for example,\n User-Agent or Referer. The name isn't case sensitive.

\n

You can filter and inspect all headers with the FieldToMatch setting\n Headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" + "smithy.api#documentation": "

Inspect one of the headers in the web request, identified by name, for example,\n User-Agent or Referer. The name isn't case sensitive.

\n

You can filter and inspect all headers with the FieldToMatch setting\n Headers.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" } }, "com.amazonaws.wafv2#SingleQueryArgument": { @@ -9921,7 +9964,7 @@ } }, "traits": { - "smithy.api#documentation": "

Inspect one query argument in the web request, identified by name, for example\n UserName or SalesRegion. The name isn't case\n sensitive.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + "smithy.api#documentation": "

Inspect one query argument in the web request, identified by name, for example\n UserName or SalesRegion. The name isn't case\n sensitive.

\n

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" } }, "com.amazonaws.wafv2#Size": { @@ -9968,7 +10011,7 @@ } }, "traits": { - "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" + "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" } }, "com.amazonaws.wafv2#SolveTimestamp": { @@ -9994,7 +10037,7 @@ "SensitivityLevel": { "target": "com.amazonaws.wafv2#SensitivityLevel", "traits": { - "smithy.api#documentation": "

The sensitivity that you want WAF to use to inspect for SQL injection attacks.

\n

\n HIGH detects more attacks, but might generate more false positives, \n especially if your web requests frequently contain unusual strings. \n For information about identifying and mitigating false positives, see \n Testing and tuning in the \n WAF Developer Guide.

\n

\n LOW is generally a better choice for resources that already have other \n protections against SQL injection attacks or that have a low tolerance for false positives.

\n

Default: LOW\n

" + "smithy.api#documentation": "

The sensitivity that you want WAF to use to inspect for SQL injection attacks.

\n

\n HIGH detects more attacks, but might generate more false positives, \n especially if your web requests frequently contain unusual strings. \n For information about identifying and mitigating false positives, see \n Testing and tuning in the \n WAF Developer Guide.

\n

\n LOW is generally a better choice for resources that already have other \n protections against SQL injection attacks or that have a low tolerance for false positives.

\n

Default: LOW\n

" } } }, @@ -10026,13 +10069,13 @@ "SizeConstraintStatement": { "target": "com.amazonaws.wafv2#SizeConstraintStatement", "traits": { - "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" + "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" } }, "GeoMatchStatement": { "target": "com.amazonaws.wafv2#GeoMatchStatement", "traits": { - "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n
    \n
  • \n

    To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.

    \n
    • \n
  • \n

    Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.

    \n
    • \n
\n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" + "smithy.api#documentation": "

A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.

\n
    \n
  • \n

    To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array.

    \n
    • \n
  • \n

    Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.

    \n
    • \n
\n

WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig.

\n

If you use the web request origin, the label formats are awswaf:clientip:geo:region:- and awswaf:clientip:geo:country:.

\n

If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:- and awswaf:forwardedip:geo:country:.

\n

For additional details, see Geographic match rule statement in the WAF Developer Guide.

" } }, "RuleGroupReferenceStatement": { @@ -10044,19 +10087,19 @@ "IPSetReferenceStatement": { "target": "com.amazonaws.wafv2#IPSetReferenceStatement", "traits": { - "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" } }, "RegexPatternSetReferenceStatement": { "target": "com.amazonaws.wafv2#RegexPatternSetReferenceStatement", "traits": { - "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" + "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" } }, "RateBasedStatement": { "target": "com.amazonaws.wafv2#RateBasedStatement", "traits": { - "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

\n

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n
    \n
  • \n

    An IP match statement with an IP set that specified the address 192.0.2.44.

    \n
    • \n
  • \n

    A string match statement that searches in the User-Agent header for the string BadBot.

    \n
    • \n
\n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

" + "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

\n

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n
    \n
  • \n

    An IP match statement with an IP set that specified the address 192.0.2.44.

    \n
    • \n
  • \n

    A string match statement that searches in the User-Agent header for the string BadBot.

    \n
    • \n
\n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

" } }, "AndStatement": { @@ -10080,7 +10123,7 @@ "ManagedRuleGroupStatement": { "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.

\n " + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

\n \n

You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet or the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For more information, see WAF Pricing.

\n " } }, "LabelMatchStatement": { @@ -10575,7 +10618,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.

\n \n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.

\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" } }, "com.amazonaws.wafv2#UpdateIPSetRequest": { @@ -10611,7 +10654,7 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": [] \n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"] \n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"] \n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", + "smithy.api#documentation": "

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Example address strings:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

\n

Example JSON Addresses specifications:

\n
    \n
  • \n

    Empty array: \"Addresses\": []\n

    \n
    • \n
  • \n

    Array with one address: \"Addresses\": [\"192.0.2.44/32\"]\n

    \n
    • \n
  • \n

    Array with three addresses: \"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]\n

    \n
    • \n
  • \n

    INVALID specification: \"Addresses\": [\"\"] INVALID

    \n
    • \n
", "smithy.api#required": {} } }, @@ -10670,7 +10713,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", "smithy.api#required": {} } }, @@ -10766,7 +10809,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.

\n \n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.

\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" } }, "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { @@ -10867,7 +10910,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.

\n \n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" + "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.

\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" } }, "com.amazonaws.wafv2#UpdateRuleGroupRequest": { @@ -10923,7 +10966,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } } } @@ -10986,7 +11029,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.

\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.

\n \n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.

" + "smithy.api#documentation": "

Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.

\n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.

\n \n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.

" } }, "com.amazonaws.wafv2#UpdateWebACLRequest": { @@ -11049,7 +11092,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } }, "CaptchaConfig": { @@ -11067,7 +11110,7 @@ "TokenDomains": { "target": "com.amazonaws.wafv2#TokenDomains", "traits": { - "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

" + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

" } } } @@ -11087,7 +11130,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Inspect the path component of the URI of the web request. This is the part of the web\n request that identifies a resource. For example, /images/daily-ad.jpg.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"UriPath\": {}\n

" + "smithy.api#documentation": "

Inspect the path component of the URI of the web request. This is the part of the web\n request that identifies a resource. For example, /images/daily-ad.jpg.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"UriPath\": {}\n

" } }, "com.amazonaws.wafv2#UsernameField": { @@ -11295,7 +11338,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation failed because the specified policy isn't in the proper format.

\n \n

The policy specifications must conform to the following:

\n
    \n
  • \n

    The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.

    \n
    • \n
  • \n

    The policy must include specifications for Effect, Action, and Principal.

    \n
    • \n
  • \n

    \n Effect must specify Allow.

    \n
    • \n
  • \n

    \n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.

    \n
    • \n
  • \n

    The policy must not include a Resource parameter.

    \n
    • \n
\n

For more information, see IAM Policies.

", + "smithy.api#documentation": "

The operation failed because the specified policy isn't in the proper format.

\n

The policy specifications must conform to the following:

\n
    \n
  • \n

    The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.

    \n
    • \n
  • \n

    The policy must include specifications for Effect, Action, and Principal.

    \n
    • \n
  • \n

    \n Effect must specify Allow.

    \n
    • \n
  • \n

    \n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and \n wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. \n WAF rejects any extra actions or wildcard actions in the policy.

    \n
    • \n
  • \n

    The policy must not include a Resource parameter.

    \n
    • \n
\n

For more information, see IAM Policies.

", "smithy.api#error": "client" } }, @@ -11498,13 +11541,13 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a web ACL is the following:

    \n

    \n awswaf::webacl::\n

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n \n
    • \n
" + "smithy.api#documentation": "

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a web ACL is the following:

    \n

    \n awswaf::webacl::\n

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n
    • \n
" } }, "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "traits": { - "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" + "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } }, "CaptchaConfig": {