From 9fac3673d9126d28dd6c24b25924ceafd214c3ce Mon Sep 17 00:00:00 2001 From: aws-sdk-go-automation <43143561+aws-sdk-go-automation@users.noreply.github.com> Date: Wed, 1 Feb 2023 11:21:07 -0800 Subject: [PATCH] Release v1.44.192 (2023-02-01) (#4712) Release v1.44.192 (2023-02-01) === ### Service Client Updates * `service/devops-guru`: Updates service API and documentation * `service/forecast`: Updates service API and documentation * `service/iam`: Updates service documentation * Documentation updates for AWS Identity and Access Management (IAM). * `service/mediatailor`: Updates service API and documentation * `service/sns`: Updates service documentation * Additional attributes added for set-topic-attributes. --- CHANGELOG.md | 12 + aws/endpoints/defaults.go | 127 +++- aws/version.go | 2 +- models/apis/devops-guru/2020-12-01/api-2.json | 9 +- .../apis/devops-guru/2020-12-01/docs-2.json | 7 + .../2020-12-01/endpoint-rule-set-1.json | 11 +- .../2020-12-01/endpoint-tests-1.json | 268 ++++----- models/apis/forecast/2018-06-26/api-2.json | 16 +- models/apis/forecast/2018-06-26/docs-2.json | 86 +-- .../2018-06-26/endpoint-rule-set-1.json | 306 ++++++++++ .../forecast/2018-06-26/endpoint-tests-1.json | 563 ++++++++++++++++++ models/apis/iam/2010-05-08/docs-2.json | 26 +- .../iam/2010-05-08/endpoint-rule-set-1.json | 191 ++---- .../apis/iam/2010-05-08/endpoint-tests-1.json | 359 ++++++++++- models/apis/mediatailor/2018-04-23/api-2.json | 79 +++ .../apis/mediatailor/2018-04-23/docs-2.json | 60 +- .../2018-04-23/endpoint-tests-1.json | 202 +++---- models/apis/sns/2010-03-31/docs-2.json | 6 +- .../sns/2010-03-31/endpoint-rule-set-1.json | 11 +- .../apis/sns/2010-03-31/endpoint-tests-1.json | 52 ++ models/endpoints/endpoints.json | 81 ++- service/devopsguru/api.go | 41 ++ service/forecastservice/api.go | 445 ++++++++------ service/iam/api.go | 108 +++- service/mediatailor/api.go | 483 +++++++++++++++ .../mediatailor/mediatailoriface/interface.go | 4 + service/sns/api.go | 76 ++- 27 files changed, 2908 insertions(+), 723 deletions(-) create mode 100644 models/apis/forecast/2018-06-26/endpoint-rule-set-1.json create mode 100644 models/apis/forecast/2018-06-26/endpoint-tests-1.json diff --git a/CHANGELOG.md b/CHANGELOG.md index 787bcda047b..86bc603e59f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ +Release v1.44.192 (2023-02-01) +=== + +### Service Client Updates +* `service/devops-guru`: Updates service API and documentation +* `service/forecast`: Updates service API and documentation +* `service/iam`: Updates service documentation + * Documentation updates for AWS Identity and Access Management (IAM). +* `service/mediatailor`: Updates service API and documentation +* `service/sns`: Updates service documentation + * Additional attributes added for set-topic-attributes. + Release v1.44.191 (2023-01-31) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index a4e81569d94..da3fadc8c5f 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -11197,6 +11197,9 @@ var awsPartition = partition{ }: endpoint{ Hostname: "fms-fips.ap-southeast-2.amazonaws.com", }, + endpointKey{ + Region: "ap-southeast-3", + }: endpoint{}, endpointKey{ Region: "ca-central-1", }: endpoint{}, @@ -11425,6 +11428,9 @@ var awsPartition = partition{ }, Deprecated: boxedTrue, }, + endpointKey{ + Region: "me-central-1", + }: endpoint{}, endpointKey{ Region: "me-south-1", }: endpoint{}, @@ -14299,14 +14305,14 @@ var awsPartition = partition{ Hostname: "kendra-ranking.ap-southeast-3.api.aws", }, endpointKey{ - Region: "ca-central-1", + Region: "ap-southeast-4", }: endpoint{ - Hostname: "kendra-ranking.ca-central-1.api.aws", + Hostname: "kendra-ranking.ap-southeast-4.api.aws", }, endpointKey{ - Region: "eu-central-1", + Region: "ca-central-1", }: endpoint{ - Hostname: "kendra-ranking.eu-central-1.api.aws", + Hostname: "kendra-ranking.ca-central-1.api.aws", }, endpointKey{ Region: "eu-central-2", @@ -14333,11 +14339,6 @@ var awsPartition = partition{ }: endpoint{ Hostname: "kendra-ranking.eu-west-1.api.aws", }, - endpointKey{ - Region: "eu-west-2", - }: endpoint{ - Hostname: "kendra-ranking.eu-west-2.api.aws", - }, endpointKey{ Region: "eu-west-3", }: endpoint{ @@ -33433,6 +33434,24 @@ var awsusgovPartition = partition{ }, "kinesis": service{ Endpoints: serviceEndpoints{ + endpointKey{ + Region: "fips-us-gov-east-1", + }: endpoint{ + Hostname: "kinesis.us-gov-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-east-1", + }, + Deprecated: boxedTrue, + }, + endpointKey{ + Region: "fips-us-gov-west-1", + }: endpoint{ + Hostname: "kinesis.us-gov-west-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-west-1", + }, + Deprecated: boxedTrue, + }, endpointKey{ Region: "us-gov-east-1", }: endpoint{ @@ -33441,6 +33460,15 @@ var awsusgovPartition = partition{ Region: "us-gov-east-1", }, }, + endpointKey{ + Region: "us-gov-east-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "kinesis.us-gov-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-east-1", + }, + }, endpointKey{ Region: "us-gov-west-1", }: endpoint{ @@ -33449,6 +33477,15 @@ var awsusgovPartition = partition{ Region: "us-gov-west-1", }, }, + endpointKey{ + Region: "us-gov-west-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "kinesis.us-gov-west-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-west-1", + }, + }, }, }, "kinesisanalytics": service{ @@ -34160,6 +34197,24 @@ var awsusgovPartition = partition{ Region: "us-gov-east-1", }, }, + endpointKey{ + Region: "us-gov-east-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "ram.us-gov-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-east-1", + }, + }, + endpointKey{ + Region: "us-gov-east-1-fips", + }: endpoint{ + Hostname: "ram.us-gov-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-east-1", + }, + Deprecated: boxedTrue, + }, endpointKey{ Region: "us-gov-west-1", }: endpoint{ @@ -34168,6 +34223,24 @@ var awsusgovPartition = partition{ Region: "us-gov-west-1", }, }, + endpointKey{ + Region: "us-gov-west-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "ram.us-gov-west-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-west-1", + }, + }, + endpointKey{ + Region: "us-gov-west-1-fips", + }: endpoint{ + Hostname: "ram.us-gov-west-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-west-1", + }, + Deprecated: boxedTrue, + }, }, }, "rbin": service{ @@ -35549,6 +35622,24 @@ var awsusgovPartition = partition{ Region: "us-gov-east-1", }, }, + endpointKey{ + Region: "us-gov-east-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "swf.us-gov-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-east-1", + }, + }, + endpointKey{ + Region: "us-gov-east-1-fips", + }: endpoint{ + Hostname: "swf.us-gov-east-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-east-1", + }, + Deprecated: boxedTrue, + }, endpointKey{ Region: "us-gov-west-1", }: endpoint{ @@ -35557,6 +35648,24 @@ var awsusgovPartition = partition{ Region: "us-gov-west-1", }, }, + endpointKey{ + Region: "us-gov-west-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "swf.us-gov-west-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-west-1", + }, + }, + endpointKey{ + Region: "us-gov-west-1-fips", + }: endpoint{ + Hostname: "swf.us-gov-west-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "us-gov-west-1", + }, + Deprecated: boxedTrue, + }, }, }, "synthetics": service{ diff --git a/aws/version.go b/aws/version.go index d475195cf0d..7969d9bf105 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.44.191" +const SDKVersion = "1.44.192" diff --git a/models/apis/devops-guru/2020-12-01/api-2.json b/models/apis/devops-guru/2020-12-01/api-2.json index 0cd92096ee5..a596ee051bf 100644 --- a/models/apis/devops-guru/2020-12-01/api-2.json +++ b/models/apis/devops-guru/2020-12-01/api-2.json @@ -1334,6 +1334,12 @@ "exception":true, "fault":true }, + "ListAnomaliesForInsightFilters":{ + "type":"structure", + "members":{ + "ServiceCollection":{"shape":"ServiceCollection"} + } + }, "ListAnomaliesForInsightMaxResults":{ "type":"integer", "max":500, @@ -1351,7 +1357,8 @@ "StartTimeRange":{"shape":"StartTimeRange"}, "MaxResults":{"shape":"ListAnomaliesForInsightMaxResults"}, "NextToken":{"shape":"UuidNextToken"}, - "AccountId":{"shape":"AwsAccountId"} + "AccountId":{"shape":"AwsAccountId"}, + "Filters":{"shape":"ListAnomaliesForInsightFilters"} } }, "ListAnomaliesForInsightResponse":{ diff --git a/models/apis/devops-guru/2020-12-01/docs-2.json b/models/apis/devops-guru/2020-12-01/docs-2.json index daaa1db4a26..27e95e4aef8 100644 --- a/models/apis/devops-guru/2020-12-01/docs-2.json +++ b/models/apis/devops-guru/2020-12-01/docs-2.json @@ -831,6 +831,12 @@ "refs": { } }, + "ListAnomaliesForInsightFilters": { + "base": "
Specifies one or more service names that are used to list anomalies.
", + "refs": { + "ListAnomaliesForInsightRequest$Filters": "Specifies one or more service names that are used to list anomalies.
" + } + }, "ListAnomaliesForInsightMaxResults": { "base": null, "refs": { @@ -1829,6 +1835,7 @@ "ServiceCollection": { "base": "A collection of the names of Amazon Web Services services.
", "refs": { + "ListAnomaliesForInsightFilters$ServiceCollection": null, "ProactiveInsightSummary$ServiceCollection": "A collection of the names of Amazon Web Services services.
", "ProactiveOrganizationInsightSummary$ServiceCollection": null, "ReactiveInsightSummary$ServiceCollection": "A collection of the names of Amazon Web Services services.
", diff --git a/models/apis/devops-guru/2020-12-01/endpoint-rule-set-1.json b/models/apis/devops-guru/2020-12-01/endpoint-rule-set-1.json index 396977d50f0..cc4fecffa0e 100644 --- a/models/apis/devops-guru/2020-12-01/endpoint-rule-set-1.json +++ b/models/apis/devops-guru/2020-12-01/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -52,15 +52,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", diff --git a/models/apis/devops-guru/2020-12-01/endpoint-tests-1.json b/models/apis/devops-guru/2020-12-01/endpoint-tests-1.json index 268ee8e4c28..5c3d00cd98c 100644 --- a/models/apis/devops-guru/2020-12-01/endpoint-tests-1.json +++ b/models/apis/devops-guru/2020-12-01/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-south-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -21,9 +21,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-south-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -34,9 +34,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-south-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -47,9 +47,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-south-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -60,9 +60,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ca-central-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -73,9 +73,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ca-central-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -86,9 +86,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ca-central-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -99,9 +99,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ca-central-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -112,9 +112,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-central-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -125,9 +125,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-central-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -138,9 +138,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-central-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -151,9 +151,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-central-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -164,9 +164,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -177,9 +177,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -190,9 +190,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -203,9 +203,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -216,9 +216,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-west-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -229,9 +229,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-west-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -242,9 +242,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-west-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -255,9 +255,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-west-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -268,9 +268,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-north-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -281,9 +281,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-north-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -294,9 +294,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-north-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -307,9 +307,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-north-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -320,9 +320,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-3", - "UseDualStack": true + "UseFIPS": true } }, { @@ -333,9 +333,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-3", - "UseDualStack": false + "UseFIPS": true } }, { @@ -346,9 +346,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-3", - "UseDualStack": true + "UseFIPS": false } }, { @@ -359,9 +359,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-3", - "UseDualStack": false + "UseFIPS": false } }, { @@ -372,9 +372,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -385,9 +385,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -398,9 +398,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -411,9 +411,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -424,9 +424,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "eu-west-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -437,9 +437,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "eu-west-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -450,9 +450,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "eu-west-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -463,9 +463,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "eu-west-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -476,9 +476,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -489,9 +489,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -502,9 +502,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -515,9 +515,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -528,9 +528,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-northeast-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -541,9 +541,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-northeast-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -554,9 +554,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-northeast-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -567,9 +567,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-northeast-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -580,9 +580,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "sa-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -593,9 +593,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "sa-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -606,9 +606,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "sa-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -619,9 +619,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "sa-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -632,9 +632,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -645,9 +645,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -658,9 +658,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -671,9 +671,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -684,9 +684,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "ap-southeast-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -697,9 +697,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "ap-southeast-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -710,9 +710,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "ap-southeast-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -723,9 +723,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "ap-southeast-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -736,9 +736,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-1", - "UseDualStack": true + "UseFIPS": true } }, { @@ -749,9 +749,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-1", - "UseDualStack": false + "UseFIPS": true } }, { @@ -762,9 +762,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-1", - "UseDualStack": true + "UseFIPS": false } }, { @@ -775,9 +775,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-1", - "UseDualStack": false + "UseFIPS": false } }, { @@ -788,9 +788,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": true, "Region": "us-east-2", - "UseDualStack": true + "UseFIPS": true } }, { @@ -801,9 +801,9 @@ } }, "params": { - "UseFIPS": true, + "UseDualStack": false, "Region": "us-east-2", - "UseDualStack": false + "UseFIPS": true } }, { @@ -814,9 +814,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": true, "Region": "us-east-2", - "UseDualStack": true + "UseFIPS": false } }, { @@ -827,9 +827,9 @@ } }, "params": { - "UseFIPS": false, + "UseDualStack": false, "Region": "us-east-2", - "UseDualStack": false + "UseFIPS": false } }, { @@ -840,9 +840,9 @@ } }, "params": { - "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -852,9 +852,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" } }, @@ -864,9 +864,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/models/apis/forecast/2018-06-26/api-2.json b/models/apis/forecast/2018-06-26/api-2.json index 93c8737fcf8..db7b31ce93b 100644 --- a/models/apis/forecast/2018-06-26/api-2.json +++ b/models/apis/forecast/2018-06-26/api-2.json @@ -1127,7 +1127,8 @@ "UseGeolocationForTimeZone":{"shape":"UseGeolocationForTimeZone"}, "GeolocationFormat":{"shape":"GeolocationFormat"}, "Tags":{"shape":"Tags"}, - "Format":{"shape":"Format"} + "Format":{"shape":"Format"}, + "ImportMode":{"shape":"ImportMode"} } }, "CreateDatasetImportJobResponse":{ @@ -1423,7 +1424,8 @@ "Status":{"shape":"Status"}, "Message":{"shape":"ErrorMessage"}, "CreationTime":{"shape":"Timestamp"}, - "LastModificationTime":{"shape":"Timestamp"} + "LastModificationTime":{"shape":"Timestamp"}, + "ImportMode":{"shape":"ImportMode"} } }, "DatasetImportJobs":{ @@ -1643,7 +1645,8 @@ "Message":{"shape":"Message"}, "CreationTime":{"shape":"Timestamp"}, "LastModificationTime":{"shape":"Timestamp"}, - "Format":{"shape":"Format"} + "Format":{"shape":"Format"}, + "ImportMode":{"shape":"ImportMode"} } }, "DescribeDatasetRequest":{ @@ -2196,6 +2199,13 @@ "ParameterRanges":{"shape":"ParameterRanges"} } }, + "ImportMode":{ + "type":"string", + "enum":[ + "FULL", + "INCREMENTAL" + ] + }, "InputDataConfig":{ "type":"structure", "required":["DatasetGroupArn"], diff --git a/models/apis/forecast/2018-06-26/docs-2.json b/models/apis/forecast/2018-06-26/docs-2.json index 62e3bb356da..82188cb64d5 100644 --- a/models/apis/forecast/2018-06-26/docs-2.json +++ b/models/apis/forecast/2018-06-26/docs-2.json @@ -5,17 +5,17 @@ "CreateAutoPredictor": "Creates an Amazon Forecast predictor.
Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors.
Creating new predictors
The following parameters are required when creating a new predictor:
PredictorName
- A unique name for the predictor.
DatasetGroupArn
- The ARN of the dataset group used to train the predictor.
ForecastFrequency
- The granularity of your forecasts (hourly, daily, weekly, etc).
ForecastHorizon
- The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
When creating a new predictor, do not specify a value for ReferencePredictorArn
.
Upgrading and retraining predictors
The following parameters are required when retraining or upgrading a predictor:
PredictorName
- A unique name for the predictor.
ReferencePredictorArn
- The ARN of the predictor to retrain or upgrade.
When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn
and PredictorName
.
Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:
DataFrequency
- How frequently your historical time-series data is collected.
Domain
and DatasetType
- Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.
Schema
- A schema specifies the fields in the dataset, including the field name and data type.
After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets.
To get a list of all your datasets, use the ListDatasets operation.
For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.
The Status
of a dataset must be ACTIVE
before you can import training data. Use the DescribeDataset operation to get the status.
Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups.
To get a list of all your datasets groups, use the ListDatasetGroups operation.
The Status
of a dataset group must be ACTIVE
before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.
You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see Set up permissions.
The training data must be in CSV or Parquet format. The delimiter must be a comma (,).
You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.
Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.
To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
", + "CreateDatasetImportJob": "Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.
You must specify a DataSource object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal Amazon Web Services system. For more information, see Set up permissions.
The training data must be in CSV or Parquet format. The delimiter must be a comma (,).
You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.
Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.
To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
", "CreateExplainability": "Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor)
Creates an Amazon Forecast Explainability.
Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values.
To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index.
CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN.
CreateExplainability with a Predictor ARN
You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor
in CreateAutoPredictor, that predictor already has an Explainability resource.
The following parameters are required when providing a Predictor ARN:
ExplainabilityName
- A unique name for the Explainability.
ResourceArn
- The Arn of the predictor.
TimePointGranularity
- Must be set to “ALL”.
TimeSeriesGranularity
- Must be set to “ALL”.
Do not specify a value for the following parameters:
DataSource
- Only valid when TimeSeriesGranularity is “SPECIFIC”.
Schema
- Only valid when TimeSeriesGranularity is “SPECIFIC”.
StartDateTime
- Only valid when TimePointGranularity is “SPECIFIC”.
EndDateTime
- Only valid when TimePointGranularity is “SPECIFIC”.
CreateExplainability with a Forecast ARN
You can specify a maximum of 50 time series and 500 time points.
The following parameters are required when providing a Predictor ARN:
ExplainabilityName
- A unique name for the Explainability.
ResourceArn
- The Arn of the forecast.
TimePointGranularity
- Either “ALL” or “SPECIFIC”.
TimeSeriesGranularity
- Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:
DataSource
- The S3 location of the CSV file specifying your time series.
Schema
- The Schema defines the attributes and attribute types listed in the Data Source.
If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:
StartDateTime
- The first timestamp in the range of time points.
EndDateTime
- The last timestamp in the range of time points.
Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.
You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status
of the export job must be ACTIVE
before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.
You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status
of the export job must be ACTIVE
before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
Creates a forecast for each item in the TARGET_TIME_SERIES
dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.
The range of the forecast is determined by the ForecastHorizon
value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.
To get a list of all your forecasts, use the ListForecasts operation.
The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.
For more information, see howitworks-forecast.
The Status
of the forecast must be ACTIVE
before you can query or export the forecast. Use the DescribeForecast operation to get the status.
By default, a forecast includes predictions for every item (item_id
) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector
object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.
The Status
of the forecast export job must be ACTIVE
before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.
The Status
of the forecast export job must be ACTIVE
before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.
Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
", "CreatePredictor": "This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor.
Creates an Amazon Forecast predictor.
In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.
Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.
To see the evaluation metrics, use the GetAccuracyMetrics operation.
You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES
dataset to improve model training. For more information, see FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor
verifies that the DataFrequency
specified when the dataset was created matches the ForecastFrequency
. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.
By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes
.
AutoML
If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function
, set PerformAutoML
to true
. The objective function
is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
AlgorithmArn
HPOConfig
PerformHPO
TrainingParameters
To get a list of all of your predictors, use the ListPredictors operation.
Before you can use the predictor to create a forecast, the Status
of the predictor must be ACTIVE
, signifying that training has completed. To get the status, use the DescribePredictor operation.
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket.
The export file names will match the following conventions:
<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status
of the export job must be ACTIVE
before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.
For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals. You could create a scenario where everything is given a 25% markdown and another where everything is given a fixed dollar markdown. You can create a scenario where the sale lasts for 1 week and another where the sale lasts for 1 month. Your what-if analysis enables you to compare many different scenarios against each other.
Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.
The TimeSeriesSelector object defines the items that you want in the what-if analysis.
", + "CreatePredictorBacktestExportJob": "Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket.
The export file names will match the following conventions:
<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status
of the export job must be ACTIVE
before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.
For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals.
You could create a scenario where everything is given a 25% markdown, and another where everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale lasts for one month. With a what-if analysis, you can compare many different scenarios against each other.
Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.
The TimeSeriesSelector object defines the items that you want in the what-if analysis.
", "CreateWhatIfForecast": "A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.
", - "CreateWhatIfForecastExport": "Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.
The Status
of the forecast export job must be ACTIVE
before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.
The Status
of the forecast export job must be ACTIVE
before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE
or CREATE_FAILED
. To get the status use the DescribeDataset operation.
Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup operation, omitting the deleted dataset's ARN.
Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE
, CREATE_FAILED
, or UPDATE_FAILED
. To get the status, use the DescribeDatasetGroup operation.
This operation deletes only the dataset group, not the datasets in the group.
", "DeleteDatasetImportJob": "Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE
or CREATE_FAILED
. To get the status, use the DescribeDatasetImportJob operation.
The Amazon Resource Name (ARN) of the what-if analysis.
", "DescribeWhatIfAnalysisResponse$ForecastArn": "The Amazon Resource Name (ARN) of the what-if forecast.
", "DescribeWhatIfForecastResponse$WhatIfAnalysisArn": "The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
", - "EncryptionConfig$RoleArn": "The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException
error.
The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.
Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException
error.
The Amazon Resource Name (ARN) of the algorithm that was evaluated.
", "ExplainabilityExportSummary$ExplainabilityExportArn": "The Amazon Resource Name (ARN) of the Explainability export.
", "ExplainabilityInfo$ExplainabilityArn": "The Amazon Resource Name (ARN) of the Explainability.
", @@ -189,7 +189,7 @@ "PredictorSummary$DatasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
", "ReferencePredictorSummary$Arn": "The ARN of the reference predictor.
", "ResumeResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the monitor resource to resume.
", - "S3Config$RoleArn": "The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn
key, the role must allow access to the key.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException
error.
The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn
key, the role must allow access to the key.
Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException
error.
The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are DatasetImportJobArn
, PredictorArn
, PredictorBacktestExportJobArn
, ForecastArn
, ForecastExportJobArn
, ExplainabilityArn
, and ExplainabilityExportArn
.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
", @@ -237,9 +237,9 @@ "AutoMLOverrideStrategy": { "base": null, "refs": { - "CreatePredictorRequest$AutoMLOverrideStrategy": " The LatencyOptimized
AutoML override strategy is only available in private beta. Contact AWS Support or your account manager to learn more about access privileges.
Used to overide the default AutoML strategy, which is to optimize predictor accuracy. To apply an AutoML strategy that minimizes training time, use LatencyOptimized
.
This parameter is only valid for predictors trained using AutoML.
", - "DescribePredictorResponse$AutoMLOverrideStrategy": " The LatencyOptimized
AutoML override strategy is only available in private beta. Contact AWS Support or your account manager to learn more about access privileges.
The AutoML strategy used to train the predictor. Unless LatencyOptimized
is specified, the AutoML strategy optimizes predictor accuracy.
This parameter is only valid for predictors trained using AutoML.
", - "GetAccuracyMetricsResponse$AutoMLOverrideStrategy": " The LatencyOptimized
AutoML override strategy is only available in private beta. Contact AWS Support or your account manager to learn more about access privileges.
The AutoML strategy used to train the predictor. Unless LatencyOptimized
is specified, the AutoML strategy optimizes predictor accuracy.
This parameter is only valid for predictors trained using AutoML.
" + "CreatePredictorRequest$AutoMLOverrideStrategy": " The LatencyOptimized
AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.
Used to overide the default AutoML strategy, which is to optimize predictor accuracy. To apply an AutoML strategy that minimizes training time, use LatencyOptimized
.
This parameter is only valid for predictors trained using AutoML.
", + "DescribePredictorResponse$AutoMLOverrideStrategy": " The LatencyOptimized
AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.
The AutoML strategy used to train the predictor. Unless LatencyOptimized
is specified, the AutoML strategy optimizes predictor accuracy.
This parameter is only valid for predictors trained using AutoML.
", + "GetAccuracyMetricsResponse$AutoMLOverrideStrategy": " The LatencyOptimized
AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.
The AutoML strategy used to train the predictor. Unless LatencyOptimized
is specified, the AutoML strategy optimizes predictor accuracy.
This parameter is only valid for predictors trained using AutoML.
" } }, "Baseline": { @@ -264,7 +264,7 @@ "base": null, "refs": { "CreateAutoPredictorRequest$ExplainPredictor": "Create an Explainability resource for the predictor.
", - "CreateExplainabilityRequest$EnableVisualization": "Create an Explainability visualization that is viewable within the AWS console.
", + "CreateExplainabilityRequest$EnableVisualization": "Create an Explainability visualization that is viewable within the Amazon Web Services console.
", "CreatePredictorRequest$PerformAutoML": "Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it provides and chooses the best algorithm and configuration for your training dataset.
The default value is false
. In this case, you are required to specify an algorithm.
Set PerformAutoML
to true
to have Amazon Forecast perform AutoML. This is a good option if you aren't sure which algorithm is suitable for your training data. In this case, PerformHPO
must be false.
Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as running a hyperparameter tuning job.
The default value is false
. In this case, Amazon Forecast uses default hyperparameter values from the chosen algorithm.
To override the default values, set PerformHPO
to true
and, optionally, supply the HyperParameterTuningJobConfig object. The tuning job specifies a metric to optimize, which hyperparameters participate in tuning, and the valid range for each tunable hyperparameter. In this case, you are required to specify an algorithm and PerformAutoML
must be false.
The following algorithms support HPO:
DeepAR+
CNN-QR
Whether the visualization was enabled for the Explainability resource.
", @@ -460,12 +460,12 @@ } }, "DataDestination": { - "base": "The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).
", + "base": "The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).
", "refs": { "CreateExplainabilityExportRequest$Destination": null, - "CreateForecastExportJobRequest$Destination": "The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.
The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.
The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.
The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
", "DescribePredictorBacktestExportJobResponse$Destination": null, @@ -477,12 +477,12 @@ } }, "DataSource": { - "base": "The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key.
", + "base": "The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.
", "refs": { - "CreateDatasetImportJobRequest$DataSource": "The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig
parameter of the CreateDataset operation.
The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
must include an Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig
parameter of the CreateDataset operation.
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
includes an AWS Key Management Service (KMS) key.
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
If encryption is used, DataSource
includes an AWS Key Management Service (KMS) key.
The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
includes an Key Management Service (KMS) key.
The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
If encryption is used, DataSource
includes an Key Management Service (KMS) key.
An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.
", + "base": "An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.
", "refs": { "CreateAutoPredictorRequest$EncryptionConfig": null, - "CreateDatasetRequest$EncryptionConfig": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
", - "CreatePredictorRequest$EncryptionConfig": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
", + "CreateDatasetRequest$EncryptionConfig": "An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
", + "CreatePredictorRequest$EncryptionConfig": "An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
", "DescribeAutoPredictorResponse$EncryptionConfig": null, - "DescribeDatasetResponse$EncryptionConfig": "The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
", - "DescribePredictorResponse$EncryptionConfig": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
" + "DescribeDatasetResponse$EncryptionConfig": "The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
", + "DescribePredictorResponse$EncryptionConfig": "An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
" } }, "ErrorMessage": { @@ -1021,7 +1021,7 @@ "DescribeAutoPredictorResponse$ForecastTypes": "The forecast types used during predictor training. Default value is [\"0.1\",\"0.5\",\"0.9\"].
", "DescribeForecastResponse$ForecastTypes": "The quantiles at which probabilistic forecasts were generated.
", "DescribePredictorResponse$ForecastTypes": "The forecast types used during predictor training. Default value is [\"0.1\",\"0.5\",\"0.9\"]
The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are [\"0.1\", \"0.5\", \"0.9\"]
.
The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are [\"0.1\", \"0.5\", \"0.9\"]
.
The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
", - "CreateDatasetRequest$DataFrequency": "The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"D\" indicates every day and \"15min\" indicates every 15 minutes.
", + "CreateAutoPredictorRequest$ForecastFrequency": "The frequency of predictions in a forecast.
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
Minute - 1-59
Hour - 1-23
Day - 1-6
Week - 1-4
Month - 1-11
Year - 1
Thus, if you want every other week forecasts, specify \"2W\". Or, if you want quarterly forecasts, you specify \"3M\".
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
", + "CreateDatasetRequest$DataFrequency": "The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
Minute - 1-59
Hour - 1-23
Day - 1-6
Week - 1-4
Month - 1-11
Year - 1
Thus, if you want every other week forecasts, specify \"2W\". Or, if you want quarterly forecasts, you specify \"3M\".
", "DescribeAutoPredictorResponse$ForecastFrequency": "The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.
", "DescribeDatasetResponse$DataFrequency": "The frequency of data collection.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"M\" indicates every month and \"30min\" indicates every 30 minutes.
", - "FeaturizationConfig$ForecastFrequency": "The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
" + "FeaturizationConfig$ForecastFrequency": "The frequency of predictions in a forecast.
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
Minute - 1-59
Hour - 1-23
Day - 1-6
Week - 1-4
Month - 1-11
Year - 1
Thus, if you want every other week forecasts, specify \"2W\". Or, if you want quarterly forecasts, you specify \"3M\".
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the TARGET_TIME_SERIES dataset frequency.
" } }, "GeolocationFormat": { @@ -1087,6 +1087,14 @@ "DescribePredictorResponse$HPOConfig": "The hyperparameter override values for the algorithm.
" } }, + "ImportMode": { + "base": null, + "refs": { + "CreateDatasetImportJobRequest$ImportMode": "Specifies whether the dataset import job is a FULL
or INCREMENTAL
import. A FULL
dataset import replaces all of the existing data with the newly imported data. An INCREMENTAL
import appends the imported data to the existing data.
The import mode of the dataset import job, FULL or INCREMENTAL.
", + "DescribeDatasetImportJobResponse$ImportMode": "The import mode of the dataset import job, FULL or INCREMENTAL.
" + } + }, "InputDataConfig": { "base": "This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see DataConfig.
The data used to train a predictor. The data includes a dataset group and any supplementary features. You specify this object in the CreatePredictor request.
", "refs": { @@ -1138,7 +1146,7 @@ "base": null, "refs": { "EncryptionConfig$KMSKeyArn": "The Amazon Resource Name (ARN) of the KMS key.
", - "S3Config$KMSKeyArn": "The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
" + "S3Config$KMSKeyArn": "The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
" } }, "LimitExceededException": { @@ -1673,7 +1681,7 @@ } }, "S3Config": { - "base": "The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.
", + "base": "The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.
", "refs": { "DataDestination$S3Config": "The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.
", "DataSource$S3Config": "The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.
", @@ -1790,7 +1798,7 @@ } }, "Tag": { - "base": "The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
Optional metadata to help you categorize and organize your predictors. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
For each resource, each tag key must be unique and each tag key must have one value.
Maximum number of tags per resource: 50.
Maximum key length: 128 Unicode characters in UTF-8.
Maximum value length: 256 Unicode characters in UTF-8.
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
Key prefixes cannot include any upper or lowercase combination of aws:
or AWS:
. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
For each resource, each tag key must be unique and each tag key must have one value.
Maximum number of tags per resource: 50.
Maximum key length: 128 Unicode characters in UTF-8.
Maximum value length: 256 Unicode characters in UTF-8.
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
Key prefixes cannot include any upper or lowercase combination of aws:
or AWS:
. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
For each resource, each tag key must be unique and each tag key must have one value.
Maximum number of tags per resource: 50.
Maximum key length: 128 Unicode characters in UTF-8.
Maximum value length: 256 Unicode characters in UTF-8.
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
Key prefixes cannot include any upper or lowercase combination of aws:
or AWS:
. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
A list of tags to apply to the monitor resource.
", "CreatePredictorBacktestExportJobRequest$Tags": "Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
For each resource, each tag key must be unique and each tag key must have one value.
Maximum number of tags per resource: 50.
Maximum key length: 128 Unicode characters in UTF-8.
Maximum value length: 256 Unicode characters in UTF-8.
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
Key prefixes cannot include any upper or lowercase combination of aws:
or AWS:
. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
A list of tags to apply to the what if forecast.
", "CreateWhatIfForecastExportRequest$Tags": "A list of tags to apply to the what if forecast.
", "CreateWhatIfForecastRequest$Tags": "A list of tags to apply to the what if forecast.
", "ListTagsForResourceResponse$Tags": "The tags for the resource.
", - "TagResourceRequest$Tags": "The tags to add to the resource. A tag is an array of key-value pairs.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The tags to add to the resource. A tag is an array of key-value pairs.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
A replacement dataset is a modified version of the baseline related time series that contains only the values that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is merged with the baseline related time series to create a transformed dataset that is used for the what-if forecast.
", "refs": { - "CreateWhatIfForecastRequest$TimeSeriesReplacementsDataSource": "The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast. This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.
This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.
Timestamps and item_ids not included in this dataset are not included in the what-if analysis.
", + "CreateWhatIfForecastRequest$TimeSeriesReplacementsDataSource": "The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.
This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.
This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.
Timestamps and item_ids not included in this dataset are not included in the what-if analysis.
", "DescribeWhatIfForecastResponse$TimeSeriesReplacementsDataSource": "An array of S3Config
, Schema
, and Format
elements that describe the replacement time series.
Creates a new group.
For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.
", "CreateInstanceProfile": "Creates a new instance profile. For information about instance profiles, see Using roles for applications on Amazon EC2 in the IAM User Guide, and Instance profiles in the Amazon EC2 User Guide.
For information about the number of instance profiles you can create, see IAM object quotas in the IAM User Guide.
", "CreateLoginProfile": "Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.
You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about managing passwords, see Managing passwords in the IAM User Guide.
", - "CreateOpenIDConnectProvider": "Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.
If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.
When you create the IAM OIDC provider, you specify the following:
The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider
A list of thumbprints of one or more server certificates that the IdP uses
You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).
The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.
If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide.
When you create the IAM OIDC provider, you specify the following:
The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider
A list of thumbprints of one or more server certificates that the IdP uses
You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
Creates a new managed policy for your Amazon Web Services account.
This operation creates a policy version with a version identifier of v1
and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.
As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.
For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.
", "CreatePolicyVersion": "Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.
Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.
For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.
", "CreateRole": "Creates a new role for your Amazon Web Services account. For more information about roles, see IAM roles. For information about quotas for role names and the number of roles you can create, see IAM and STS quotas in the IAM User Guide.
", @@ -34,7 +34,7 @@ "DeleteOpenIDConnectProvider": "Deletes an OpenID Connect identity provider (IdP) resource object in IAM.
Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.
This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.
", "DeletePolicy": "Deletes the specified managed policy.
Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:
Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.
Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.
Delete the policy (this automatically deletes the policy's default version) using this operation.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
", "DeletePolicyVersion": "Deletes the specified version from the specified managed policy.
You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
For information about versions for managed policies, see Versioning for managed policies in the IAM User Guide.
", - "DeleteRole": "Deletes the specified role. The role must not have any policies attached. For more information about roles, see Working with roles.
Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items:
Inline policies (DeleteRolePolicy)
Attached managed policies (DetachRolePolicy)
Instance profile (RemoveRoleFromInstanceProfile)
Optional – Delete instance profile after detaching from role for resource clean up (DeleteInstanceProfile)
Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.
Deletes the permissions boundary for the specified IAM role.
Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.
Deletes the specified inline policy that is embedded in the specified IAM role.
A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.
", "DeleteSAMLProvider": "Deletes a SAML provider resource in IAM.
Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.
This operation requires Signature Version 4.
Synchronizes the specified MFA device with its IAM resource object on the Amazon Web Services servers.
For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.
", "SetDefaultPolicyVersion": "Sets the specified version of the specified policy as the policy's default (operative) version.
This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy.
For information about managed policies, see Managed policies and inline policies in the IAM User Guide.
", "SetSecurityTokenServicePreferences": "Sets the specified version of the global endpoint token as the token version used for the Amazon Web Services account.
By default, Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com
. Amazon Web Services recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see Security Token Service endpoints and quotas in the Amazon Web Services General Reference.
If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in Amazon Web Services Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and deactivating STS in an Amazon Web Services Region in the IAM User Guide.
To view the current session token version, see the GlobalEndpointTokenVersion
entry in the response of the GetAccountSummary operation.
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.
If the output is long, you can use MaxItems
and Marker
parameters to paginate the results.
For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
", - "SimulatePrincipalPolicy": "Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.
If the output is long, you can use the MaxItems
and Marker
parameters to paginate the results.
For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
", + "SimulateCustomPolicy": "Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.
Context keys are variables that are maintained by Amazon Web Services and its services and which provide details about the context of an API query request. You can use the Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.
If the output is long, you can use MaxItems
and Marker
parameters to paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to. You can simulate resources that don't exist in your account.
You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation for IAM users only.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
Note: This operation discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.
Context keys are variables maintained by Amazon Web Services and its services that provide details about the context of an API query request. You can use the Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.
If the output is long, you can use the MaxItems
and Marker
parameters to paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
Adds one or more tags to an IAM instance profile. If a tag with the same key name already exists, then that tag is overwritten with the new value.
Each tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM instance profile that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Adds one or more tags to an IAM virtual multi-factor authentication (MFA) device. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM virtual MFA device that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.
A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:
Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.
Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Amazon Web Services always interprets the tag Value
as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the \"role trust policy\". For more information about roles, see Using roles to delegate permissions and federate identities.
", "UpdateGroup": "Updates the name and/or the path of the specified IAM group.
You should understand the implications of changing a group's path or name. For more information, see Renaming users and groups in the IAM User Guide.
The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers
to MGRs
, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers
group, but not the MGRs
group, then the update fails. For more information about permissions, see Access management.
Changes the password for the specified IAM user. You can use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. Use ChangePassword to change your own password in the My Security Credentials page in the Amazon Web Services Management Console.
For more information about modifying passwords, see Managing passwords in the IAM User Guide.
", - "UpdateOpenIDConnectProviderThumbprint": "Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint
operation to highly privileged users.
Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.
The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)
Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.
Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, Auth0, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation.
Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint
operation to highly privileged users.
Updates the description or maximum session duration setting of a role.
", "UpdateRoleDescription": "Use UpdateRole instead.
Modifies only the description of a role. This operation performs the same function as the Description
parameter in the UpdateRole
operation.
Updates the metadata document for an existing SAML provider resource object.
This operation requires Signature Version 4.
A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to *
(all resources). Each API in the ActionNames
parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy
parameter.
If you include a ResourcePolicy
, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", - "SimulatePrincipalPolicyRequest$ResourceArns": "A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to *
(all resources). Each API in the ActionNames
parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy
parameter.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" + "SimulateCustomPolicyRequest$ResourceArns": "A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to *
(all resources). Each API in the ActionNames
parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy
parameter.
If you include a ResourcePolicy
, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Simulation of resource-based policies isn't supported for IAM roles.
A list of ARNs of Amazon Web Services resources to include in the simulation. If this parameter is not provided, then the value defaults to *
(all resources). Each API in the ActionNames
parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response. You can simulate resources that don't exist in your account.
The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy
parameter.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Simulation of resource-based policies isn't supported for IAM roles.
The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.
", "CreatePolicyVersionRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", - "CreateRoleRequest$PermissionsBoundary": "The ARN of the policy that is used to set the permissions boundary for the role.
", + "CreateRoleRequest$PermissionsBoundary": "The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
", "CreateSAMLProviderResponse$SAMLProviderArn": "The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.
", - "CreateUserRequest$PermissionsBoundary": "The ARN of the policy that is used to set the permissions boundary for the user.
", + "CreateUserRequest$PermissionsBoundary": "The ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
", "DeleteOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.
", "DeletePolicyRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy you want to delete.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "DeletePolicyVersionRequest$PolicyArn": "The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", @@ -2234,8 +2234,8 @@ "OpenIDConnectProviderListEntry$Arn": null, "Policy$Arn": null, "PolicyGrantingServiceAccess$PolicyArn": null, - "PutRolePermissionsBoundaryRequest$PermissionsBoundary": "The ARN of the policy that is used to set the permissions boundary for the role.
", - "PutUserPermissionsBoundaryRequest$PermissionsBoundary": "The ARN of the policy that is used to set the permissions boundary for the user.
", + "PutRolePermissionsBoundaryRequest$PermissionsBoundary": "The ARN of the managed policy that is used to set the permissions boundary for the role.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
", + "PutUserPermissionsBoundaryRequest$PermissionsBoundary": "The ARN of the managed policy that is used to set the permissions boundary for the user.
A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.
For more information about policy types, see Policy types in the IAM User Guide.
", "RemoveClientIDFromOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "Role$Arn": "The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.
", "RoleDetail$Arn": null, @@ -2957,8 +2957,8 @@ "PutUserPolicyRequest$PolicyDocument": "The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\\u0020
) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and carriage return (\\u000D
)
The policy that grants an entity permission to assume the role.
", "RoleDetail$AssumeRolePolicyDocument": "The trust policy that grants permission to assume the role.
", - "SimulateCustomPolicyRequest$ResourcePolicy": "A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\\u0020
) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and carriage return (\\u000D
)
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\\u0020
) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and carriage return (\\u000D
)
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\\u0020
) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and carriage return (\\u000D
)
Simulation of resource-based policies isn't supported for IAM roles.
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.
The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\\u0020
) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and carriage return (\\u000D
)
Simulation of resource-based policies isn't supported for IAM roles.
The policy that grants an entity permission to assume the role.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
Any printable ASCII character ranging from the space character (\\u0020
) through the end of the ASCII character range
The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF
)
The special characters tab (\\u0009
), line feed (\\u000A
), and carriage return (\\u000D
)
The resource to untag.
", "UpdateChannel": "Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", "UpdateLiveSource": "Updates a live source's configuration.
", + "UpdateProgram": "Updates a program within a channel.
", "UpdateSourceLocation": "Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", "UpdateVodSource": "Updates a VOD source's configuration.
" }, @@ -134,6 +135,16 @@ "UpdateChannelResponse$ChannelState": "Returns the state whether the channel is running or not.
" } }, + "ClipRange": { + "base": "Clip range configuration for the VOD source associated with the program.
", + "refs": { + "CreateProgramResponse$ClipRange": "The clip range configuration settings.
", + "DescribeProgramResponse$ClipRange": "The clip range configuration settings.
", + "ScheduleConfiguration$ClipRange": "Program clip range configuration.
", + "UpdateProgramResponse$ClipRange": "The clip range configuration settings.
", + "UpdateProgramScheduleConfiguration$ClipRange": "Program clip range configuration.
" + } + }, "ConfigurationAliasesRequest": { "base": "The predefined aliases for dynamic variables.
", "refs": { @@ -615,6 +626,12 @@ "LogConfigurationForChannel$LogTypes": "The log types.
" } }, + "Long": { + "base": null, + "refs": { + "DescribeProgramResponse$DurationMillis": "The duration of the live program in milliseconds.
" + } + }, "ManifestProcessingRules": { "base": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
", "refs": { @@ -903,6 +920,28 @@ "refs": { } }, + "UpdateProgramRequest": { + "base": null, + "refs": { + } + }, + "UpdateProgramResponse": { + "base": null, + "refs": { + } + }, + "UpdateProgramScheduleConfiguration": { + "base": "Schedule configuration parameters.
", + "refs": { + "UpdateProgramRequest$ScheduleConfiguration": "The schedule configuration settings.
" + } + }, + "UpdateProgramTransition": { + "base": "Program transition configuration.
", + "refs": { + "UpdateProgramScheduleConfiguration$Transition": "Program transition configuration.
" + } + }, "UpdateSourceLocationRequest": { "base": null, "refs": { @@ -973,7 +1012,9 @@ "refs": { "CreateProgramRequest$AdBreaks": "The ad break configuration settings.
", "CreateProgramResponse$AdBreaks": "The ad break configuration settings.
", - "DescribeProgramResponse$AdBreaks": "The ad break configuration settings.
" + "DescribeProgramResponse$AdBreaks": "The ad break configuration settings.
", + "UpdateProgramRequest$AdBreaks": "The ad break configuration settings.
", + "UpdateProgramResponse$AdBreaks": "The ad break configuration settings.
" } }, "__listOfAlert": { @@ -1058,10 +1099,15 @@ "base": null, "refs": { "AdBreak$OffsetMillis": "How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
", + "ClipRange$EndOffsetMillis": "The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
", + "CreateProgramResponse$DurationMillis": "The duration of the live program in milliseconds.
", "ScheduleAdBreak$ApproximateDurationSeconds": "The approximate duration of the ad break, in seconds.
", "ScheduleEntry$ApproximateDurationSeconds": "The approximate duration of this program, in seconds.
", "Transition$DurationMillis": "The duration of the live program in seconds.
", - "Transition$ScheduledStartTimeMillis": "The date and time that the program is scheduled to start, in epoch milliseconds.
" + "Transition$ScheduledStartTimeMillis": "The date and time that the program is scheduled to start, in epoch milliseconds.
", + "UpdateProgramResponse$DurationMillis": "The duration of the live program in milliseconds.
", + "UpdateProgramTransition$DurationMillis": "The duration of the live program in seconds.
", + "UpdateProgramTransition$ScheduledStartTimeMillis": "The date and time that the program is scheduled to start, in epoch milliseconds.
" } }, "__mapOf__string": { @@ -1314,6 +1360,14 @@ "UpdateLiveSourceResponse$Arn": "The Amazon Resource Name (ARN) associated with this live source.
", "UpdateLiveSourceResponse$LiveSourceName": "The name of the live source.
", "UpdateLiveSourceResponse$SourceLocationName": "The name of the source location associated with the live source.
", + "UpdateProgramRequest$ChannelName": "The name of the channel for this Program.
", + "UpdateProgramRequest$ProgramName": "The name of the Program.
", + "UpdateProgramResponse$Arn": "The ARN to assign to the program.
", + "UpdateProgramResponse$ChannelName": "The name to assign to the channel for this program.
", + "UpdateProgramResponse$LiveSourceName": "The name of the LiveSource for this Program.
", + "UpdateProgramResponse$ProgramName": "The name to assign to this program.
", + "UpdateProgramResponse$SourceLocationName": "The name to assign to the source location for this program.
", + "UpdateProgramResponse$VodSourceName": "The name that's used to refer to a VOD source.
", "UpdateSourceLocationRequest$SourceLocationName": "The name of the source location.
", "UpdateSourceLocationResponse$Arn": "The Amazon Resource Name (ARN) associated with the source location.
", "UpdateSourceLocationResponse$SourceLocationName": "The name of the source location.
", @@ -1370,6 +1424,8 @@ "UpdateChannelResponse$LastModifiedTime": "The timestamp that indicates when the channel was last modified.
", "UpdateLiveSourceResponse$CreationTime": "The timestamp that indicates when the live source was created.
", "UpdateLiveSourceResponse$LastModifiedTime": "The timestamp that indicates when the live source was last modified.
", + "UpdateProgramResponse$CreationTime": "The time the program was created.
", + "UpdateProgramResponse$ScheduledStartTime": "The scheduled start time for this Program.
", "UpdateSourceLocationResponse$CreationTime": "The timestamp that indicates when the source location was created.
", "UpdateSourceLocationResponse$LastModifiedTime": "The timestamp that indicates when the source location was last modified.
", "UpdateVodSourceResponse$CreationTime": "The timestamp that indicates when the VOD source was created.
", diff --git a/models/apis/mediatailor/2018-04-23/endpoint-tests-1.json b/models/apis/mediatailor/2018-04-23/endpoint-tests-1.json index c69d1582498..5f8d8aca1aa 100644 --- a/models/apis/mediatailor/2018-04-23/endpoint-tests-1.json +++ b/models/apis/mediatailor/2018-04-23/endpoint-tests-1.json @@ -1,289 +1,289 @@ { "testCases": [ { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor-fips.us-gov-east-1.api.aws" + "url": "https://api.mediatailor.ap-northeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-1" } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor-fips.us-gov-east-1.amazonaws.com" + "url": "https://api.mediatailor.ap-southeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-southeast-1" } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.us-gov-east-1.api.aws" + "url": "https://api.mediatailor.ap-southeast-2.amazonaws.com" } }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": true + "UseDualStack": false, + "Region": "ap-southeast-2" } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.us-gov-east-1.amazonaws.com" + "url": "https://api.mediatailor.eu-central-1.amazonaws.com" } }, "params": { "UseFIPS": false, - "Region": "us-gov-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "eu-central-1" } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor-fips.us-isob-east-1.sc2s.sgov.gov" + "url": "https://api.mediatailor.eu-west-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "Region": "us-isob-east-1", - "UseDualStack": false + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-1" } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.us-isob-east-1.sc2s.sgov.gov" + "url": "https://api.mediatailor.us-east-1.amazonaws.com" } }, "params": { "UseFIPS": false, - "Region": "us-isob-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-east-1" } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor-fips.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://api.mediatailor.us-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": true + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-west-2" } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.mediatailor-fips.cn-north-1.amazonaws.com.cn" + "url": "https://api.mediatailor-fips.us-east-1.api.aws" } }, "params": { "UseFIPS": true, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": true, + "Region": "us-east-1" } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://api.mediatailor-fips.us-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": true + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1" } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.cn-north-1.amazonaws.com.cn" + "url": "https://api.mediatailor.us-east-1.api.aws" } }, "params": { "UseFIPS": false, - "Region": "cn-north-1", - "UseDualStack": false + "UseDualStack": true, + "Region": "us-east-1" } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.mediatailor-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://api.mediatailor-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "UseFIPS": true, - "Region": "us-iso-east-1", - "UseDualStack": false + "UseDualStack": true, + "Region": "cn-north-1" } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.us-iso-east-1.c2s.ic.gov" + "url": "https://api.mediatailor-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": false, - "Region": "us-iso-east-1", - "UseDualStack": false + "UseFIPS": true, + "UseDualStack": false, + "Region": "cn-north-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.us-east-1.amazonaws.com" + "url": "https://api.mediatailor.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": true, + "Region": "cn-north-1" } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.us-west-2.amazonaws.com" + "url": "https://api.mediatailor.cn-north-1.amazonaws.com.cn" } }, "params": { "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "UseDualStack": false, + "Region": "cn-north-1" } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.eu-west-1.amazonaws.com" + "url": "https://api.mediatailor-fips.us-gov-east-1.api.aws" } }, "params": { - "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": false + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.ap-southeast-1.amazonaws.com" + "url": "https://api.mediatailor-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.ap-southeast-2.amazonaws.com" + "url": "https://api.mediatailor.us-gov-east-1.api.aws" } }, "params": { "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "UseDualStack": true, + "Region": "us-gov-east-1" } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.eu-central-1.amazonaws.com" + "url": "https://api.mediatailor.us-gov-east-1.amazonaws.com" } }, "params": { "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-gov-east-1" } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.ap-northeast-1.amazonaws.com" + "url": "https://api.mediatailor-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor-fips.us-east-1.api.aws" + "url": "https://api.mediatailor.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-iso-east-1" } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor-fips.us-east-1.amazonaws.com" + "url": "https://api.mediatailor-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.mediatailor.us-east-1.api.aws" + "url": "https://api.mediatailor.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "UseDualStack": false, + "Region": "us-isob-east-1" } }, { @@ -295,8 +295,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -307,8 +307,8 @@ }, "params": { "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -319,8 +319,8 @@ }, "params": { "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } } diff --git a/models/apis/sns/2010-03-31/docs-2.json b/models/apis/sns/2010-03-31/docs-2.json index 10654eb8dc9..6f2d681c434 100644 --- a/models/apis/sns/2010-03-31/docs-2.json +++ b/models/apis/sns/2010-03-31/docs-2.json @@ -861,8 +861,8 @@ "TopicAttributesMap": { "base": null, "refs": { - "CreateTopicInput$Attributes": "A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy
– The JSON serialization of the topic's delivery policy.
DisplayName
– The human-readable name used in the From
field for notifications to email
and email-json
endpoints.
EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy, taking system defaults into account.
Owner
– The Amazon Web Services account ID of the topic's owner.
Policy
– The JSON serialization of the topic's access control policy.
SignatureVersion
– The version of the Amazon SNS signature used for the topic.
By default, SignatureVersion
is set to 1. The signature is a Base64-encoded SHA1withRSA signature.
When you set SignatureVersion
to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the SignatureVersion
attribute, it means that the SignatureVersion
for the topic has value 1.
SubscriptionsConfirmed
– The number of confirmed subscriptions for the topic.
SubscriptionsDeleted
– The number of deleted subscriptions for the topic.
SubscriptionsPending
– The number of subscriptions pending confirmation for the topic.
TopicArn
– The topic's ARN.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
- The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1.
The following attribute applies only to server-side encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy
– The JSON serialization of the topic's delivery policy.
DisplayName
– The human-readable name used in the From
field for notifications to email
and email-json
endpoints.
EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy, taking system defaults into account.
Owner
– The Amazon Web Services account ID of the topic's owner.
Policy
– The JSON serialization of the topic's access control policy.
SignatureVersion
– The version of the Amazon SNS signature used for the topic.
By default, SignatureVersion
is set to 1. The signature is a Base64-encoded SHA1withRSA signature.
When you set SignatureVersion
to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the SignatureVersion
attribute, it means that the SignatureVersion
for the topic has value 1.
SubscriptionsConfirmed
– The number of confirmed subscriptions for the topic.
SubscriptionsDeleted
– The number of deleted subscriptions for the topic.
SubscriptionsPending
– The number of subscriptions pending confirmation for the topic.
TopicArn
– The topic's ARN.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
- The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
– The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) – The filter is applied on the message attributes.
MessageBody
– The filter is applied on the message body.
RawMessageDelivery
– When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes
action uses:
ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
HTTP
HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
Amazon Kinesis Data Firehose
FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
Lambda
LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
Platform application endpoint
ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.
For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
Amazon SQS
SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.