dnrops
/
smithy-rs
mirror of https://github.com/smithy-lang/smithy-rs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

prepare for release of smithy-rs 0.34 (#1047) 

* prepare for release

* remove: extra backtick
This commit is contained in:
Zelda Hessler 2022-01-06 13:04:35 -06:00 committed by GitHub
parent 8baeccdf5a
commit 9be54c9ee6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
57 changed files with 18823 additions and 2267 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CHANGELOG.md
View File

@ -1,4 +1,20 @@
<!-- Do not manually edit this file, use `update-changelogs` -->
0.34.0 (January 6th, 2022)
==========================
**Breaking Changes:**
- ⚠ (smithy-rs#990) Codegen will no longer produce builders and clients with methods that take `impl Into<T>` except for strings and boxed types.
- ⚠ (smithy-rs#1003) The signature of `aws_smithy_protocol_test::validate_headers` was made more flexible but may require adjusting invocations slightly.
**New this release:**
- 🎉 (aws-sdk-rust#47, smithy-rs#1006) Add support for paginators! Paginated APIs now include `.into_paginator()` and (when supported) `.into_paginator().items()` to enable paginating responses automatically. The paginator API should be considered in preview and is subject to change pending customer feedback.
- 🐛 (aws-sdk-rust#357) Generated docs will convert `<a>` tags with no `href` attribute to `<pre>` tags
- (aws-sdk-rust#254, @jacco) Made fluent operation structs cloneable
**Contributors**
Thank you for your contributions! ❤
- @jacco (aws-sdk-rust#254)
v0.33.1 (December 15th, 2021)
=============================
**New this release:**

134
CHANGELOG.next.toml
View File

@ -10,137 +10,3 @@
# references = ["smithy-rs#920"]
# meta = { "breaking" = false, "tada" = false, "bug" = false }
# author = "rcoh"
[[aws-sdk-rust]]
message = """
We removed an example 'telephone-game' that was problematic for our CI.
The APIs that that example demonstrated are also demonstrated by our Polly
and TranscribeStreaming examples so please check those out if you miss it.
"""
references = ["smithy-rs#712"]
meta = { "breaking" = false, "tada" = false, "bug" = false }
author = "Velfi"
[[aws-sdk-rust]]
message = "Generated docs should no longer contain links that don't go anywhere"
references = ["aws-sdk-rust#357"]
meta = { "breaking" = false, "tada" = false, "bug" = true }
author = "Velfi"
[[smithy-rs]]
message = "Generated docs will convert `<a>` tags with no `href` attribute to `<pre>` tags"
references = ["aws-sdk-rust#357"]
meta = { "breaking" = false, "tada" = false, "bug" = true }
author = "Velfi"
[[smithy-rs]]
message = "Made fluent operation structs cloneable"
references = ["aws-sdk-rust#254"]
meta = { "breaking" = false, "tada" = false, "bug" = false }
author = "Jacco"
[[aws-sdk-rust]]
message = "Made fluent operation structs cloneable"
references = ["aws-sdk-rust#254"]
meta = { "breaking" = false, "tada" = false, "bug" = false }
author = "Jacco"
[[aws-sdk-rust]]
message = "Codegen will no longer produce builders and clients with methods that take `impl Into<T>` except for strings and boxed types."
meta = { "breaking" = true, "tada" = false, "bug" = false }
references = ["smithy-rs#990"]
author = "Velfi"
[[smithy-rs]]
message = "Codegen will no longer produce builders and clients with methods that take `impl Into<T>` except for strings and boxed types."
meta = { "breaking" = true, "tada" = false, "bug" = false }
references = ["smithy-rs#990"]
author = "Velfi"
[[aws-sdk-rust]]
message = """
The `meta`, `environment`, and `dns` Cargo feature flags were removed from `aws-config`.
The code behind the `dns` flag is now enabled when `rt-tokio` is enabled. The code behind
the `meta` and `environment` flags is always enabled now.
"""
references = ["smithy-rs#961"]
meta = { "breaking" = true, "tada" = false, "bug" = false }
author = "jdisanti"
[[aws-sdk-rust]]
message = "Debug implementation of Credentials will print `expiry` in a human readable way."
meta = { "breaking" = false, "tada" = false, "bug" = false }
references = ["smithy-rs#973"]
author = "rcoh"
[[aws-sdk-rust]]
message = "Add Route53 customization to trim `/hostedzone/` prefix prior to serialization. This fixes a bug where round-tripping a hosted zone id resulted in an error."
meta = { "breaking" = false, "tada" = false, "bug" = true }
references = ["smithy-rs#999", "smithy-rs#143", "aws-sdk-rust#344"]
author = "rcoh"
[[aws-sdk-rust]]
message = "Fix bug where ECS credential provider could not perform retries."
meta = { "breaking" = false, "tada" = false, "bug" = true }
references = ["smithy-rs#998", "aws-sdk-rust#359"]
author = "rcoh"
[[aws-sdk-rust]]
message = "`aws_http::AwsErrorRetryPolicy` was moved to `aws_http::retry::AwsErrorRetryPolicy`."
meta = { "breaking" = true, "tada" = false, "bug" = false }
references = ["smithy-rs#1003"]
author = "rcoh"
[[smithy-rs]]
message = "The signature of `aws_smithy_protocol_test::validate_headers` was made more flexible but may require adjusting invocations slightly."
meta = { "breaking" = true, "tada" = false, "bug" = false }
references = ["smithy-rs#1003"]
author = "rcoh"
[[aws-sdk-rust]]
message = "Add recursion detection middleware to the default stack"
meta = { "breaking" = false, "tada" = false, "bug" = false }
references = ["smithy-rs#1003"]
author = "rcoh"
[[aws-sdk-rust]]
message = "aws_types::Config is now `Clone`"
meta = { "breaking" = false, "tada" = false, "bug" = false }
references = ["smithy-rs#1002", "aws-sdk-rust#352"]
author = "rcoh"
[[smithy-rs]]
message = "Add support for paginators! Paginated APIs now include `.into_paginator()` and (when supported) `.into_paginator().items()` to enable paginating responses automatically. The paginator API should be considered in preview and is subject to change pending customer feedback."
meta = { "breaking" = false, "tada" = true, "bug" = false }
references = ["aws-sdk-rust#47", "smithy-rs#1006"]
author = "rcoh"
[[aws-sdk-rust]]
message = "Add support for paginators! Paginated APIs now include `.into_paginator()` and (when supported) `.into_paginator().items()` to enable paginating responses automatically. The paginator API should be considered in preview and is subject to change pending customer feedback."
meta = { "breaking" = false, "tada" = true, "bug" = false }
references = ["aws-sdk-rust#47", "smithy-rs#1006"]
author = "rcoh"
[[aws-sdk-rust]]
message = "Example for Config builder region function added"
references = ["smithy-rs#670"]
meta = { "breaking" = false, "tada" = false, "bug" = false }
author = "Jacco"
[[aws-sdk-rust]]
message = "Simplify features in aws-config. All features have been removed from `aws-config` with the exception of: `rt-tokio`, `rustls` and `native-tls`. All other features are now included by default. If you depended on those features specifically, remove them from your features listing."
references = ["smithy-rs#1017", "smithy-rs#930"]
meta = { "breaking" = true, "tada" = false, "bug" = false }
author = "rcoh"
[[aws-sdk-rust]]
message = "Add function to `aws_config::profile::ProfileSet`` that allows listing of loaded profiles by name."
references = ["smithy-rs#1021"]
meta = { "breaking" = false, "tada" = false, "bug" = false }
author = "kiiadi"
[[aws-sdk-rust]]
message = "Fix IMDS credentials provider bug where the instance profile name was incorrectly cached."
references = ["smithy-rs#1046", "aws-sdk-rust#384"]
meta = { "breaking" = false, "tada" = false, "bug" = true }
author = "rcoh"

32
aws/SDK_CHANGELOG.md
View File

@ -1,4 +1,36 @@
<!-- Do not manually edit this file, use `update-changelogs` -->
0.4.0 (January 6th, 2022)
=========================
**Breaking Changes:**
- ⚠ (smithy-rs#990) Codegen will no longer produce builders and clients with methods that take `impl Into<T>` except for strings and boxed types.
- ⚠ (smithy-rs#961) The `meta`, `environment`, and `dns` Cargo feature flags were removed from `aws-config`.
The code behind the `dns` flag is now enabled when `rt-tokio` is enabled. The code behind
the `meta` and `environment` flags is always enabled now.
- ⚠ (smithy-rs#1003) `aws_http::AwsErrorRetryPolicy` was moved to `aws_http::retry::AwsErrorRetryPolicy`.
- ⚠ (smithy-rs#1017, smithy-rs#930) Simplify features in aws-config. All features have been removed from `aws-config` with the exception of: `rt-tokio`, `rustls` and `native-tls`. All other features are now included by default. If you depended on those features specifically, remove them from your features listing.
**New this release:**
- 🎉 (aws-sdk-rust#47, smithy-rs#1006) Add support for paginators! Paginated APIs now include `.into_paginator()` and (when supported) `.into_paginator().items()` to enable paginating responses automatically. The paginator API should be considered in preview and is subject to change pending customer feedback.
- (smithy-rs#712) We removed an example 'telephone-game' that was problematic for our CI.
The APIs that that example demonstrated are also demonstrated by our Polly
and TranscribeStreaming examples so please check those out if you miss it.
- 🐛 (aws-sdk-rust#357) Generated docs should no longer contain links that don't go anywhere
- (aws-sdk-rust#254, @jacco) Made fluent operation structs cloneable
- (smithy-rs#973) Debug implementation of Credentials will print `expiry` in a human readable way.
- 🐛 (smithy-rs#999, smithy-rs#143, aws-sdk-rust#344) Add Route53 customization to trim `/hostedzone/` prefix prior to serialization. This fixes a bug where round-tripping a hosted zone id resulted in an error.
- 🐛 (smithy-rs#998, aws-sdk-rust#359) Fix bug where ECS credential provider could not perform retries.
- (smithy-rs#1003) Add recursion detection middleware to the default stack
- (smithy-rs#1002, aws-sdk-rust#352) aws_types::Config is now `Clone`
- (smithy-rs#670, @jacco) Example for Config builder region function added
- (smithy-rs#1021, @kiiadi) Add function to `aws_config::profile::ProfileSet` that allows listing of loaded profiles by name.
- 🐛 (smithy-rs#1046, aws-sdk-rust#384) Fix IMDS credentials provider bug where the instance profile name was incorrectly cached.
**Contributors**
Thank you for your contributions! ❤
- @jacco (aws-sdk-rust#254, smithy-rs#670)
- @kiiadi (smithy-rs#1021)
v0.3.0 (December 15th, 2021)
============================
**Breaking Changes:**

2408
aws/sdk/aws-models/amplifyuibuilder.json Normal file
View File

File diff suppressed because it is too large Load Diff

12
aws/sdk/aws-models/apigateway.json
View File

@ -8839,7 +8839,7 @@
"limit": {
"target": "com.amazonaws.apigateway#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum number of requests that can be made in a given time period.</p>"
"smithy.api#documentation": "<p>The target maximum number of requests that can be made in a given time period.</p>"
}
},
"offset": {
@ -9755,13 +9755,13 @@
"burstLimit": {
"target": "com.amazonaws.apigateway#Integer",
"traits": {
"smithy.api#documentation": "<p>The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.</p>"
"smithy.api#documentation": "<p>The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.</p>"
}
},
"rateLimit": {
"target": "com.amazonaws.apigateway#Double",
"traits": {
"smithy.api#documentation": "<p>The API request steady-state rate limit.</p>"
"smithy.api#documentation": "<p>The API target request rate limit.</p>"
}
}
},
@ -11415,13 +11415,13 @@
"throttle": {
"target": "com.amazonaws.apigateway#ThrottleSettings",
"traits": {
"smithy.api#documentation": "<p>The request throttle limits of a usage plan.</p>"
"smithy.api#documentation": "<p>Map containing method level throttling information for API stage in a usage plan.</p>"
}
},
"quota": {
"target": "com.amazonaws.apigateway#QuotaSettings",
"traits": {
"smithy.api#documentation": "<p>The maximum number of permitted requests per a given unit time interval.</p>"
"smithy.api#documentation": "<p>The target maximum number of permitted requests per a given unit time interval.</p>"
}
},
"productCode": {
@ -11438,7 +11438,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.</p>\n <div class=\"remarks\">\n <p>In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan. </p>\n </div>\n <div class=\"seeAlso\">\n <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a>\n </div>"
"smithy.api#documentation": "<p>Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. \n In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. \n Consider using <a href=\"https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html\">AWS Budgets</a> to monitor costs \n and <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF</a> to manage API requests.</p>\n <div class=\"remarks\">\n <p>In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan. </p>\n </div>\n <div class=\"seeAlso\">\n <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html\">Create and Use Usage Plans</a>\n </div>"
}
},
"com.amazonaws.apigateway#UsagePlanKey": {

628
aws/sdk/aws-models/appstream.json
View File

@ -186,6 +186,21 @@
"target": "com.amazonaws.appstream#AppBlock"
}
},
"com.amazonaws.appstream#AppVisibility": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ALL",
"name": "ALL"
},
{
"value": "ASSOCIATED",
"name": "ASSOCIATED"
}
]
}
},
"com.amazonaws.appstream#Application": {
"type": "structure",
"members": {
@ -478,6 +493,62 @@
}
}
},
"com.amazonaws.appstream#AssociateApplicationToEntitlement": {
"type": "operation",
"input": {
"target": "com.amazonaws.appstream#AssociateApplicationToEntitlementRequest"
},
"output": {
"target": "com.amazonaws.appstream#AssociateApplicationToEntitlementResult"
},
"errors": [
{
"target": "com.amazonaws.appstream#EntitlementNotFoundException"
},
{
"target": "com.amazonaws.appstream#LimitExceededException"
},
{
"target": "com.amazonaws.appstream#OperationNotPermittedException"
},
{
"target": "com.amazonaws.appstream#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Associates an application to entitle.</p>"
}
},
"com.amazonaws.appstream#AssociateApplicationToEntitlementRequest": {
"type": "structure",
"members": {
"StackName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the stack.</p>",
"smithy.api#required": {}
}
},
"EntitlementName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the entitlement.</p>",
"smithy.api#required": {}
}
},
"ApplicationIdentifier": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>The identifier of the application.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.appstream#AssociateApplicationToEntitlementResult": {
"type": "structure",
"members": {}
},
"com.amazonaws.appstream#AssociateFleet": {
"type": "operation",
"input": {
@ -1064,6 +1135,82 @@
}
}
},
"com.amazonaws.appstream#CreateEntitlement": {
"type": "operation",
"input": {
"target": "com.amazonaws.appstream#CreateEntitlementRequest"
},
"output": {
"target": "com.amazonaws.appstream#CreateEntitlementResult"
},
"errors": [
{
"target": "com.amazonaws.appstream#EntitlementAlreadyExistsException"
},
{
"target": "com.amazonaws.appstream#LimitExceededException"
},
{
"target": "com.amazonaws.appstream#OperationNotPermittedException"
},
{
"target": "com.amazonaws.appstream#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a new entitlement. Entitlements control access to specific applications within\n a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user\n identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all\n applications in a stack. Entitlements don't apply to the desktop stream view\n application, or to applications managed by a dynamic app provider using the Dynamic\n Application Framework.</p>"
}
},
"com.amazonaws.appstream#CreateEntitlementRequest": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the entitlement.</p>",
"smithy.api#required": {}
}
},
"StackName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the stack with which the entitlement is associated.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.appstream#Description",
"traits": {
"smithy.api#documentation": "<p>The description of the entitlement.</p>"
}
},
"AppVisibility": {
"target": "com.amazonaws.appstream#AppVisibility",
"traits": {
"smithy.api#documentation": "<p>Specifies whether all or selected apps are entitled.</p>",
"smithy.api#required": {}
}
},
"Attributes": {
"target": "com.amazonaws.appstream#EntitlementAttributeList",
"traits": {
"smithy.api#documentation": "<p>The attributes of the entitlement.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.appstream#CreateEntitlementResult": {
"type": "structure",
"members": {
"Entitlement": {
"target": "com.amazonaws.appstream#Entitlement",
"traits": {
"smithy.api#documentation": "<p>The entitlement.</p>"
}
}
}
},
"com.amazonaws.appstream#CreateFleet": {
"type": "operation",
"input": {
@ -1975,6 +2122,55 @@
"type": "structure",
"members": {}
},
"com.amazonaws.appstream#DeleteEntitlement": {
"type": "operation",
"input": {
"target": "com.amazonaws.appstream#DeleteEntitlementRequest"
},
"output": {
"target": "com.amazonaws.appstream#DeleteEntitlementResult"
},
"errors": [
{
"target": "com.amazonaws.appstream#ConcurrentModificationException"
},
{
"target": "com.amazonaws.appstream#EntitlementNotFoundException"
},
{
"target": "com.amazonaws.appstream#OperationNotPermittedException"
},
{
"target": "com.amazonaws.appstream#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified entitlement.</p>"
}
},
"com.amazonaws.appstream#DeleteEntitlementRequest": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the entitlement.</p>",
"smithy.api#required": {}
}
},
"StackName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the stack with which the entitlement is associated.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.appstream#DeleteEntitlementResult": {
"type": "structure",
"members": {}
},
"com.amazonaws.appstream#DeleteFleet": {
"type": "operation",
"input": {
@ -2164,6 +2360,9 @@
{
"target": "com.amazonaws.appstream#ConcurrentModificationException"
},
{
"target": "com.amazonaws.appstream#OperationNotPermittedException"
},
{
"target": "com.amazonaws.appstream#ResourceInUseException"
},
@ -2502,6 +2701,76 @@
}
}
},
"com.amazonaws.appstream#DescribeEntitlements": {
"type": "operation",
"input": {
"target": "com.amazonaws.appstream#DescribeEntitlementsRequest"
},
"output": {
"target": "com.amazonaws.appstream#DescribeEntitlementsResult"
},
"errors": [
{
"target": "com.amazonaws.appstream#EntitlementNotFoundException"
},
{
"target": "com.amazonaws.appstream#OperationNotPermittedException"
},
{
"target": "com.amazonaws.appstream#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list that describes one of more entitlements.</p>"
}
},
"com.amazonaws.appstream#DescribeEntitlementsRequest": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the entitlement.</p>"
}
},
"StackName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the stack with which the entitlement is associated.</p>",
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>The pagination token used to retrieve the next page of results for this operation.</p>"
}
},
"MaxResults": {
"target": "com.amazonaws.appstream#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum size of each page of results.</p>"
}
}
}
},
"com.amazonaws.appstream#DescribeEntitlementsResult": {
"type": "structure",
"members": {
"Entitlements": {
"target": "com.amazonaws.appstream#EntitlementList",
"traits": {
"smithy.api#documentation": "<p>The entitlements.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>The pagination token used to retrieve the next page of results for this\n operation.</p>"
}
}
}
},
"com.amazonaws.appstream#DescribeFleets": {
"type": "operation",
"input": {
@ -3305,6 +3574,59 @@
"type": "structure",
"members": {}
},
"com.amazonaws.appstream#DisassociateApplicationFromEntitlement": {
"type": "operation",
"input": {
"target": "com.amazonaws.appstream#DisassociateApplicationFromEntitlementRequest"
},
"output": {
"target": "com.amazonaws.appstream#DisassociateApplicationFromEntitlementResult"
},
"errors": [
{
"target": "com.amazonaws.appstream#EntitlementNotFoundException"
},
{
"target": "com.amazonaws.appstream#OperationNotPermittedException"
},
{
"target": "com.amazonaws.appstream#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified application from the specified entitlement.</p>"
}
},
"com.amazonaws.appstream#DisassociateApplicationFromEntitlementRequest": {
"type": "structure",
"members": {
"StackName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the stack with which the entitlement is associated.</p>",
"smithy.api#required": {}
}
},
"EntitlementName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the entitlement.</p>",
"smithy.api#required": {}
}
},
"ApplicationIdentifier": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>The identifier of the application to remove from the entitlement.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.appstream#DisassociateApplicationFromEntitlementResult": {
"type": "structure",
"members": {}
},
"com.amazonaws.appstream#DisassociateFleet": {
"type": "operation",
"input": {
@ -3471,6 +3793,146 @@
"type": "structure",
"members": {}
},
"com.amazonaws.appstream#EntitledApplication": {
"type": "structure",
"members": {
"ApplicationIdentifier": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>The identifier of the application.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The application associated to an entitlement. Access is controlled based on user attributes.</p>"
}
},
"com.amazonaws.appstream#EntitledApplicationList": {
"type": "list",
"member": {
"target": "com.amazonaws.appstream#EntitledApplication"
}
},
"com.amazonaws.appstream#Entitlement": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the entitlement.</p>",
"smithy.api#required": {}
}
},
"StackName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the stack with which the entitlement is associated.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.appstream#Description",
"traits": {
"smithy.api#documentation": "<p>The description of the entitlement.</p>"
}
},
"AppVisibility": {
"target": "com.amazonaws.appstream#AppVisibility",
"traits": {
"smithy.api#documentation": "<p>Specifies whether all or selected apps are entitled.</p>",
"smithy.api#required": {}
}
},
"Attributes": {
"target": "com.amazonaws.appstream#EntitlementAttributeList",
"traits": {
"smithy.api#documentation": "<p>The attributes of the entitlement.</p>",
"smithy.api#required": {}
}
},
"CreatedTime": {
"target": "com.amazonaws.appstream#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time when the entitlement was created.</p>"
}
},
"LastModifiedTime": {
"target": "com.amazonaws.appstream#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time when the entitlement was last modified.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Specifies an entitlement. Entitlements control access to specific applications within\n a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user\n identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all\n applications in a stack. Entitlements don't apply to the desktop stream view\n application, or to applications managed by a dynamic app provider using the Dynamic\n Application Framework.</p>"
}
},
"com.amazonaws.appstream#EntitlementAlreadyExistsException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.appstream#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The entitlement already exists.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.appstream#EntitlementAttribute": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>A supported AWS IAM SAML <code>PrincipalTag</code> attribute that is matched to the\n associated value when a user identity federates into an Amazon AppStream 2.0 SAML\n application.</p>\n <p>The following are valid values:</p>\n <ul>\n <li>\n <p>roles</p>\n </li>\n <li>\n <p>department </p>\n </li>\n <li>\n <p>organization </p>\n </li>\n <li>\n <p>groups </p>\n </li>\n <li>\n <p>title </p>\n </li>\n <li>\n <p>costCenter </p>\n </li>\n <li>\n <p>userType</p>\n </li>\n </ul>\n <p> </p>",
"smithy.api#required": {}
}
},
"Value": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>A value that is matched to a supported SAML attribute name when a user identity\n federates into an Amazon AppStream 2.0 SAML application. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An attribute associated with an entitlement. Application entitlements work by matching\n a supported SAML 2.0 attribute name to a value when a user identity federates to an\n Amazon AppStream 2.0 SAML application.</p>"
}
},
"com.amazonaws.appstream#EntitlementAttributeList": {
"type": "list",
"member": {
"target": "com.amazonaws.appstream#EntitlementAttribute"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.appstream#EntitlementList": {
"type": "list",
"member": {
"target": "com.amazonaws.appstream#Entitlement"
}
},
"com.amazonaws.appstream#EntitlementNotFoundException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.appstream#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The entitlement can't be found.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.appstream#ErrorMessage": {
"type": "string",
"traits": {
@ -4514,6 +4976,77 @@
}
}
},
"com.amazonaws.appstream#ListEntitledApplications": {
"type": "operation",
"input": {
"target": "com.amazonaws.appstream#ListEntitledApplicationsRequest"
},
"output": {
"target": "com.amazonaws.appstream#ListEntitledApplicationsResult"
},
"errors": [
{
"target": "com.amazonaws.appstream#EntitlementNotFoundException"
},
{
"target": "com.amazonaws.appstream#OperationNotPermittedException"
},
{
"target": "com.amazonaws.appstream#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves a list of entitled applications.</p>"
}
},
"com.amazonaws.appstream#ListEntitledApplicationsRequest": {
"type": "structure",
"members": {
"StackName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the stack with which the entitlement is associated.</p>",
"smithy.api#required": {}
}
},
"EntitlementName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the entitlement.</p>",
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>The pagination token used to retrieve the next page of results for this operation.</p>"
}
},
"MaxResults": {
"target": "com.amazonaws.appstream#Integer",
"traits": {
"smithy.api#documentation": "<p>The maximum size of each page of results.</p>"
}
}
}
},
"com.amazonaws.appstream#ListEntitledApplicationsResult": {
"type": "structure",
"members": {
"EntitledApplications": {
"target": "com.amazonaws.appstream#EntitledApplicationList",
"traits": {
"smithy.api#documentation": "<p>The entitled applications.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.appstream#String",
"traits": {
"smithy.api#documentation": "<p>The pagination token used to retrieve the next page of results for this operation.</p>"
}
}
}
},
"com.amazonaws.appstream#ListTagsForResource": {
"type": "operation",
"input": {
@ -4685,6 +5218,9 @@
{
"target": "com.amazonaws.appstream#AssociateApplicationFleet"
},
{
"target": "com.amazonaws.appstream#AssociateApplicationToEntitlement"
},
{
"target": "com.amazonaws.appstream#AssociateFleet"
},
@ -4706,6 +5242,9 @@
{
"target": "com.amazonaws.appstream#CreateDirectoryConfig"
},
{
"target": "com.amazonaws.appstream#CreateEntitlement"
},
{
"target": "com.amazonaws.appstream#CreateFleet"
},
@ -4739,6 +5278,9 @@
{
"target": "com.amazonaws.appstream#DeleteDirectoryConfig"
},
{
"target": "com.amazonaws.appstream#DeleteEntitlement"
},
{
"target": "com.amazonaws.appstream#DeleteFleet"
},
@ -4772,6 +5314,9 @@
{
"target": "com.amazonaws.appstream#DescribeDirectoryConfigs"
},
{
"target": "com.amazonaws.appstream#DescribeEntitlements"
},
{
"target": "com.amazonaws.appstream#DescribeFleets"
},
@ -4805,6 +5350,9 @@
{
"target": "com.amazonaws.appstream#DisassociateApplicationFleet"
},
{
"target": "com.amazonaws.appstream#DisassociateApplicationFromEntitlement"
},
{
"target": "com.amazonaws.appstream#DisassociateFleet"
},
@ -4820,6 +5368,9 @@
{
"target": "com.amazonaws.appstream#ListAssociatedStacks"
},
{
"target": "com.amazonaws.appstream#ListEntitledApplications"
},
{
"target": "com.amazonaws.appstream#ListTagsForResource"
},
@ -4847,6 +5398,9 @@
{
"target": "com.amazonaws.appstream#UpdateDirectoryConfig"
},
{
"target": "com.amazonaws.appstream#UpdateEntitlement"
},
{
"target": "com.amazonaws.appstream#UpdateFleet"
},
@ -6069,6 +6623,80 @@
}
}
},
"com.amazonaws.appstream#UpdateEntitlement": {
"type": "operation",
"input": {
"target": "com.amazonaws.appstream#UpdateEntitlementRequest"
},
"output": {
"target": "com.amazonaws.appstream#UpdateEntitlementResult"
},
"errors": [
{
"target": "com.amazonaws.appstream#ConcurrentModificationException"
},
{
"target": "com.amazonaws.appstream#EntitlementNotFoundException"
},
{
"target": "com.amazonaws.appstream#OperationNotPermittedException"
},
{
"target": "com.amazonaws.appstream#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates the specified entitlement.</p>"
}
},
"com.amazonaws.appstream#UpdateEntitlementRequest": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the entitlement.</p>",
"smithy.api#required": {}
}
},
"StackName": {
"target": "com.amazonaws.appstream#Name",
"traits": {
"smithy.api#documentation": "<p>The name of the stack with which the entitlement is associated.</p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.appstream#Description",
"traits": {
"smithy.api#documentation": "<p>The description of the entitlement.</p>"
}
},
"AppVisibility": {
"target": "com.amazonaws.appstream#AppVisibility",
"traits": {
"smithy.api#documentation": "<p>Specifies whether all or only selected apps are entitled.</p>"
}
},
"Attributes": {
"target": "com.amazonaws.appstream#EntitlementAttributeList",
"traits": {
"smithy.api#documentation": "<p>The attributes of the entitlement.</p>"
}
}
}
},
"com.amazonaws.appstream#UpdateEntitlementResult": {
"type": "structure",
"members": {
"Entitlement": {
"target": "com.amazonaws.appstream#Entitlement",
"traits": {
"smithy.api#documentation": "<p>The entitlement.</p>"
}
}
}
},
"com.amazonaws.appstream#UpdateFleet": {
"type": "operation",
"input": {

901
aws/sdk/aws-models/appsync.json
View File

File diff suppressed because it is too large Load Diff

55
aws/sdk/aws-models/chime-sdk-messaging.json
View File

@ -874,6 +874,18 @@
"traits": {
"smithy.api#documentation": "<p>The message metadata.</p>"
}
},
"PushNotification": {
"target": "com.amazonaws.chimesdkmessaging#PushNotificationConfiguration",
"traits": {
"smithy.api#documentation": "<p>The push notification configuration of the message.</p>"
}
},
"MessageAttributes": {
"target": "com.amazonaws.chimesdkmessaging#MessageAttributeMap",
"traits": {
"smithy.api#documentation": "<p>The attributes for the message, used for message filtering along with a <code>FilterRule</code> defined in the <code>PushNotificationPreferences</code>. </p>"
}
}
},
"traits": {
@ -1197,6 +1209,21 @@
},
"com.amazonaws.chimesdkmessaging#ChimeMessagingService": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "Chime SDK Messaging",
"arnNamespace": "chime",
"cloudFormationName": "ChimeSDKMessaging",
"cloudTrailEventSource": "chimesdkmessaging.amazonaws.com",
"endpointPrefix": "messaging-chime"
},
"aws.auth#sigv4": {
"name": "chime"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK Identity APIs. For more information about the messaging\n APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging\">Amazon Chime SDK messaging</a>\n </p>",
"smithy.api#title": "Amazon Chime SDK Messaging"
},
"version": "2021-05-15",
"operations": [
{
@ -1334,22 +1361,7 @@
{
"target": "com.amazonaws.chimesdkmessaging#UpdateChannelReadMarker"
}
],
"traits": {
"aws.api#service": {
"sdkId": "Chime SDK Messaging",
"arnNamespace": "chime",
"cloudFormationName": "ChimeSDKMessaging",
"cloudTrailEventSource": "chimesdkmessaging.amazonaws.com",
"endpointPrefix": "messaging-chime"
},
"aws.auth#sigv4": {
"name": "chime"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK Identity APIs. For more information about the messaging\n APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging\">Amazon Chime SDK messaging</a>\n </p>",
"smithy.api#title": "Amazon Chime SDK Messaging"
}
]
},
"com.amazonaws.chimesdkmessaging#ClientRequestToken": {
"type": "string",
@ -3617,7 +3629,7 @@
"Type": {
"target": "com.amazonaws.chimesdkmessaging#ChannelMembershipType",
"traits": {
"smithy.api#documentation": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default\n members are always returned as part of <code>ListChannelMemberships</code>. Hidden members\n are only returned if the type filter in <code>ListChannelMemberships</code> equals\n <code>HIDDEN</code>. Otherwise hidden members are not returned.</p>",
"smithy.api#documentation": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default\n members are returned as part of <code>ListChannelMemberships</code> if no type is specified. Hidden members\n are only returned if the type filter in <code>ListChannelMemberships</code> equals\n <code>HIDDEN</code>.</p>",
"smithy.api#httpQuery": "type"
}
},
@ -4475,22 +4487,19 @@
"Title": {
"target": "com.amazonaws.chimesdkmessaging#PushNotificationTitle",
"traits": {
"smithy.api#documentation": "<p>The title of the push notification.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The title of the push notification.</p>"
}
},
"Body": {
"target": "com.amazonaws.chimesdkmessaging#PushNotificationBody",
"traits": {
"smithy.api#documentation": "<p>The body of the push notification.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The body of the push notification.</p>"
}
},
"Type": {
"target": "com.amazonaws.chimesdkmessaging#PushNotificationType",
"traits": {
"smithy.api#documentation": "<p>Enum value that indicates the type of the push notification for a message.\n <code>DEFAULT</code>: Normal mobile push notification.\n <code>VOIP</code>: VOIP mobile push notification.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>Enum value that indicates the type of the push notification for a message.\n <code>DEFAULT</code>: Normal mobile push notification.\n <code>VOIP</code>: VOIP mobile push notification.</p>"
}
}
},

1859
aws/sdk/aws-models/cloudtrail.json
View File

File diff suppressed because it is too large Load Diff

823
aws/sdk/aws-models/comprehendmedical.json
View File

File diff suppressed because it is too large Load Diff

67
aws/sdk/aws-models/customer-profiles.json
View File

@ -1320,7 +1320,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration information about the S3 bucket where Identity Resolution Jobs writes result files. </p>\n <note>\n <p>You need to give Customer Profiles service principal write permission to your S3 bucket.\n Otherwise, you'll get an exception in the API response. For an example policy, see\n <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service\">Amazon Connect Customer Profiles cross-service confused deputy prevention</a>.\n </p>\n </note>"
"smithy.api#documentation": "<p>Configuration information about the S3 bucket where Identity Resolution Jobs writes result files. </p>\n <note>\n <p>You need to give Customer Profiles service principal write permission to your S3 bucket.\n Otherwise, you'll get an exception in the API response. For an example policy, see\n <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html#customer-profiles-cross-service\">Amazon Connect Customer Profiles cross-service confused deputy prevention</a>. </p>\n </note>"
}
},
"com.amazonaws.customerprofiles#ExportingLocation": {
@ -2001,8 +2001,7 @@
"ObjectTypeName": {
"target": "com.amazonaws.customerprofiles#typeName",
"traits": {
"smithy.api#documentation": "<p>The name of the profile object type.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The name of the profile object type.</p>"
}
},
"CreatedAt": {
@ -2024,6 +2023,12 @@
"traits": {
"smithy.api#documentation": "<p>The tags used to organize, track, or control access for this resource.</p>"
}
},
"ObjectTypeNames": {
"target": "com.amazonaws.customerprofiles#ObjectTypeNames",
"traits": {
"smithy.api#documentation": "<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.\nIt supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, \n<code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"
}
}
}
},
@ -2053,7 +2058,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and subject to change.</p>\n <p>Before calling this API, use <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> or\n <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to\n enable identity resolution: set <code>Matching</code> to true.</p>\n <p>GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process. </p>\n <important>\n <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains. </p>\n <p>After the Identity Resolution Job completes, use the \n<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>\nAPI to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from\nS3.</p>\n </important>\n\n <p>Amazon Connect uses the following profile attributes to identify matches:</p>\n <ul>\n <li>\n <p>PhoneNumber</p>\n </li>\n <li>\n <p>HomePhoneNumber</p>\n </li>\n <li>\n <p>BusinessPhoneNumber</p>\n </li>\n <li>\n <p>MobilePhoneNumber</p>\n </li>\n <li>\n <p>EmailAddress</p>\n </li>\n <li>\n <p>PersonalEmailAddress</p>\n </li>\n <li>\n <p>BusinessEmailAddress</p>\n </li>\n <li>\n <p>FullName</p>\n </li>\n <li>\n <p>BusinessName</p>\n </li>\n </ul>\n <p>For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing\n email addresses such as <b>JOHN_DOE@ANYCOMPANY.COM</b> and\n <b>johndoe@anycompany.com</b>, or different phone number\n formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile.</p>",
"smithy.api#documentation": "<p>Before calling this API, use <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> or\n <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to\n enable identity resolution: set <code>Matching</code> to true.</p>\n <p>GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process. </p>\n <important>\n <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains. </p>\n <p>After the Identity Resolution Job completes, use the \n<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>\nAPI to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from\nS3.</p>\n </important>\n\n <p>Amazon Connect uses the following profile attributes to identify matches:</p>\n <ul>\n <li>\n <p>PhoneNumber</p>\n </li>\n <li>\n <p>HomePhoneNumber</p>\n </li>\n <li>\n <p>BusinessPhoneNumber</p>\n </li>\n <li>\n <p>MobilePhoneNumber</p>\n </li>\n <li>\n <p>EmailAddress</p>\n </li>\n <li>\n <p>PersonalEmailAddress</p>\n </li>\n <li>\n <p>BusinessEmailAddress</p>\n </li>\n <li>\n <p>FullName</p>\n </li>\n <li>\n <p>BusinessName</p>\n </li>\n </ul>\n <p>For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing\n email addresses such as <b>JOHN_DOE@ANYCOMPANY.COM</b> and\n <b>johndoe@anycompany.com</b>, or different phone number\n formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/domains/{DomainName}/matches",
@ -2867,8 +2872,7 @@
"ObjectTypeName": {
"target": "com.amazonaws.customerprofiles#typeName",
"traits": {
"smithy.api#documentation": "<p>The name of the profile object type.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The name of the profile object type.</p>"
}
},
"CreatedAt": {
@ -2890,6 +2894,12 @@
"traits": {
"smithy.api#documentation": "<p>The tags used to organize, track, or control access for this resource.</p>"
}
},
"ObjectTypeNames": {
"target": "com.amazonaws.customerprofiles#ObjectTypeNames",
"traits": {
"smithy.api#documentation": "<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.\nIt supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, \n<code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"
}
}
},
"traits": {
@ -3290,7 +3300,7 @@
"ObjectFilter": {
"target": "com.amazonaws.customerprofiles#ObjectFilter",
"traits": {
"smithy.api#documentation": "<p>Applies a filter to the response to include profile objects with the specified index\n values. This filter is only supported for ObjectTypeName _asset and _case.</p>"
"smithy.api#documentation": "<p>Applies a filter to the response to include profile objects with the specified index\n values. This filter is only supported for ObjectTypeName _asset, _case and _order.</p>"
}
}
}
@ -3594,7 +3604,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and subject to change.</p>\n <p>Runs an AWS Lambda job that does the following:</p>\n <ol>\n <li>\n <p>All the profileKeys in the <code>ProfileToBeMerged</code> will be moved to the\n main profile.</p>\n </li>\n <li>\n <p>All the objects in the <code>ProfileToBeMerged</code> will be moved to the main\n profile.</p>\n </li>\n <li>\n <p>All the <code>ProfileToBeMerged</code> will be deleted at the end.</p>\n </li>\n <li>\n <p>All the profileKeys in the <code>ProfileIdsToBeMerged</code> will be moved to the\n main profile.</p>\n </li>\n <li>\n <p>Standard fields are merged as follows:</p>\n <ol>\n <li>\n <p>Fields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.</p>\n </li>\n <li>\n <p>When there are conflicting fields:</p>\n\n <ol>\n <li>\n <p>If no <code>SourceProfileIds</code> entry is specified, the main\n Profile value is always taken. </p>\n </li>\n <li>\n <p>If a <code>SourceProfileIds</code> entry is specified, the specified\n profileId is always taken, even if it is a NULL value.</p>\n </li>\n </ol>\n </li>\n </ol>\n </li>\n </ol>\n <p>You can use MergeProfiles together with <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).</p>",
"smithy.api#documentation": "<p>Runs an AWS Lambda job that does the following:</p>\n <ol>\n <li>\n <p>All the profileKeys in the <code>ProfileToBeMerged</code> will be moved to the\n main profile.</p>\n </li>\n <li>\n <p>All the objects in the <code>ProfileToBeMerged</code> will be moved to the main\n profile.</p>\n </li>\n <li>\n <p>All the <code>ProfileToBeMerged</code> will be deleted at the end.</p>\n </li>\n <li>\n <p>All the profileKeys in the <code>ProfileIdsToBeMerged</code> will be moved to the\n main profile.</p>\n </li>\n <li>\n <p>Standard fields are merged as follows:</p>\n <ol>\n <li>\n <p>Fields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.</p>\n </li>\n <li>\n <p>When there are conflicting fields:</p>\n\n <ol>\n <li>\n <p>If no <code>SourceProfileIds</code> entry is specified, the main\n Profile value is always taken. </p>\n </li>\n <li>\n <p>If a <code>SourceProfileIds</code> entry is specified, the specified\n profileId is always taken, even if it is a NULL value.</p>\n </li>\n </ol>\n </li>\n </ol>\n </li>\n </ol>\n <p>You can use MergeProfiles together with <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/domains/{DomainName}/profiles/objects/merge",
@ -3662,7 +3672,7 @@
"KeyName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>A searchable identifier of a standard profile object. The predefined keys you can use to\n search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can\n use to search for _case include: _caseId.</p>",
"smithy.api#documentation": "<p>A searchable identifier of a standard profile object. The predefined keys you can use to\n search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can\n use to search for _case include: _caseId. The predefined keys you can use to search for\n _order include: _orderId.</p>",
"smithy.api#required": {}
}
},
@ -3675,7 +3685,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>The filter applied to ListProfileObjects response to include profile objects with the\n specified index values. This filter is only supported for ObjectTypeName _asset and\n _case.</p>"
"smithy.api#documentation": "<p>The filter applied to ListProfileObjects response to include profile objects with the\n specified index values. This filter is only supported for ObjectTypeName _asset, _case and\n _order.</p>"
}
},
"com.amazonaws.customerprofiles#ObjectTypeField": {
@ -3710,7 +3720,7 @@
"StandardIdentifiers": {
"target": "com.amazonaws.customerprofiles#StandardIdentifierList",
"traits": {
"smithy.api#documentation": "<p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be\n used to tie an object to a PROFILE, ASSET or CASE respectively. UNIQUE means that it can be\n used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to\n search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is\n only used to match a profile but is not persisted to be used for searching of the profile.\n A NEW_ONLY key is only used if the profile does not already exist before the object is\n ingested, otherwise it is only used for matching objects to profiles.</p>"
"smithy.api#documentation": "<p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be\n used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be\n used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to\n search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is\n only used to match a profile but is not persisted to be used for searching of the profile.\n A NEW_ONLY key is only used if the profile does not already exist before the object is\n ingested, otherwise it is only used for matching objects to profiles.</p>"
}
},
"FieldNames": {
@ -3730,6 +3740,15 @@
"target": "com.amazonaws.customerprofiles#ObjectTypeKey"
}
},
"com.amazonaws.customerprofiles#ObjectTypeNames": {
"type": "map",
"key": {
"target": "com.amazonaws.customerprofiles#string1To255"
},
"value": {
"target": "com.amazonaws.customerprofiles#typeName"
}
},
"com.amazonaws.customerprofiles#OperatorPropertiesKeys": {
"type": "string",
"traits": {
@ -4058,8 +4077,7 @@
"ObjectTypeName": {
"target": "com.amazonaws.customerprofiles#typeName",
"traits": {
"smithy.api#documentation": "<p>The name of the profile object type.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The name of the profile object type.</p>"
}
},
"Tags": {
@ -4073,6 +4091,12 @@
"traits": {
"smithy.api#documentation": "<p>The configuration that controls how Customer Profiles retrieves data from the\n source.</p>"
}
},
"ObjectTypeNames": {
"target": "com.amazonaws.customerprofiles#ObjectTypeNames",
"traits": {
"smithy.api#documentation": "<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.\nIt supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, \n<code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"
}
}
}
},
@ -4096,8 +4120,7 @@
"ObjectTypeName": {
"target": "com.amazonaws.customerprofiles#typeName",
"traits": {
"smithy.api#documentation": "<p>The name of the profile object type.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The name of the profile object type.</p>"
}
},
"CreatedAt": {
@ -4119,6 +4142,12 @@
"traits": {
"smithy.api#documentation": "<p>The tags used to organize, track, or control access for this resource.</p>"
}
},
"ObjectTypeNames": {
"target": "com.amazonaws.customerprofiles#ObjectTypeNames",
"traits": {
"smithy.api#documentation": "<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event.\nIt supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, \n<code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"
}
}
}
},
@ -4281,7 +4310,7 @@
"SourceLastUpdatedTimestampFormat": {
"target": "com.amazonaws.customerprofiles#string1To255",
"traits": {
"smithy.api#documentation": "<p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.\n </p>"
"smithy.api#documentation": "<p>The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.\n </p>"
}
},
"Fields": {
@ -4796,7 +4825,7 @@
"KeyName": {
"target": "com.amazonaws.customerprofiles#name",
"traits": {
"smithy.api#documentation": "<p>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,\n _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId,\n _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.</p>",
"smithy.api#documentation": "<p>A searchable identifier of a customer profile. The predefined keys you can use\n to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone,\n _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId,\n _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId,\n _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId,\n _shopifyOrderId.</p>",
"smithy.api#required": {}
}
},
@ -5068,6 +5097,10 @@
{
"value": "NEW_ONLY",
"name": "NEW_ONLY"
},
{
"value": "ORDER",
"name": "ORDER"
}
]
}

147
aws/sdk/aws-models/datasync.json
View File

@ -318,6 +318,68 @@
"smithy.api#documentation": "<p>CreateLocationEfs</p>"
}
},
"com.amazonaws.datasync#CreateLocationFsxLustre": {
"type": "operation",
"input": {
"target": "com.amazonaws.datasync#CreateLocationFsxLustreRequest"
},
"output": {
"target": "com.amazonaws.datasync#CreateLocationFsxLustreResponse"
},
"errors": [
{
"target": "com.amazonaws.datasync#InternalException"
},
{
"target": "com.amazonaws.datasync#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an endpoint for an Amazon FSx for Lustre file system.</p>"
}
},
"com.amazonaws.datasync#CreateLocationFsxLustreRequest": {
"type": "structure",
"members": {
"FsxFilesystemArn": {
"target": "com.amazonaws.datasync#FsxFilesystemArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the FSx for Lustre file system.</p>",
"smithy.api#required": {}
}
},
"SecurityGroupArns": {
"target": "com.amazonaws.datasync#Ec2SecurityGroupArnList",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.</p>",
"smithy.api#required": {}
}
},
"Subdirectory": {
"target": "com.amazonaws.datasync#FsxLustreSubdirectory",
"traits": {
"smithy.api#documentation": "<p>A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.</p>"
}
},
"Tags": {
"target": "com.amazonaws.datasync#InputTagList",
"traits": {
"smithy.api#documentation": "<p>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</p>"
}
}
}
},
"com.amazonaws.datasync#CreateLocationFsxLustreResponse": {
"type": "structure",
"members": {
"LocationArn": {
"target": "com.amazonaws.datasync#LocationArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's\n created. </p>"
}
}
}
},
"com.amazonaws.datasync#CreateLocationFsxWindows": {
"type": "operation",
"input": {
@ -344,7 +406,7 @@
"Subdirectory": {
"target": "com.amazonaws.datasync#FsxWindowsSubdirectory",
"traits": {
"smithy.api#documentation": "<p>A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows\n File Server file system is used to read data from the Amazon FSx for Windows File Server\n source location or write data to the FSx for Windows File Server destination.</p>"
"smithy.api#documentation": "<p>A subdirectory in the location's path. This subdirectory in the Amazon FSx for Windows\n File Server file system is used to read data from the Amazon FSx for Windows File Server\n source location or write data to the FSx for Windows File Server destination.</p>"
}
},
"FsxFilesystemArn": {
@ -357,7 +419,7 @@
"SecurityGroupArns": {
"target": "com.amazonaws.datasync#Ec2SecurityGroupArnList",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Names (ARNs) of the security groups that are to use to configure the\n FSx for Windows File Server file system.</p>",
"smithy.api#documentation": "<p>The Amazon Resource Names (ARNs) of the security groups that are used to configure the\n FSx for Windows File Server file system.</p>",
"smithy.api#required": {}
}
},
@ -1229,6 +1291,67 @@
"smithy.api#documentation": "<p>DescribeLocationEfsResponse</p>"
}
},
"com.amazonaws.datasync#DescribeLocationFsxLustre": {
"type": "operation",
"input": {
"target": "com.amazonaws.datasync#DescribeLocationFsxLustreRequest"
},
"output": {
"target": "com.amazonaws.datasync#DescribeLocationFsxLustreResponse"
},
"errors": [
{
"target": "com.amazonaws.datasync#InternalException"
},
{
"target": "com.amazonaws.datasync#InvalidRequestException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns metadata, such as the path information about an Amazon FSx for Lustre\n location.</p>"
}
},
"com.amazonaws.datasync#DescribeLocationFsxLustreRequest": {
"type": "structure",
"members": {
"LocationArn": {
"target": "com.amazonaws.datasync#LocationArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the FSx for Lustre location to describe. </p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.datasync#DescribeLocationFsxLustreResponse": {
"type": "structure",
"members": {
"LocationArn": {
"target": "com.amazonaws.datasync#LocationArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.</p>"
}
},
"LocationUri": {
"target": "com.amazonaws.datasync#LocationUri",
"traits": {
"smithy.api#documentation": "<p>The URI of the FSx for Lustre location that was described.</p>"
}
},
"SecurityGroupArns": {
"target": "com.amazonaws.datasync#Ec2SecurityGroupArnList",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Lustre file system.</p>"
}
},
"CreationTime": {
"target": "com.amazonaws.datasync#Time",
"traits": {
"smithy.api#documentation": "<p>The time that the FSx for Lustre location was created.</p>"
}
}
}
},
"com.amazonaws.datasync#DescribeLocationFsxWindows": {
"type": "operation",
"input": {
@ -2198,6 +2321,9 @@
{
"target": "com.amazonaws.datasync#CreateLocationEfs"
},
{
"target": "com.amazonaws.datasync#CreateLocationFsxLustre"
},
{
"target": "com.amazonaws.datasync#CreateLocationFsxWindows"
},
@ -2234,6 +2360,9 @@
{
"target": "com.amazonaws.datasync#DescribeLocationEfs"
},
{
"target": "com.amazonaws.datasync#DescribeLocationFsxLustre"
},
{
"target": "com.amazonaws.datasync#DescribeLocationFsxWindows"
},
@ -2315,6 +2444,16 @@
"smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$"
}
},
"com.amazonaws.datasync#FsxLustreSubdirectory": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 4096
},
"smithy.api#pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$"
}
},
"com.amazonaws.datasync#FsxWindowsSubdirectory": {
"type": "string",
"traits": {
@ -3024,7 +3163,7 @@
"LocationUri": {
"target": "com.amazonaws.datasync#LocationUri",
"traits": {
"smithy.api#documentation": "<p>Represents a list of URLs of a location. <code>LocationUri</code> returns an array that\n contains a list of locations when the <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html\">ListLocations</a> operation is\n called.</p>\n <p>Format: <code>TYPE://GLOBAL_ID/SUBDIR</code>.</p>\n <p>TYPE designates the type of location. Valid values: NFS | EFS | S3.</p>\n <p>GLOBAL_ID is the globally unique identifier of the resource that backs the location. An\n example for EFS is <code>us-east-2.fs-abcd1234</code>. An example for Amazon S3 is the bucket\n name, such as <code>myBucket</code>. An example for NFS is a valid IPv4 address or a host name\n compliant with Domain Name Service (DNS).</p>\n <p>SUBDIR is a valid file system path, delimited by forward slashes as is the *nix\n convention. For NFS and Amazon EFS, it's the export path to mount the location. For\n Amazon S3, it's the prefix path that you mount to and treat as the root of the\n location.</p>\n <p></p>"
"smithy.api#documentation": "<p>Represents a list of URIs of a location. <code>LocationUri</code> returns an array that\n contains a list of locations when the <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html\">ListLocations</a> operation is\n called.</p>\n <p>Format: <code>TYPE://GLOBAL_ID/SUBDIR</code>.</p>\n <p>TYPE designates the type of location. Valid values: NFS | EFS | S3.</p>\n <p>GLOBAL_ID is the globally unique identifier of the resource that backs the location. An\n example for EFS is <code>us-east-2.fs-abcd1234</code>. An example for Amazon S3 is the bucket\n name, such as <code>myBucket</code>. An example for NFS is a valid IPv4 address or a host name\n compliant with Domain Name Service (DNS).</p>\n <p>SUBDIR is a valid file system path, delimited by forward slashes as is the *nix\n convention. For NFS and Amazon EFS, it's the export path to mount the location. For\n Amazon S3, it's the prefix path that you mount to and treat as the root of the\n location.</p>\n <p></p>"
}
}
},
@ -3039,7 +3178,7 @@
"min": 0,
"max": 4356
},
"smithy.api#pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\\-]+$"
"smithy.api#pattern": "^(efs|nfs|s3|smb|fsxw|fsxl)://[a-zA-Z0-9.\\-]+$"
}
},
"com.amazonaws.datasync#LogGroupArn": {

413
aws/sdk/aws-models/detective.json
View File

@ -75,20 +75,20 @@
"AccountId": {
"target": "com.amazonaws.detective#AccountId",
"traits": {
"smithy.api#documentation": "<p>The account identifier of the AWS account.</p>",
"smithy.api#documentation": "<p>The account identifier of the Amazon Web Services account.</p>",
"smithy.api#required": {}
}
},
"EmailAddress": {
"target": "com.amazonaws.detective#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The AWS account root user email address for the AWS account.</p>",
"smithy.api#documentation": "<p>The Amazon Web Services account root user email address for the Amazon Web Services\n account.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An AWS account that is the administrator account of or a member of a behavior\n graph.</p>"
"smithy.api#documentation": "<p>An Amazon Web Services account that is the administrator account of or a member of a\n behavior graph.</p>"
}
},
"com.amazonaws.detective#AccountId": {
@ -125,8 +125,55 @@
}
}
},
"com.amazonaws.detective#Administrator": {
"type": "structure",
"members": {
"AccountId": {
"target": "com.amazonaws.detective#AccountId",
"traits": {
"smithy.api#documentation": "<p>The Amazon Web Services account identifier of the Detective administrator\n account for the organization.</p>"
}
},
"GraphArn": {
"target": "com.amazonaws.detective#GraphArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the organization behavior graph.</p>"
}
},
"DelegationTime": {
"target": "com.amazonaws.detective#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time when the Detective administrator account was enabled. The\n value is an ISO8601 formatted string. For example,\n <code>2021-08-18T16:35:56.284Z</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about the Detective administrator account for an\n organization.</p>"
}
},
"com.amazonaws.detective#AdministratorList": {
"type": "list",
"member": {
"target": "com.amazonaws.detective#Administrator"
}
},
"com.amazonaws.detective#AmazonDetective": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "Detective",
"arnNamespace": "detective",
"cloudFormationName": "Detective",
"cloudTrailEventSource": "detective.amazonaws.com",
"endpointPrefix": "api.detective"
},
"aws.auth#sigv4": {
"name": "detective"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>Detective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.</p>\n <p>The Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.</p>\n <p>To add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.</p>\n <p>Detective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account can enable any organization account as\n a member account in the organization behavior graph. The organization accounts do not\n receive invitations. The Detective administrator account can also invite other\n accounts to the organization behavior graph.</p>\n <p>Every behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.</p>\n <p>The administrator account for a behavior graph can use the Detective API to do\n the following:</p>\n <ul>\n <li>\n <p>Enable and disable Detective. Enabling Detective creates a new\n behavior graph.</p>\n </li>\n <li>\n <p>View the list of member accounts in a behavior graph.</p>\n </li>\n <li>\n <p>Add member accounts to a behavior graph.</p>\n </li>\n <li>\n <p>Remove member accounts from a behavior graph.</p>\n </li>\n <li>\n <p>Apply tags to a behavior graph.</p>\n </li>\n </ul>\n <p>The organization management account can use the Detective API to select the\n delegated administrator for Detective.</p>\n <p>The Detective administrator account for an organization can use the Detective API to do the following:</p>\n <ul>\n <li>\n <p>Perform all of the functions of an administrator account.</p>\n </li>\n <li>\n <p>Determine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.</p>\n </li>\n </ul>\n <p>An invited member account can use the Detective API to do the following:</p>\n <ul>\n <li>\n <p>View the list of behavior graphs that they are invited to.</p>\n </li>\n <li>\n <p>Accept an invitation to contribute to a behavior graph.</p>\n </li>\n <li>\n <p>Decline an invitation to contribute to a behavior graph.</p>\n </li>\n <li>\n <p>Remove their account from a behavior graph.</p>\n </li>\n </ul>\n <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p>\n <note>\n <p>We replaced the term \"master account\" with the term \"administrator account.\" An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.</p>\n </note>",
"smithy.api#title": "Amazon Detective"
},
"version": "2018-10-26",
"operations": [
{
@ -144,9 +191,18 @@
{
"target": "com.amazonaws.detective#DeleteMembers"
},
{
"target": "com.amazonaws.detective#DescribeOrganizationConfiguration"
},
{
"target": "com.amazonaws.detective#DisableOrganizationAdminAccount"
},
{
"target": "com.amazonaws.detective#DisassociateMembership"
},
{
"target": "com.amazonaws.detective#EnableOrganizationAdminAccount"
},
{
"target": "com.amazonaws.detective#GetMembers"
},
@ -159,6 +215,9 @@
{
"target": "com.amazonaws.detective#ListMembers"
},
{
"target": "com.amazonaws.detective#ListOrganizationAdminAccounts"
},
{
"target": "com.amazonaws.detective#ListTagsForResource"
},
@ -173,23 +232,11 @@
},
{
"target": "com.amazonaws.detective#UntagResource"
},
{
"target": "com.amazonaws.detective#UpdateOrganizationConfiguration"
}
],
"traits": {
"aws.api#service": {
"sdkId": "Detective",
"arnNamespace": "detective",
"cloudFormationName": "Detective",
"cloudTrailEventSource": "detective.amazonaws.com",
"endpointPrefix": "api.detective"
},
"aws.auth#sigv4": {
"name": "detective"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>Detective uses machine learning and purpose-built visualizations to help you analyze and\n investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically\n extracts time-based events such as login attempts, API calls, and network traffic from\n AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.</p>\n <p>The Detective API primarily supports the creation and management of behavior graphs. A\n behavior graph contains the extracted data from a set of member accounts, and is created\n and managed by an administrator account.</p>\n <p>Every behavior graph is specific to a Region. You can only use the API to manage graphs\n that belong to the Region that is associated with the currently selected endpoint.</p>\n <p>A Detective administrator account can use the Detective API to do the following:</p>\n <ul>\n <li>\n <p>Enable and disable Detective. Enabling Detective creates a new behavior graph.</p>\n </li>\n <li>\n <p>View the list of member accounts in a behavior graph.</p>\n </li>\n <li>\n <p>Add member accounts to a behavior graph.</p>\n </li>\n <li>\n <p>Remove member accounts from a behavior graph.</p>\n </li>\n </ul>\n <p>A member account can use the Detective API to do the following:</p>\n <ul>\n <li>\n <p>View the list of behavior graphs that they are invited to.</p>\n </li>\n <li>\n <p>Accept an invitation to contribute to a behavior graph.</p>\n </li>\n <li>\n <p>Decline an invitation to contribute to a behavior graph.</p>\n </li>\n <li>\n <p>Remove their account from a behavior graph.</p>\n </li>\n </ul>\n <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p>\n <note>\n <p>We replaced the term \"master account\" with the term \"administrator account.\" An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior graph.</p>\n </note>",
"smithy.api#title": "Amazon Detective"
}
]
},
"com.amazonaws.detective#Boolean": {
"type": "boolean"
@ -233,7 +280,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a new behavior graph for the calling account, and sets that account as the\n administrator account. This operation is called by the account that is enabling\n Detective.</p>\n <p>Before you try to enable Detective, make sure that your account has been enrolled in\n Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable\n Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable\n Detective, it checks whether your data volume is within the Detective quota. If it exceeds the\n quota, then you cannot enable Detective. </p>\n <p>The operation also enables Detective for the calling account in the currently selected\n Region. It returns the ARN of the new behavior graph.</p>\n <p>\n <code>CreateGraph</code> triggers a process to create the corresponding data tables for\n the new behavior graph.</p>\n <p>An account can only be the administrator account for one behavior graph within a Region.\n If the same account calls <code>CreateGraph</code> with the same administrator account, it\n always returns the same behavior graph ARN. It does not create a new behavior graph.</p>",
"smithy.api#documentation": "<p>Creates a new behavior graph for the calling account, and sets that account as the\n administrator account. This operation is called by the account that is enabling Detective.</p>\n <p>Before you try to enable Detective, make sure that your account has been\n enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this\n requirement, you cannot enable Detective. If you do meet the GuardDuty\n prerequisite, then when you make the request to enable Detective, it checks\n whether your data volume is within the Detective quota. If it exceeds the quota,\n then you cannot enable Detective. </p>\n <p>The operation also enables Detective for the calling account in the currently\n selected Region. It returns the ARN of the new behavior graph.</p>\n <p>\n <code>CreateGraph</code> triggers a process to create the corresponding data tables for\n the new behavior graph.</p>\n <p>An account can only be the administrator account for one behavior graph within a Region.\n If the same account calls <code>CreateGraph</code> with the same administrator account, it\n always returns the same behavior graph ARN. It does not create a new behavior graph.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/graph",
@ -286,7 +333,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Sends a request to invite the specified AWS accounts to be member accounts in the\n behavior graph. This operation can only be called by the administrator account for a\n behavior graph. </p>\n <p>\n <code>CreateMembers</code> verifies the accounts and then invites the verified accounts.\n The administrator can optionally specify to not send invitation emails to the member\n accounts. This would be used when the administrator manages their member accounts\n centrally.</p>\n <p>The request provides the behavior graph ARN and the list of accounts to invite.</p>\n <p>The response separates the requested accounts into two lists:</p>\n <ul>\n <li>\n <p>The accounts that <code>CreateMembers</code> was able to start the verification\n for. This list includes member accounts that are being verified, that have passed\n verification and are to be invited, and that have failed verification.</p>\n </li>\n <li>\n <p>The accounts that <code>CreateMembers</code> was unable to process. This list\n includes accounts that were already invited to be member accounts in the behavior\n graph.</p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>\n <code>CreateMembers</code> is used to send invitations to accounts. For the organization\n behavior graph, the Detective administrator account uses\n <code>CreateMembers</code> to enable organization accounts as member accounts.</p>\n <p>For invited accounts, <code>CreateMembers</code> sends a request to invite the specified\n Amazon Web Services accounts to be member accounts in the behavior graph. This operation\n can only be called by the administrator account for a behavior graph. </p>\n <p>\n <code>CreateMembers</code> verifies the accounts and then invites the verified accounts.\n The administrator can optionally specify to not send invitation emails to the member\n accounts. This would be used when the administrator manages their member accounts\n centrally.</p>\n <p>For organization accounts in the organization behavior graph, <code>CreateMembers</code>\n attempts to enable the accounts. The organization accounts do not receive\n invitations.</p>\n <p>The request provides the behavior graph ARN and the list of accounts to invite or to\n enable.</p>\n <p>The response separates the requested accounts into two lists:</p>\n <ul>\n <li>\n <p>The accounts that <code>CreateMembers</code> was able to process. For invited\n accounts, includes member accounts that are being verified, that have passed\n verification and are to be invited, and that have failed verification. For\n organization accounts in the organization behavior graph, includes accounts that can\n be enabled and that cannot be enabled.</p>\n </li>\n <li>\n <p>The accounts that <code>CreateMembers</code> was unable to process. This list\n includes accounts that were already invited to be member accounts in the behavior\n graph.</p>\n </li>\n </ul>",
"smithy.api#http": {
"method": "POST",
"uri": "/graph/members",
@ -300,7 +347,7 @@
"GraphArn": {
"target": "com.amazonaws.detective#GraphArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the behavior graph to invite the member accounts to contribute their data\n to.</p>",
"smithy.api#documentation": "<p>The ARN of the behavior graph.</p>",
"smithy.api#required": {}
}
},
@ -313,13 +360,13 @@
"DisableEmailNotification": {
"target": "com.amazonaws.detective#Boolean",
"traits": {
"smithy.api#documentation": "<p>if set to <code>true</code>, then the member accounts do not receive email\n notifications. By default, this is set to <code>false</code>, and the member accounts\n receive email notifications.</p>"
"smithy.api#documentation": "<p>if set to <code>true</code>, then the invited accounts do not receive email\n notifications. By default, this is set to <code>false</code>, and the invited accounts\n receive email notifications.</p>\n <p>Organization accounts in the organization behavior graph do not receive email\n notifications.</p>"
}
},
"Accounts": {
"target": "com.amazonaws.detective#AccountList",
"traits": {
"smithy.api#documentation": "<p>The list of AWS accounts to invite to become member accounts in the behavior graph.\n You can invite up to 50 accounts at a time. For each invited account, the account list\n contains the account identifier and the AWS account root user email address.</p>",
"smithy.api#documentation": "<p>The list of Amazon Web Services accounts to invite or to enable. You can invite or enable\n up to 50 accounts at a time. For each invited account, the account list contains the\n account identifier and the Amazon Web Services account root user email address. For\n organization accounts in the organization behavior graph, the email address is not\n required.</p>",
"smithy.api#required": {}
}
}
@ -331,13 +378,13 @@
"Members": {
"target": "com.amazonaws.detective#MemberDetailList",
"traits": {
"smithy.api#documentation": "<p>The set of member account invitation requests that Detective was able to process. This\n includes accounts that are being verified, that failed verification, and that passed\n verification and are being sent an invitation.</p>"
"smithy.api#documentation": "<p>The set of member account invitation or enablement requests that Detective was\n able to process. This includes accounts that are being verified, that failed verification,\n and that passed verification and are being sent an invitation or are being enabled.</p>"
}
},
"UnprocessedAccounts": {
"target": "com.amazonaws.detective#UnprocessedAccountList",
"traits": {
"smithy.api#documentation": "<p>The list of accounts for which Detective was unable to process the invitation request. For\n each account, the list provides the reason why the request could not be processed. The list\n includes accounts that are already member accounts in the behavior graph.</p>"
"smithy.api#documentation": "<p>The list of accounts for which Detective was unable to process the invitation\n or enablement request. For each account, the list provides the reason why the request could\n not be processed. The list includes accounts that are already member accounts in the\n behavior graph.</p>"
}
}
}
@ -359,7 +406,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Disables the specified behavior graph and queues it to be deleted. This operation\n removes the graph from each member account's list of behavior graphs.</p>\n <p>\n <code>DeleteGraph</code> can only be called by the administrator account for a behavior\n graph.</p>",
"smithy.api#documentation": "<p>Disables the specified behavior graph and queues it to be deleted. This operation\n removes the behavior graph from each member account's list of behavior graphs.</p>\n <p>\n <code>DeleteGraph</code> can only be called by the administrator account for a behavior\n graph.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/graph/removal",
@ -402,7 +449,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes one or more member accounts from the administrator account's behavior graph.\n This operation can only be called by a Detective administrator account. That account cannot use\n <code>DeleteMembers</code> to delete their own account from the behavior graph. To\n disable a behavior graph, the administrator account uses the <code>DeleteGraph</code> API\n method.</p>",
"smithy.api#documentation": "<p>Removes the specified member accounts from the behavior graph. The removed accounts no\n longer contribute data to the behavior graph. This operation can only be called by the\n administrator account for the behavior graph.</p>\n <p>For invited accounts, the removed accounts are deleted from the list of accounts in the\n behavior graph. To restore the account, the administrator account must send another\n invitation.</p>\n <p>For organization accounts in the organization behavior graph, the Detective\n administrator account can always enable the organization account again. Organization\n accounts that are not enabled as member accounts are not included in the\n <code>ListMembers</code> results for the organization behavior graph.</p>\n <p>An administrator account cannot use <code>DeleteMembers</code> to remove their own\n account from the behavior graph. To disable a behavior graph, the administrator account\n uses the <code>DeleteGraph</code> API method.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/graph/members/removal",
@ -416,14 +463,14 @@
"GraphArn": {
"target": "com.amazonaws.detective#GraphArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the behavior graph to delete members from.</p>",
"smithy.api#documentation": "<p>The ARN of the behavior graph to remove members from.</p>",
"smithy.api#required": {}
}
},
"AccountIds": {
"target": "com.amazonaws.detective#AccountIdList",
"traits": {
"smithy.api#documentation": "<p>The list of AWS account identifiers for the member accounts to delete from the\n behavior graph. You can delete up to 50 member accounts at a time.</p>",
"smithy.api#documentation": "<p>The list of Amazon Web Services account identifiers for the member accounts to remove\n from the behavior graph. You can remove up to 50 member accounts at a time.</p>",
"smithy.api#required": {}
}
}
@ -435,17 +482,90 @@
"AccountIds": {
"target": "com.amazonaws.detective#AccountIdList",
"traits": {
"smithy.api#documentation": "<p>The list of AWS account identifiers for the member accounts that Detective successfully\n deleted from the behavior graph.</p>"
"smithy.api#documentation": "<p>The list of Amazon Web Services account identifiers for the member accounts that Detective successfully removed from the behavior graph.</p>"
}
},
"UnprocessedAccounts": {
"target": "com.amazonaws.detective#UnprocessedAccountList",
"traits": {
"smithy.api#documentation": "<p>The list of member accounts that Detective was not able to delete from the behavior graph.\n For each member account, provides the reason that the deletion could not be\n processed.</p>"
"smithy.api#documentation": "<p>The list of member accounts that Detective was not able to remove from the\n behavior graph. For each member account, provides the reason that the deletion could not be\n processed.</p>"
}
}
}
},
"com.amazonaws.detective#DescribeOrganizationConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.detective#DescribeOrganizationConfigurationRequest"
},
"output": {
"target": "com.amazonaws.detective#DescribeOrganizationConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.detective#InternalServerException"
},
{
"target": "com.amazonaws.detective#TooManyRequestsException"
},
{
"target": "com.amazonaws.detective#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about the configuration for the organization behavior graph.\n Currently indicates whether to automatically enable new organization accounts as member\n accounts.</p>\n <p>Can only be called by the Detective administrator account for the organization. </p>",
"smithy.api#http": {
"method": "POST",
"uri": "/orgs/describeOrganizationConfiguration",
"code": 200
}
}
},
"com.amazonaws.detective#DescribeOrganizationConfigurationRequest": {
"type": "structure",
"members": {
"GraphArn": {
"target": "com.amazonaws.detective#GraphArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the organization behavior graph.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.detective#DescribeOrganizationConfigurationResponse": {
"type": "structure",
"members": {
"AutoEnable": {
"target": "com.amazonaws.detective#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether to automatically enable new organization accounts as member accounts\n in the organization behavior graph.</p>"
}
}
}
},
"com.amazonaws.detective#DisableOrganizationAdminAccount": {
"type": "operation",
"errors": [
{
"target": "com.amazonaws.detective#InternalServerException"
},
{
"target": "com.amazonaws.detective#TooManyRequestsException"
},
{
"target": "com.amazonaws.detective#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Removes the Detective administrator account for the organization in the current\n Region. Deletes the behavior graph for that account.</p>\n <p>Can only be called by the organization management account. Before you can select a\n different Detective administrator account, you must remove the Detective\n administrator account in all Regions.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/orgs/disableAdminAccount",
"code": 200
}
}
},
"com.amazonaws.detective#DisassociateMembership": {
"type": "operation",
"input": {
@ -466,7 +586,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Removes the member account from the specified behavior graph. This operation can only be\n called by a member account that has the <code>ENABLED</code> status.</p>",
"smithy.api#documentation": "<p>Removes the member account from the specified behavior graph. This operation can only be\n called by an invited member account that has the <code>ENABLED</code> status.</p>\n <p>\n <code>DisassociateMembership</code> cannot be called by an organization account in the\n organization behavior graph. For the organization behavior graph, the Detective\n administrator account determines which organization accounts to enable or disable as member\n accounts.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/membership/removal",
@ -505,6 +625,43 @@
}
}
},
"com.amazonaws.detective#EnableOrganizationAdminAccount": {
"type": "operation",
"input": {
"target": "com.amazonaws.detective#EnableOrganizationAdminAccountRequest"
},
"errors": [
{
"target": "com.amazonaws.detective#InternalServerException"
},
{
"target": "com.amazonaws.detective#TooManyRequestsException"
},
{
"target": "com.amazonaws.detective#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Designates the Detective administrator account for the organization in the\n current Region.</p>\n <p>If the account does not have Detective enabled, then enables Detective\n for that account and creates a new behavior graph.</p>\n <p>Can only be called by the organization management account.</p>\n <p>The Detective administrator account for an organization must be the same in all\n Regions. If you already designated a Detective administrator account in another\n Region, then you must designate the same account.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/orgs/enableAdminAccount",
"code": 200
}
}
},
"com.amazonaws.detective#EnableOrganizationAdminAccountRequest": {
"type": "structure",
"members": {
"AccountId": {
"target": "com.amazonaws.detective#AccountId",
"traits": {
"smithy.api#documentation": "<p>The Amazon Web Services account identifier of the account to designate as the Detective administrator account for the organization.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.detective#ErrorMessage": {
"type": "string"
},
@ -549,7 +706,7 @@
"AccountIds": {
"target": "com.amazonaws.detective#AccountIdList",
"traits": {
"smithy.api#documentation": "<p>The list of AWS account identifiers for the member account for which to return member\n details. You can request details for up to 50 member accounts at a time.</p>\n <p>You cannot use <code>GetMembers</code> to retrieve information about member accounts\n that were removed from the behavior graph.</p>",
"smithy.api#documentation": "<p>The list of Amazon Web Services account identifiers for the member account for which to\n return member details. You can request details for up to 50 member accounts at a\n time.</p>\n <p>You cannot use <code>GetMembers</code> to retrieve information about member accounts\n that were removed from the behavior graph.</p>",
"smithy.api#required": {}
}
}
@ -561,7 +718,7 @@
"MemberDetails": {
"target": "com.amazonaws.detective#MemberDetailList",
"traits": {
"smithy.api#documentation": "<p>The member account details that Detective is returning in response to the request.</p>"
"smithy.api#documentation": "<p>The member account details that Detective is returning in response to the\n request.</p>"
}
},
"UnprocessedAccounts": {
@ -584,7 +741,7 @@
"CreatedTime": {
"target": "com.amazonaws.detective#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time that the behavior graph was created. The value is in milliseconds\n since the epoch.</p>"
"smithy.api#documentation": "<p>The date and time that the behavior graph was created. The value is an ISO8601 formatted\n string. For example, <code>2021-08-18T16:35:56.284Z</code>.</p>"
}
}
},
@ -617,6 +774,21 @@
"smithy.api#httpError": 500
}
},
"com.amazonaws.detective#InvitationType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "INVITATION",
"name": "INVITATION"
},
{
"value": "ORGANIZATION",
"name": "ORGANIZATION"
}
]
}
},
"com.amazonaws.detective#ListGraphs": {
"type": "operation",
"input": {
@ -698,7 +870,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves the list of open and accepted behavior graph invitations for the member\n account. This operation can only be called by a member account.</p>\n <p>Open invitations are invitations that the member account has not responded to.</p>\n <p>The results do not include behavior graphs for which the member account declined the\n invitation. The results also do not include behavior graphs that the member account\n resigned from or was removed from.</p>",
"smithy.api#documentation": "<p>Retrieves the list of open and accepted behavior graph invitations for the member\n account. This operation can only be called by an invited member account.</p>\n <p>Open invitations are invitations that the member account has not responded to.</p>\n <p>The results do not include behavior graphs for which the member account declined the\n invitation. The results also do not include behavior graphs that the member account\n resigned from or was removed from.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/invitations/list",
@ -765,7 +937,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves the list of member accounts for a behavior graph. Does not return member\n accounts that were removed from the behavior graph.</p>",
"smithy.api#documentation": "<p>Retrieves the list of member accounts for a behavior graph.</p>\n <p>For invited accounts, the results do not include member accounts that were removed from\n the behavior graph.</p>\n <p>For the organization behavior graph, the results do not include organization accounts\n that the Detective administrator account has not enabled as member\n accounts.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/graph/members/list",
@ -808,13 +980,80 @@
"MemberDetails": {
"target": "com.amazonaws.detective#MemberDetailList",
"traits": {
"smithy.api#documentation": "<p>The list of member accounts in the behavior graph.</p>\n <p>The results include member accounts that did not pass verification and member accounts\n that have not yet accepted the invitation to the behavior graph. The results do not include\n member accounts that were removed from the behavior graph.</p>"
"smithy.api#documentation": "<p>The list of member accounts in the behavior graph.</p>\n <p>For invited accounts, the results include member accounts that did not pass verification\n and member accounts that have not yet accepted the invitation to the behavior graph. The\n results do not include member accounts that were removed from the behavior graph.</p>\n <p>For the organization behavior graph, the results do not include organization accounts\n that the Detective administrator account has not enabled as member\n accounts.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.detective#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If there are more member accounts remaining in the results, then this is the pagination\n token to use to request the next page of member accounts.</p>"
"smithy.api#documentation": "<p>If there are more member accounts remaining in the results, then use this pagination\n token to request the next page of member accounts.</p>"
}
}
}
},
"com.amazonaws.detective#ListOrganizationAdminAccounts": {
"type": "operation",
"input": {
"target": "com.amazonaws.detective#ListOrganizationAdminAccountsRequest"
},
"output": {
"target": "com.amazonaws.detective#ListOrganizationAdminAccountsResponse"
},
"errors": [
{
"target": "com.amazonaws.detective#InternalServerException"
},
{
"target": "com.amazonaws.detective#TooManyRequestsException"
},
{
"target": "com.amazonaws.detective#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about the Detective administrator account for an\n organization. Can only be called by the organization management account.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/orgs/adminAccountslist",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "MaxResults"
}
}
},
"com.amazonaws.detective#ListOrganizationAdminAccountsRequest": {
"type": "structure",
"members": {
"NextToken": {
"target": "com.amazonaws.detective#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>For requests to get the next page of results, the pagination token that was returned\n with the previous set of results. The initial request does not include a pagination\n token.</p>"
}
},
"MaxResults": {
"target": "com.amazonaws.detective#MemberResultsLimit",
"traits": {
"smithy.api#documentation": "<p>The maximum number of results to return.</p>"
}
}
}
},
"com.amazonaws.detective#ListOrganizationAdminAccountsResponse": {
"type": "structure",
"members": {
"Administrators": {
"target": "com.amazonaws.detective#AdministratorList",
"traits": {
"smithy.api#documentation": "<p>The list of delegated administrator accounts.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.detective#PaginationToken",
"traits": {
"smithy.api#documentation": "<p>If there are more accounts remaining in the results, then this is the pagination token\n to use to request the next page of accounts.</p>"
}
}
}
@ -877,19 +1116,19 @@
"AccountId": {
"target": "com.amazonaws.detective#AccountId",
"traits": {
"smithy.api#documentation": "<p>The AWS account identifier for the member account.</p>"
"smithy.api#documentation": "<p>The Amazon Web Services account identifier for the member account.</p>"
}
},
"EmailAddress": {
"target": "com.amazonaws.detective#EmailAddress",
"traits": {
"smithy.api#documentation": "<p>The AWS account root user email address for the member account.</p>"
"smithy.api#documentation": "<p>The Amazon Web Services account root user email address for the member account.</p>"
}
},
"GraphArn": {
"target": "com.amazonaws.detective#GraphArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the behavior graph that the member account was invited to.</p>"
"smithy.api#documentation": "<p>The ARN of the behavior graph.</p>"
}
},
"MasterId": {
@ -898,37 +1137,37 @@
"smithy.api#deprecated": {
"message": "This property is deprecated. Use AdministratorId instead."
},
"smithy.api#documentation": "<p>The AWS account identifier of the administrator account for the behavior graph.</p>"
"smithy.api#documentation": "<p>The Amazon Web Services account identifier of the administrator account for the behavior\n graph.</p>"
}
},
"AdministratorId": {
"target": "com.amazonaws.detective#AccountId",
"traits": {
"smithy.api#documentation": "<p>The AWS account identifier of the administrator account for the behavior graph.</p>"
"smithy.api#documentation": "<p>The Amazon Web Services account identifier of the administrator account for the behavior\n graph.</p>"
}
},
"Status": {
"target": "com.amazonaws.detective#MemberStatus",
"traits": {
"smithy.api#documentation": "<p>The current membership status of the member account. The status can have one of the\n following values:</p>\n <ul>\n <li>\n <p>\n <code>INVITED</code> - Indicates that the member was sent an invitation but has\n not yet responded.</p>\n </li>\n <li>\n <p>\n <code>VERIFICATION_IN_PROGRESS</code> - Indicates that Detective is verifying that the\n account identifier and email address provided for the member account match. If they\n do match, then Detective sends the invitation. If the email address and account\n identifier don't match, then the member cannot be added to the behavior graph.</p>\n </li>\n <li>\n <p>\n <code>VERIFICATION_FAILED</code> - Indicates that the account and email address\n provided for the member account do not match, and Detective did not send an invitation to\n the account.</p>\n </li>\n <li>\n <p>\n <code>ENABLED</code> - Indicates that the member account accepted the invitation\n to contribute to the behavior graph.</p>\n </li>\n <li>\n <p>\n <code>ACCEPTED_BUT_DISABLED</code> - Indicates that the member account accepted\n the invitation but is prevented from contributing data to the behavior graph.\n <code>DisabledReason</code> provides the reason why the member account is not\n enabled.</p>\n </li>\n </ul>\n <p>Member accounts that declined an invitation or that were removed from the behavior graph\n are not included.</p>"
"smithy.api#documentation": "<p>The current membership status of the member account. The status can have one of the\n following values:</p>\n <ul>\n <li>\n <p>\n <code>INVITED</code> - For invited accounts only. Indicates that the member was\n sent an invitation but has not yet responded.</p>\n </li>\n <li>\n <p>\n <code>VERIFICATION_IN_PROGRESS</code> - For invited accounts only, indicates that\n Detective is verifying that the account identifier and email address\n provided for the member account match. If they do match, then Detective\n sends the invitation. If the email address and account identifier don't match, then\n the member cannot be added to the behavior graph.</p>\n <p>For organization accounts in the organization behavior graph, indicates that\n Detective is verifying that the account belongs to the\n organization.</p>\n </li>\n <li>\n <p>\n <code>VERIFICATION_FAILED</code> - For invited accounts only. Indicates that the\n account and email address provided for the member account do not match, and Detective did not send an invitation to the account.</p>\n </li>\n <li>\n <p>\n <code>ENABLED</code> - Indicates that the member account currently contributes\n data to the behavior graph. For invited accounts, the member account accepted the\n invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member\n account.</p>\n </li>\n <li>\n <p>\n <code>ACCEPTED_BUT_DISABLED</code> - The account accepted the invitation, or was\n enabled by the Detective administrator account, but is prevented from\n contributing data to the behavior graph. <code>DisabledReason</code> provides the\n reason why the member account is not enabled.</p>\n </li>\n </ul>\n <p>Invited accounts that declined an invitation or that were removed from the behavior\n graph are not included. In the organization behavior graph, organization accounts that the\n Detective administrator account did not enable are not included.</p>"
}
},
"DisabledReason": {
"target": "com.amazonaws.detective#MemberDisabledReason",
"traits": {
"smithy.api#documentation": "<p>For member accounts with a status of <code>ACCEPTED_BUT_DISABLED</code>, the reason that\n the member account is not enabled.</p>\n <p>The reason can have one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>VOLUME_TOO_HIGH</code> - Indicates that adding the member account would\n cause the data volume for the behavior graph to be too high.</p>\n </li>\n <li>\n <p>\n <code>VOLUME_UNKNOWN</code> - Indicates that Detective is unable to verify the data\n volume for the member account. This is usually because the member account is not\n enrolled in Amazon GuardDuty. </p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>For member accounts with a status of <code>ACCEPTED_BUT_DISABLED</code>, the reason that\n the member account is not enabled.</p>\n <p>The reason can have one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>VOLUME_TOO_HIGH</code> - Indicates that adding the member account would\n cause the data volume for the behavior graph to be too high.</p>\n </li>\n <li>\n <p>\n <code>VOLUME_UNKNOWN</code> - Indicates that Detective is unable to\n verify the data volume for the member account. This is usually because the member\n account is not enrolled in Amazon GuardDuty. </p>\n </li>\n </ul>"
}
},
"InvitedTime": {
"target": "com.amazonaws.detective#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time that Detective sent the invitation to the member account. The value is in\n milliseconds since the epoch.</p>"
"smithy.api#documentation": "<p>For invited accounts, the date and time that Detective sent the invitation to\n the account. The value is an ISO8601 formatted string. For example,\n <code>2021-08-18T16:35:56.284Z</code>.</p>"
}
},
"UpdatedTime": {
"target": "com.amazonaws.detective#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time that the member account was last updated. The value is in milliseconds\n since the epoch.</p>"
"smithy.api#documentation": "<p>The date and time that the member account was last updated. The value is an ISO8601\n formatted string. For example, <code>2021-08-18T16:35:56.284Z</code>.</p>"
}
},
"VolumeUsageInBytes": {
@ -940,7 +1179,7 @@
"VolumeUsageUpdatedTime": {
"target": "com.amazonaws.detective#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The data and time when the member account data volume was last updated.</p>"
"smithy.api#documentation": "<p>The data and time when the member account data volume was last updated. The value is an\n ISO8601 formatted string. For example, <code>2021-08-18T16:35:56.284Z</code>.</p>"
}
},
"PercentOfGraphUtilization": {
@ -958,12 +1197,18 @@
"smithy.api#deprecated": {
"message": "This property is deprecated. Use VolumeUsageUpdatedTime instead."
},
"smithy.api#documentation": "<p>The date and time when the graph utilization percentage was last updated.</p>"
"smithy.api#documentation": "<p>The date and time when the graph utilization percentage was last updated. The value is\n an ISO8601 formatted string. For example, <code>2021-08-18T16:35:56.284Z</code>.</p>"
}
},
"InvitationType": {
"target": "com.amazonaws.detective#InvitationType",
"traits": {
"smithy.api#documentation": "<p>The type of behavior graph membership.</p>\n <p>For an organization account in the organization behavior graph, the type is\n <code>ORGANIZATION</code>.</p>\n <p>For an account that was invited to a behavior graph, the type is\n <code>INVITATION</code>. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details about a member account that was invited to contribute to a behavior\n graph.</p>"
"smithy.api#documentation": "<p>Details about a member account in a behavior graph.</p>"
}
},
"com.amazonaws.detective#MemberDetailList": {
@ -1059,7 +1304,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Rejects an invitation to contribute the account data to a behavior graph. This operation\n must be called by a member account that has the <code>INVITED</code> status.</p>",
"smithy.api#documentation": "<p>Rejects an invitation to contribute the account data to a behavior graph. This operation\n must be called by an invited member account that has the <code>INVITED</code>\n status.</p>\n <p>\n <code>RejectInvitation</code> cannot be called by an organization account in the\n organization behavior graph. In the organization behavior graph, organization accounts do\n not receive an invitation.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/invitation/removal",
@ -1100,7 +1345,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>This request cannot be completed for one of the following reasons.</p>\n <ul>\n <li>\n <p>The request would cause the number of member accounts in the behavior graph to\n exceed the maximum allowed. A behavior graph cannot have more than 1000 member\n accounts.</p>\n </li>\n <li>\n <p>The request would cause the data rate for the behavior graph to exceed the maximum\n allowed.</p>\n </li>\n <li>\n <p>Detective is unable to verify the data rate for the member account. This is usually\n because the member account is not enrolled in Amazon GuardDuty. </p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>This request cannot be completed for one of the following reasons.</p>\n <ul>\n <li>\n <p>The request would cause the number of member accounts in the behavior graph to\n exceed the maximum allowed. A behavior graph cannot have more than 1200 member\n accounts.</p>\n </li>\n <li>\n <p>The request would cause the data rate for the behavior graph to exceed the maximum\n allowed.</p>\n </li>\n <li>\n <p>Detective is unable to verify the data rate for the member account. This\n is usually because the member account is not enrolled in Amazon GuardDuty.</p>\n </li>\n </ul>",
"smithy.api#error": "client",
"smithy.api#httpError": 402
}
@ -1128,7 +1373,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Sends a request to enable data ingest for a member account that has a status of\n <code>ACCEPTED_BUT_DISABLED</code>.</p>\n <p>For valid member accounts, the status is updated as follows.</p>\n <ul>\n <li>\n <p>If Detective enabled the member account, then the new status is\n <code>ENABLED</code>.</p>\n </li>\n <li>\n <p>If Detective cannot enable the member account, the status remains\n <code>ACCEPTED_BUT_DISABLED</code>. </p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>Sends a request to enable data ingest for a member account that has a status of\n <code>ACCEPTED_BUT_DISABLED</code>.</p>\n <p>For valid member accounts, the status is updated as follows.</p>\n <ul>\n <li>\n <p>If Detective enabled the member account, then the new status is\n <code>ENABLED</code>.</p>\n </li>\n <li>\n <p>If Detective cannot enable the member account, the status remains\n <code>ACCEPTED_BUT_DISABLED</code>. </p>\n </li>\n </ul>",
"smithy.api#http": {
"method": "POST",
"uri": "/graph/member/monitoringstate",
@ -1259,13 +1504,26 @@
"smithy.api#timestampFormat": "date-time"
}
},
"com.amazonaws.detective#TooManyRequestsException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.detective#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>The request cannot be completed because too many other requests are occurring at the\n same time.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 429
}
},
"com.amazonaws.detective#UnprocessedAccount": {
"type": "structure",
"members": {
"AccountId": {
"target": "com.amazonaws.detective#AccountId",
"traits": {
"smithy.api#documentation": "<p>The AWS account identifier of the member account that was not processed.</p>"
"smithy.api#documentation": "<p>The Amazon Web Services account identifier of the member account that was not\n processed.</p>"
}
},
"Reason": {
@ -1341,6 +1599,49 @@
"type": "structure",
"members": {}
},
"com.amazonaws.detective#UpdateOrganizationConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.detective#UpdateOrganizationConfigurationRequest"
},
"errors": [
{
"target": "com.amazonaws.detective#InternalServerException"
},
{
"target": "com.amazonaws.detective#TooManyRequestsException"
},
{
"target": "com.amazonaws.detective#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates the configuration for the Organizations integration in the current Region.\n Can only be called by the Detective administrator account for the\n organization.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/orgs/updateOrganizationConfiguration",
"code": 200
}
}
},
"com.amazonaws.detective#UpdateOrganizationConfigurationRequest": {
"type": "structure",
"members": {
"GraphArn": {
"target": "com.amazonaws.detective#GraphArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the organization behavior graph.</p>",
"smithy.api#required": {}
}
},
"AutoEnable": {
"target": "com.amazonaws.detective#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether to automatically enable new organization accounts as member accounts\n in the organization behavior graph.</p>"
}
}
}
},
"com.amazonaws.detective#ValidationException": {
"type": "structure",
"members": {

10
aws/sdk/aws-models/devops-guru.json
View File

@ -1439,6 +1439,12 @@
"traits": {
"smithy.api#documentation": "<p>The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.</p>"
}
},
"Tags": {
"target": "com.amazonaws.devopsguru#TagHealths",
"traits": {
"smithy.api#documentation": "<p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the <a href=\"https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf\">Tagging\n \t\t\tbest practices</a> whitepaper. </p>\n \t <p>Each Amazon Web Services tag has two parts. </p>\n \t <ul>\n <li>\n \t\t\t <p>A tag <i>key</i> (for example, <code>CostCenter</code>,\n \t\t\t\t<code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag\n \t\t\t\t<i>keys</i> are case-sensitive.</p>\n \t\t </li>\n <li>\n \t\t\t <p>An optional field known as a tag <i>value</i> (for example,\n \t\t\t\t<code>111122223333</code>, <code>Production</code>, or a team\n \t\t\t\tname). Omitting the tag <i>value</i> is the same as using an empty\n \t\t\t\tstring. Like tag <i>keys</i>, tag <i>values</i> are\n \t\t\t\tcase-sensitive.</p>\n \t\t </li>\n </ul>\n \t <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p>\n \t <important>\n\t\t <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix <code>Devops-guru-</code>. The tag <i>key</i> might be\n\t\t\t<code>Devops-guru-deployment-application</code> or\n\t\t\t<code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the\n\t\t\tcase of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\t<i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named\n\t\t\t<code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your\n\t\t\tapplication might be <code>Devops-Guru-production-application/RDS</code> or\n\t\t\t<code>Devops-Guru-production-application/containers</code>.</p>\n\t </important>"
}
}
}
},
@ -3070,6 +3076,10 @@
{
"value": "AWS_ACCOUNT",
"name": "AWS_ACCOUNT"
},
{
"value": "AWS_TAGS",
"name": "AWS_TAGS"
}
]
}

116
aws/sdk/aws-models/ec2.json
View File

@ -2940,6 +2940,9 @@
{
"target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfiguration"
},
{
"target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibility"
},
{
"target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissions"
},
@ -23013,6 +23016,32 @@
"outputToken": "NextToken",
"items": "InternetGateways",
"pageSize": "MaxResults"
},
"smithy.api#suppress": [
"WaitableTraitInvalidErrorType"
],
"smithy.waiters#waitable": {
"InternetGatewayExists": {
"acceptors": [
{
"state": "success",
"matcher": {
"output": {
"path": "length(InternetGateways[].InternetGatewayId) > `0`",
"expected": "true",
"comparator": "booleanEquals"
}
}
},
{
"state": "retry",
"matcher": {
"errorType": "InvalidInternetGateway.NotFound"
}
}
],
"minDelay": 5
}
}
}
},
@ -32363,7 +32392,7 @@
"type": "structure",
"members": {
"ElasticGpuId": {
"target": "com.amazonaws.ec2#String",
"target": "com.amazonaws.ec2#ElasticGpuId",
"traits": {
"aws.protocols#ec2QueryName": "ElasticGpuId",
"smithy.api#documentation": "<p>The ID of the Elastic Graphics accelerator.</p>",
@ -39138,7 +39167,7 @@
}
},
"OfferingId": {
"target": "com.amazonaws.ec2#String",
"target": "com.amazonaws.ec2#OfferingId",
"traits": {
"aws.protocols#ec2QueryName": "OfferingId",
"smithy.api#documentation": "<p>The ID of the offering.</p>",
@ -39282,7 +39311,7 @@
}
},
"HostReservationId": {
"target": "com.amazonaws.ec2#String",
"target": "com.amazonaws.ec2#HostReservationId",
"traits": {
"aws.protocols#ec2QueryName": "HostReservationId",
"smithy.api#documentation": "<p>The ID of the reservation that specifies the associated Dedicated Hosts.</p>",
@ -39306,7 +39335,7 @@
}
},
"OfferingId": {
"target": "com.amazonaws.ec2#String",
"target": "com.amazonaws.ec2#OfferingId",
"traits": {
"aws.protocols#ec2QueryName": "OfferingId",
"smithy.api#documentation": "<p>The ID of the reservation. This remains the same regardless of which Dedicated\n Hosts are associated with it.</p>",
@ -55038,6 +55067,56 @@
}
}
},
"com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibility": {
"type": "operation",
"input": {
"target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest"
},
"output": {
"target": "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult"
},
"traits": {
"smithy.api#documentation": "<p>Modifies the payer responsibility for your VPC endpoint service.</p>"
}
},
"com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest": {
"type": "structure",
"members": {
"DryRun": {
"target": "com.amazonaws.ec2#Boolean",
"traits": {
"smithy.api#documentation": "<p>Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. \n Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
}
},
"ServiceId": {
"target": "com.amazonaws.ec2#VpcEndpointServiceId",
"traits": {
"smithy.api#documentation": "<p>The ID of the service.</p>",
"smithy.api#required": {}
}
},
"PayerResponsibility": {
"target": "com.amazonaws.ec2#PayerResponsibility",
"traits": {
"smithy.api#documentation": "<p>The entity that is responsible for the endpoint costs. The default is the endpoint owner.\n If you set the payer responsibility to the service owner, you cannot set it back to the\n endpoint owner.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult": {
"type": "structure",
"members": {
"ReturnValue": {
"target": "com.amazonaws.ec2#Boolean",
"traits": {
"aws.protocols#ec2QueryName": "Return",
"smithy.api#documentation": "<p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>",
"smithy.api#xmlName": "return"
}
}
}
},
"com.amazonaws.ec2#ModifyVpcEndpointServicePermissions": {
"type": "operation",
"input": {
@ -58161,6 +58240,17 @@
"smithy.api#documentation": "<p>Describes a path statement.</p>"
}
},
"com.amazonaws.ec2#PayerResponsibility": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ServiceOwner",
"name": "ServiceOwner"
}
]
}
},
"com.amazonaws.ec2#PaymentOption": {
"type": "string",
"traits": {
@ -60187,7 +60277,7 @@
}
},
"HostReservationId": {
"target": "com.amazonaws.ec2#String",
"target": "com.amazonaws.ec2#HostReservationId",
"traits": {
"aws.protocols#ec2QueryName": "HostReservationId",
"smithy.api#documentation": "<p>The ID of the reservation.</p>",
@ -67610,6 +67700,14 @@
"smithy.api#xmlName": "privateDnsNameConfiguration"
}
},
"PayerResponsibility": {
"target": "com.amazonaws.ec2#PayerResponsibility",
"traits": {
"aws.protocols#ec2QueryName": "PayerResponsibility",
"smithy.api#documentation": "<p>The payer responsibility.</p>",
"smithy.api#xmlName": "payerResponsibility"
}
},
"Tags": {
"target": "com.amazonaws.ec2#TagList",
"traits": {
@ -67723,6 +67821,14 @@
"smithy.api#xmlName": "managesVpcEndpoints"
}
},
"PayerResponsibility": {
"target": "com.amazonaws.ec2#PayerResponsibility",
"traits": {
"aws.protocols#ec2QueryName": "PayerResponsibility",
"smithy.api#documentation": "<p>The payer responsibility.</p>",
"smithy.api#xmlName": "payerResponsibility"
}
},
"Tags": {
"target": "com.amazonaws.ec2#TagList",
"traits": {

8
aws/sdk/aws-models/ecs.json
View File

@ -285,7 +285,7 @@
"status": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p> The status of the attachment. Valid values are <code>PRECREATED</code>,\n\t\t\t\t<code>CREATED</code>, <code>ATTACHING</code>, <code>ATTACHED</code>,\n\t\t\t\t<code>DETACHING</code>, <code>DETACHED</code>, and <code>DELETED</code>.</p>"
"smithy.api#documentation": "<p> The status of the attachment. Valid values are <code>PRECREATED</code>,\n\t\t\t\t<code>CREATED</code>, <code>ATTACHING</code>, <code>ATTACHED</code>,\n\t\t\t\t<code>DETACHING</code>, <code>DETACHED</code>, <code>DELETED</code>, and\n\t\t\t\t<code>FAILED</code>.</p>"
}
},
"details": {
@ -409,7 +409,7 @@
"managedTerminationProtection": {
"target": "com.amazonaws.ecs#ManagedTerminationProtection",
"traits": {
"smithy.api#documentation": "<p>The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.</p>\n\t\t <important>\n\t\t\t <p>When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.</p>\n\t\t </important>\n\t\t <p>When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>\n\t\t <p>When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.</p>"
"smithy.api#documentation": "<p>The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is disabled.</p>\n\t\t <important>\n\t\t\t <p>When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.</p>\n\t\t </important>\n\t\t <p>When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>\n\t\t <p>When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.</p>"
}
}
},
@ -6561,7 +6561,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Starts a new task using the specified task definition.</p>\n\t\t <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.</p>\n\t\t <p>The Amazon ECS API follows an eventual consistency model. This is because the distributed\n\t\t\tnature of the system supporting the API. This means that the result of an API command\n\t\t\tyou run that affects your Amazon ECS resources might not be immediately visible to all\n\t\t\tsubsequent commands you run. Keep this in mind when you carry out an API command that\n\t\t\timmediately follows a previous API command.</p>\n\t\t <p>To manage eventual consistency, you can do the following:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>Confirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Add wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.</p>\n\t\t\t </li>\n </ul>"
"smithy.api#documentation": "<p>Starts a new task using the specified task definition.</p>\n\t\t <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>\n\t\t <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.</p>\n\t\t <p>The Amazon ECS API follows an eventual consistency model. This is because of the distributed\n\t\t\tnature of the system supporting the API. This means that the result of an API command\n\t\t\tyou run that affects your Amazon ECS resources might not be immediately visible to all\n\t\t\tsubsequent commands you run. Keep this in mind when you carry out an API command that\n\t\t\timmediately follows a previous API command.</p>\n\t\t <p>To manage eventual consistency, you can do the following:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>Confirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>Add wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.</p>\n\t\t\t </li>\n </ul>"
}
},
"com.amazonaws.ecs#RunTaskRequest": {
@ -9097,7 +9097,7 @@
"containerInstances": {
"target": "com.amazonaws.ecs#StringList",
"traits": {
"smithy.api#documentation": "<p>A list of container instance IDs or full ARN entries.</p>",
"smithy.api#documentation": "<p>A list of up to 10 container instance IDs or full ARN entries.</p>",
"smithy.api#required": {}
}
},

203
aws/sdk/aws-models/eks.json
View File

File diff suppressed because one or more lines are too long

54
aws/sdk/aws-models/finspace-data.json
View File

@ -250,6 +250,12 @@
"smithy.api#documentation": "<p>Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
}
},
"activeFromTimestamp": {
"target": "com.amazonaws.finspacedata#TimestampEpoch",
"traits": {
"smithy.api#box": {}
}
},
"updatesChangesetId": {
"target": "com.amazonaws.finspacedata#ChangesetId",
"traits": {
@ -696,8 +702,7 @@
"datasetDescription": {
"target": "com.amazonaws.finspacedata#DatasetDescription",
"traits": {
"smithy.api#documentation": "<p>Description of a Dataset.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>Description of a Dataset.</p>"
}
},
"ownerInfo": {
@ -716,8 +721,7 @@
"alias": {
"target": "com.amazonaws.finspacedata#AliasString",
"traits": {
"smithy.api#documentation": "<p>The unique resource identifier for a Dataset.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The unique resource identifier for a Dataset.</p>"
}
},
"schemaDefinition": {
@ -792,6 +796,12 @@
"smithy.api#documentation": "<p>Destination type for a Dataview.</p>\n <ul>\n <li>\n <p>\n <code>GLUE_TABLE</code> - Glue table destination type.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"s3DestinationExportFileFormat": {
"target": "com.amazonaws.finspacedata#ExportFileFormat"
},
"s3DestinationExportFileFormatOptions": {
"target": "com.amazonaws.finspacedata#S3DestinationFormatOptions"
}
},
"traits": {
@ -1038,7 +1048,7 @@
"smithy.api#documentation": "Description of a dataset",
"smithy.api#length": {
"min": 1,
"max": 256
"max": 1000
},
"smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$"
}
@ -1281,6 +1291,22 @@
"com.amazonaws.finspacedata#ErrorMessage2": {
"type": "string"
},
"com.amazonaws.finspacedata#ExportFileFormat": {
"type": "string",
"traits": {
"smithy.api#documentation": "Data View Export File Format",
"smithy.api#enum": [
{
"value": "PARQUET",
"name": "PARQUET"
},
{
"value": "DELIMITED_TEXT",
"name": "DELIMITED_TEXT"
}
]
}
},
"com.amazonaws.finspacedata#FormatParams": {
"type": "map",
"key": {
@ -1418,6 +1444,12 @@
"smithy.api#documentation": "<p>Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"
}
},
"activeFromTimestamp": {
"target": "com.amazonaws.finspacedata#TimestampEpoch",
"traits": {
"smithy.api#box": {}
}
},
"updatesChangesetId": {
"target": "com.amazonaws.finspacedata#ChangesetId",
"traits": {
@ -2272,6 +2304,15 @@
}
}
},
"com.amazonaws.finspacedata#S3DestinationFormatOptions": {
"type": "map",
"key": {
"target": "com.amazonaws.finspacedata#StringMapKey"
},
"value": {
"target": "com.amazonaws.finspacedata#StringMapValue"
}
},
"com.amazonaws.finspacedata#SchemaDefinition": {
"type": "structure",
"members": {
@ -2582,8 +2623,7 @@
"alias": {
"target": "com.amazonaws.finspacedata#AliasString",
"traits": {
"smithy.api#documentation": "<p>The unique resource identifier for a Dataset.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The unique resource identifier for a Dataset.</p>"
}
},
"schemaDefinition": {

138
aws/sdk/aws-models/forecast.json
View File

File diff suppressed because one or more lines are too long

433
aws/sdk/aws-models/glue.json
View File

@ -363,6 +363,15 @@
{
"target": "com.amazonaws.glue#GetTriggers"
},
{
"target": "com.amazonaws.glue#GetUnfilteredPartitionMetadata"
},
{
"target": "com.amazonaws.glue#GetUnfilteredPartitionsMetadata"
},
{
"target": "com.amazonaws.glue#GetUnfilteredTableMetadata"
},
{
"target": "com.amazonaws.glue#GetUserDefinedFunction"
},
@ -563,6 +572,15 @@
"smithy.api#error": "client"
}
},
"com.amazonaws.glue#AccountId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 12
}
}
},
"com.amazonaws.glue#Action": {
"type": "structure",
"members": {
@ -640,6 +658,23 @@
"com.amazonaws.glue#AttemptCount": {
"type": "integer"
},
"com.amazonaws.glue#AuditContext": {
"type": "structure",
"members": {
"AdditionalAuditContext": {
"target": "com.amazonaws.glue#AuditContextString"
}
}
},
"com.amazonaws.glue#AuditContextString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 2048
}
}
},
"com.amazonaws.glue#BackfillError": {
"type": "structure",
"members": {
@ -2302,6 +2337,12 @@
"smithy.api#documentation": "<p>A list of the tables to be synchronized.</p>",
"smithy.api#required": {}
}
},
"ConnectionName": {
"target": "com.amazonaws.glue#ConnectionName",
"traits": {
"smithy.api#documentation": "<p>The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a <code>Catalog</code> connection type paired with a <code>NETWORK</code> Connection type.</p>"
}
}
},
"traits": {
@ -2684,6 +2725,23 @@
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$"
}
},
"com.amazonaws.glue#ColumnRowFilter": {
"type": "structure",
"members": {
"ColumnName": {
"target": "com.amazonaws.glue#NameString"
},
"RowFilterExpression": {
"target": "com.amazonaws.glue#PredicateString"
}
}
},
"com.amazonaws.glue#ColumnRowFilterList": {
"type": "list",
"member": {
"target": "com.amazonaws.glue#ColumnRowFilter"
}
},
"com.amazonaws.glue#ColumnStatistics": {
"type": "structure",
"members": {
@ -3598,6 +3656,9 @@
"traits": {
"smithy.api#documentation": "<p>The name of the <code>SecurityConfiguration</code> structure to be used by this\n crawler.</p>"
}
},
"LakeFormationConfiguration": {
"target": "com.amazonaws.glue#LakeFormationConfiguration"
}
},
"traits": {
@ -3821,6 +3882,12 @@
"traits": {
"smithy.api#documentation": "<p>Specifies Glue Data Catalog targets.</p>"
}
},
"DeltaTargets": {
"target": "com.amazonaws.glue#DeltaTargetList",
"traits": {
"smithy.api#documentation": "<p>Specifies Delta data store targets.</p>"
}
}
},
"traits": {
@ -4109,6 +4176,9 @@
"smithy.api#documentation": "<p>Specifies data lineage configuration settings for the crawler.</p>"
}
},
"LakeFormationConfiguration": {
"target": "com.amazonaws.glue#LakeFormationConfiguration"
},
"Configuration": {
"target": "com.amazonaws.glue#CrawlerConfiguration",
"traits": {
@ -7373,6 +7443,38 @@
}
}
},
"com.amazonaws.glue#DeltaTarget": {
"type": "structure",
"members": {
"DeltaTables": {
"target": "com.amazonaws.glue#PathList",
"traits": {
"smithy.api#documentation": "<p>A list of the Amazon S3 paths to the Delta tables.</p>"
}
},
"ConnectionName": {
"target": "com.amazonaws.glue#ConnectionName",
"traits": {
"smithy.api#documentation": "<p>The name of the connection to use to connect to the Delta table target.</p>"
}
},
"WriteManifest": {
"target": "com.amazonaws.glue#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to write the manifest files to the Delta table path.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Specifies a Delta data store to crawl one or more Delta tables.</p>"
}
},
"com.amazonaws.glue#DeltaTargetList": {
"type": "list",
"member": {
"target": "com.amazonaws.glue#DeltaTarget"
}
},
"com.amazonaws.glue#DescriptionString": {
"type": "string",
"traits": {
@ -11619,6 +11721,256 @@
}
}
},
"com.amazonaws.glue#GetUnfilteredPartitionMetadata": {
"type": "operation",
"input": {
"target": "com.amazonaws.glue#GetUnfilteredPartitionMetadataRequest"
},
"output": {
"target": "com.amazonaws.glue#GetUnfilteredPartitionMetadataResponse"
},
"errors": [
{
"target": "com.amazonaws.glue#EntityNotFoundException"
},
{
"target": "com.amazonaws.glue#GlueEncryptionException"
},
{
"target": "com.amazonaws.glue#InternalServiceException"
},
{
"target": "com.amazonaws.glue#InvalidInputException"
},
{
"target": "com.amazonaws.glue#OperationTimeoutException"
},
{
"target": "com.amazonaws.glue#PermissionTypeMismatchException"
}
]
},
"com.amazonaws.glue#GetUnfilteredPartitionMetadataRequest": {
"type": "structure",
"members": {
"CatalogId": {
"target": "com.amazonaws.glue#CatalogIdString",
"traits": {
"smithy.api#required": {}
}
},
"DatabaseName": {
"target": "com.amazonaws.glue#NameString",
"traits": {
"smithy.api#required": {}
}
},
"TableName": {
"target": "com.amazonaws.glue#NameString",
"traits": {
"smithy.api#required": {}
}
},
"PartitionValues": {
"target": "com.amazonaws.glue#ValueStringList",
"traits": {
"smithy.api#required": {}
}
},
"AuditContext": {
"target": "com.amazonaws.glue#AuditContext"
},
"SupportedPermissionTypes": {
"target": "com.amazonaws.glue#PermissionTypeList",
"traits": {
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.glue#GetUnfilteredPartitionMetadataResponse": {
"type": "structure",
"members": {
"Partition": {
"target": "com.amazonaws.glue#Partition"
},
"AuthorizedColumns": {
"target": "com.amazonaws.glue#NameStringList"
},
"IsRegisteredWithLakeFormation": {
"target": "com.amazonaws.glue#Boolean"
}
}
},
"com.amazonaws.glue#GetUnfilteredPartitionsMetadata": {
"type": "operation",
"input": {
"target": "com.amazonaws.glue#GetUnfilteredPartitionsMetadataRequest"
},
"output": {
"target": "com.amazonaws.glue#GetUnfilteredPartitionsMetadataResponse"
},
"errors": [
{
"target": "com.amazonaws.glue#EntityNotFoundException"
},
{
"target": "com.amazonaws.glue#GlueEncryptionException"
},
{
"target": "com.amazonaws.glue#InternalServiceException"
},
{
"target": "com.amazonaws.glue#InvalidInputException"
},
{
"target": "com.amazonaws.glue#OperationTimeoutException"
},
{
"target": "com.amazonaws.glue#PermissionTypeMismatchException"
}
],
"traits": {
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "MaxResults"
}
}
},
"com.amazonaws.glue#GetUnfilteredPartitionsMetadataRequest": {
"type": "structure",
"members": {
"CatalogId": {
"target": "com.amazonaws.glue#CatalogIdString",
"traits": {
"smithy.api#required": {}
}
},
"DatabaseName": {
"target": "com.amazonaws.glue#NameString",
"traits": {
"smithy.api#required": {}
}
},
"TableName": {
"target": "com.amazonaws.glue#NameString",
"traits": {
"smithy.api#required": {}
}
},
"Expression": {
"target": "com.amazonaws.glue#PredicateString"
},
"AuditContext": {
"target": "com.amazonaws.glue#AuditContext"
},
"SupportedPermissionTypes": {
"target": "com.amazonaws.glue#PermissionTypeList",
"traits": {
"smithy.api#required": {}
}
},
"NextToken": {
"target": "com.amazonaws.glue#Token"
},
"Segment": {
"target": "com.amazonaws.glue#Segment"
},
"MaxResults": {
"target": "com.amazonaws.glue#PageSize"
}
}
},
"com.amazonaws.glue#GetUnfilteredPartitionsMetadataResponse": {
"type": "structure",
"members": {
"UnfilteredPartitions": {
"target": "com.amazonaws.glue#UnfilteredPartitionList"
},
"NextToken": {
"target": "com.amazonaws.glue#Token"
}
}
},
"com.amazonaws.glue#GetUnfilteredTableMetadata": {
"type": "operation",
"input": {
"target": "com.amazonaws.glue#GetUnfilteredTableMetadataRequest"
},
"output": {
"target": "com.amazonaws.glue#GetUnfilteredTableMetadataResponse"
},
"errors": [
{
"target": "com.amazonaws.glue#EntityNotFoundException"
},
{
"target": "com.amazonaws.glue#GlueEncryptionException"
},
{
"target": "com.amazonaws.glue#InternalServiceException"
},
{
"target": "com.amazonaws.glue#InvalidInputException"
},
{
"target": "com.amazonaws.glue#OperationTimeoutException"
},
{
"target": "com.amazonaws.glue#PermissionTypeMismatchException"
}
]
},
"com.amazonaws.glue#GetUnfilteredTableMetadataRequest": {
"type": "structure",
"members": {
"CatalogId": {
"target": "com.amazonaws.glue#CatalogIdString",
"traits": {
"smithy.api#required": {}
}
},
"DatabaseName": {
"target": "com.amazonaws.glue#NameString",
"traits": {
"smithy.api#required": {}
}
},
"Name": {
"target": "com.amazonaws.glue#NameString",
"traits": {
"smithy.api#required": {}
}
},
"AuditContext": {
"target": "com.amazonaws.glue#AuditContext"
},
"SupportedPermissionTypes": {
"target": "com.amazonaws.glue#PermissionTypeList",
"traits": {
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.glue#GetUnfilteredTableMetadataResponse": {
"type": "structure",
"members": {
"Table": {
"target": "com.amazonaws.glue#Table"
},
"AuthorizedColumns": {
"target": "com.amazonaws.glue#NameStringList"
},
"IsRegisteredWithLakeFormation": {
"target": "com.amazonaws.glue#Boolean"
},
"CellFilters": {
"target": "com.amazonaws.glue#ColumnRowFilterList"
}
}
},
"com.amazonaws.glue#GetUserDefinedFunction": {
"type": "operation",
"input": {
@ -13100,6 +13452,17 @@
"smithy.api#documentation": "<p>Specifies configuration properties for a labeling set generation task run.</p>"
}
},
"com.amazonaws.glue#LakeFormationConfiguration": {
"type": "structure",
"members": {
"UseLakeFormationCredentials": {
"target": "com.amazonaws.glue#NullableBoolean"
},
"AccountId": {
"target": "com.amazonaws.glue#AccountId"
}
}
},
"com.amazonaws.glue#Language": {
"type": "string",
"traits": {
@ -13981,6 +14344,12 @@
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$"
}
},
"com.amazonaws.glue#LocationStringList": {
"type": "list",
"member": {
"target": "com.amazonaws.glue#LocationString"
}
},
"com.amazonaws.glue#LogGroup": {
"type": "string",
"traits": {
@ -15081,6 +15450,44 @@
"target": "com.amazonaws.glue#Permission"
}
},
"com.amazonaws.glue#PermissionType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "COLUMN_PERMISSION",
"name": "COLUMN_PERMISSION"
},
{
"value": "CELL_FILTER_PERMISSION",
"name": "CELL_FILTER_PERMISSION"
}
]
}
},
"com.amazonaws.glue#PermissionTypeList": {
"type": "list",
"member": {
"target": "com.amazonaws.glue#PermissionType"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 255
}
}
},
"com.amazonaws.glue#PermissionTypeMismatchException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.glue#MessageString"
}
},
"traits": {
"smithy.api#error": "client"
}
},
"com.amazonaws.glue#PhysicalConnectionRequirements": {
"type": "structure",
"members": {
@ -17860,6 +18267,9 @@
"smithy.api#documentation": "<p>The physical location of the table. By default, this takes the form of the warehouse\n location, followed by the database location in the warehouse, followed by the table\n name.</p>"
}
},
"AdditionalLocations": {
"target": "com.amazonaws.glue#LocationStringList"
},
"InputFormat": {
"target": "com.amazonaws.glue#FormatString",
"traits": {
@ -19118,6 +19528,26 @@
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$"
}
},
"com.amazonaws.glue#UnfilteredPartition": {
"type": "structure",
"members": {
"Partition": {
"target": "com.amazonaws.glue#Partition"
},
"AuthorizedColumns": {
"target": "com.amazonaws.glue#NameStringList"
},
"IsRegisteredWithLakeFormation": {
"target": "com.amazonaws.glue#Boolean"
}
}
},
"com.amazonaws.glue#UnfilteredPartitionList": {
"type": "list",
"member": {
"target": "com.amazonaws.glue#UnfilteredPartition"
}
},
"com.amazonaws.glue#UntagResource": {
"type": "operation",
"input": {
@ -19626,6 +20056,9 @@
"smithy.api#documentation": "<p>Specifies data lineage configuration settings for the crawler.</p>"
}
},
"LakeFormationConfiguration": {
"target": "com.amazonaws.glue#LakeFormationConfiguration"
},
"Configuration": {
"target": "com.amazonaws.glue#CrawlerConfiguration",
"traits": {

330
aws/sdk/aws-models/greengrassv2.json
View File

@ -110,6 +110,56 @@
}
}
},
"com.amazonaws.greengrassv2#AssociateServiceRoleToAccount": {
"type": "operation",
"input": {
"target": "com.amazonaws.greengrassv2#AssociateServiceRoleToAccountRequest"
},
"output": {
"target": "com.amazonaws.greengrassv2#AssociateServiceRoleToAccountResponse"
},
"errors": [
{
"target": "com.amazonaws.greengrassv2#InternalServerException"
},
{
"target": "com.amazonaws.greengrassv2#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass\n uses this role to verify the identity of client devices and manage core device connectivity\n information. The role must include the <a href=\"https://console.aws.amazon.com/iam/home#/policies/arn:awsiam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy\">AWSGreengrassResourceAccessRolePolicy</a> managed policy or a custom policy that\n defines equivalent permissions for the IoT Greengrass features that you use. For more information, see\n <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html\">Greengrass service role</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/greengrass/servicerole",
"code": 200
}
}
},
"com.amazonaws.greengrassv2#AssociateServiceRoleToAccountRequest": {
"type": "structure",
"members": {
"roleArn": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the service role to associate with IoT Greengrass for your\n Amazon Web Services account in this Amazon Web Services Region.</p>",
"smithy.api#jsonName": "RoleArn",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.greengrassv2#AssociateServiceRoleToAccountResponse": {
"type": "structure",
"members": {
"associatedAt": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.</p>",
"smithy.api#jsonName": "AssociatedAt"
}
}
}
},
"com.amazonaws.greengrassv2#AssociatedClientDevice": {
"type": "structure",
"members": {
@ -168,7 +218,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Associate a list of client devices with a core device. Use this API operation to specify\n which client devices can discover a core device through cloud discovery. With cloud discovery,\n client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information\n and certificates. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html\">Configure cloud\n discovery</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>\n \n <note>\n <p>Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core\n device over MQTT. You can connect client devices to a core device to sync MQTT messages and\n data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information,\n see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html\">Interact with\n local IoT devices</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>\n </note>",
"smithy.api#documentation": "<p>Associates a list of client devices with a core device. Use this API operation to specify\n which client devices can discover a core device through cloud discovery. With cloud discovery,\n client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information\n and certificates. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html\">Configure cloud\n discovery</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>\n \n <note>\n <p>Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core\n device over MQTT. You can connect client devices to a core device to sync MQTT messages and\n data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information,\n see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html\">Interact with\n local IoT devices</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>\n </note>",
"smithy.api#http": {
"method": "POST",
"uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/associateClientDevices",
@ -232,7 +282,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Disassociate a list of client devices from a core device. After you disassociate a client\n device from a core device, the client device won't be able to use cloud discovery to retrieve\n the core device's connectivity information and certificates.</p>",
"smithy.api#documentation": "<p>Disassociates a list of client devices from a core device. After you disassociate a client\n device from a core device, the client device won't be able to use cloud discovery to retrieve\n the core device's connectivity information and certificates.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/disassociateClientDevices",
@ -265,7 +315,7 @@
"errorEntries": {
"target": "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceErrorList",
"traits": {
"smithy.api#documentation": "<p>The list of errors (if any) for the entries in the request. Each error entry contains the\n name of the IoT thing that failed to disassociate.</p>"
"smithy.api#documentation": "<p>The list of any errors for the entries in the request. Each error entry contains the name\n of the IoT thing that failed to disassociate.</p>"
}
}
}
@ -803,6 +853,42 @@
"smithy.api#httpError": 409
}
},
"com.amazonaws.greengrassv2#ConnectivityInfo": {
"type": "structure",
"members": {
"id": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>An ID for the connectivity information.</p>",
"smithy.api#jsonName": "Id"
}
},
"hostAddress": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>The IP address or DNS address where client devices can connect to an MQTT broker on the\n Greengrass core device.</p>",
"smithy.api#jsonName": "HostAddress"
}
},
"portNumber": {
"target": "com.amazonaws.greengrassv2#PortNumberInt",
"traits": {
"smithy.api#documentation": "<p>The port where the MQTT broker operates on the core device. This port is typically 8883,\n which is the default port for the MQTT broker component that runs on core devices.</p>",
"smithy.api#jsonName": "PortNumber"
}
},
"metadata": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>Additional metadata to provide to client devices that connect to this core device.</p>",
"smithy.api#jsonName": "Metadata"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains information about an endpoint and port where client devices can connect to an\n MQTT broker on a Greengrass core device.</p>"
}
},
"com.amazonaws.greengrassv2#CoreDevice": {
"type": "structure",
"members": {
@ -815,7 +901,7 @@
"status": {
"target": "com.amazonaws.greengrassv2#CoreDeviceStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the core device. Core devices can have the following statuses:</p>\n <ul>\n <li>\n <p>\n <code>HEALTHY</code> – The IoT Greengrass Core software and all components run on the core device without issue.</p>\n </li>\n <li>\n <p>\n <code>UNHEALTHY</code> – The IoT Greengrass Core software or a component is in a failed state\n on the core device.</p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>The status of the core device. Core devices can have the following\n statuses:</p>\n <ul>\n <li>\n <p>\n <code>HEALTHY</code> – The IoT Greengrass Core software and all components run on the core device without issue.</p>\n </li>\n <li>\n <p>\n <code>UNHEALTHY</code> – The IoT Greengrass Core software or a component is in a failed state\n on the core device.</p>\n </li>\n </ul>"
}
},
"lastStatusUpdateTimestamp": {
@ -1603,6 +1689,44 @@
}
}
},
"com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccount": {
"type": "operation",
"input": {
"target": "com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccountRequest"
},
"output": {
"target": "com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccountResponse"
},
"errors": [
{
"target": "com.amazonaws.greengrassv2#InternalServerException"
}
],
"traits": {
"smithy.api#documentation": "<p>Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.\n Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device\n connectivity information. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html\">Greengrass service role</a> in\n the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/greengrass/servicerole",
"code": 200
}
}
},
"com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccountRequest": {
"type": "structure",
"members": {}
},
"com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccountResponse": {
"type": "structure",
"members": {
"disassociatedAt": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>The time when the service role was disassociated from IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.</p>",
"smithy.api#jsonName": "DisassociatedAt"
}
}
}
},
"com.amazonaws.greengrassv2#EffectiveDeployment": {
"type": "structure",
"members": {
@ -1882,6 +2006,63 @@
}
}
},
"com.amazonaws.greengrassv2#GetConnectivityInfo": {
"type": "operation",
"input": {
"target": "com.amazonaws.greengrassv2#GetConnectivityInfoRequest"
},
"output": {
"target": "com.amazonaws.greengrassv2#GetConnectivityInfoResponse"
},
"errors": [
{
"target": "com.amazonaws.greengrassv2#InternalServerException"
},
{
"target": "com.amazonaws.greengrassv2#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Retrieves connectivity information for a Greengrass core device.</p>\n <p>Connectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html\">Greengrass discovery API</a>,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html\">Connect client devices to\n core devices</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/greengrass/things/{thingName}/connectivityInfo",
"code": 200
}
}
},
"com.amazonaws.greengrassv2#GetConnectivityInfoRequest": {
"type": "structure",
"members": {
"thingName": {
"target": "com.amazonaws.greengrassv2#CoreDeviceThingName",
"traits": {
"smithy.api#documentation": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.greengrassv2#GetConnectivityInfoResponse": {
"type": "structure",
"members": {
"connectivityInfo": {
"target": "com.amazonaws.greengrassv2#connectivityInfoList",
"traits": {
"smithy.api#documentation": "<p>The connectivity information for the core device.</p>",
"smithy.api#jsonName": "ConnectivityInfo"
}
},
"message": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>A message about the connectivity information request.</p>",
"smithy.api#jsonName": "Message"
}
}
}
},
"com.amazonaws.greengrassv2#GetCoreDevice": {
"type": "operation",
"input": {
@ -2106,6 +2287,51 @@
}
}
},
"com.amazonaws.greengrassv2#GetServiceRoleForAccount": {
"type": "operation",
"input": {
"target": "com.amazonaws.greengrassv2#GetServiceRoleForAccountRequest"
},
"output": {
"target": "com.amazonaws.greengrassv2#GetServiceRoleForAccountResponse"
},
"errors": [
{
"target": "com.amazonaws.greengrassv2#InternalServerException"
}
],
"traits": {
"smithy.api#documentation": "<p>Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.\n IoT Greengrass uses this role to verify the identity of client devices and manage core device\n connectivity information. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html\">Greengrass service role</a> in\n the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/greengrass/servicerole",
"code": 200
}
}
},
"com.amazonaws.greengrassv2#GetServiceRoleForAccountRequest": {
"type": "structure",
"members": {}
},
"com.amazonaws.greengrassv2#GetServiceRoleForAccountResponse": {
"type": "structure",
"members": {
"associatedAt": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.</p>",
"smithy.api#jsonName": "AssociatedAt"
}
},
"roleArn": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>The ARN of the service role that is associated with IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.</p>",
"smithy.api#jsonName": "RoleArn"
}
}
}
},
"com.amazonaws.greengrassv2#GreengrassV2": {
"type": "service",
"traits": {
@ -2125,6 +2351,9 @@
},
"version": "2020-11-30",
"operations": [
{
"target": "com.amazonaws.greengrassv2#AssociateServiceRoleToAccount"
},
{
"target": "com.amazonaws.greengrassv2#BatchAssociateClientDeviceWithCoreDevice"
},
@ -2149,18 +2378,27 @@
{
"target": "com.amazonaws.greengrassv2#DescribeComponent"
},
{
"target": "com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccount"
},
{
"target": "com.amazonaws.greengrassv2#GetComponent"
},
{
"target": "com.amazonaws.greengrassv2#GetComponentVersionArtifact"
},
{
"target": "com.amazonaws.greengrassv2#GetConnectivityInfo"
},
{
"target": "com.amazonaws.greengrassv2#GetCoreDevice"
},
{
"target": "com.amazonaws.greengrassv2#GetDeployment"
},
{
"target": "com.amazonaws.greengrassv2#GetServiceRoleForAccount"
},
{
"target": "com.amazonaws.greengrassv2#ListClientDevicesAssociatedWithCoreDevice"
},
@ -2193,6 +2431,9 @@
},
{
"target": "com.amazonaws.greengrassv2#UntagResource"
},
{
"target": "com.amazonaws.greengrassv2#UpdateConnectivityInfo"
}
]
},
@ -3624,6 +3865,15 @@
"target": "com.amazonaws.greengrassv2#NonEmptyString"
}
},
"com.amazonaws.greengrassv2#PortNumberInt": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 65535
}
}
},
"com.amazonaws.greengrassv2#PublisherString": {
"type": "string"
},
@ -4080,6 +4330,72 @@
"type": "structure",
"members": {}
},
"com.amazonaws.greengrassv2#UpdateConnectivityInfo": {
"type": "operation",
"input": {
"target": "com.amazonaws.greengrassv2#UpdateConnectivityInfoRequest"
},
"output": {
"target": "com.amazonaws.greengrassv2#UpdateConnectivityInfoResponse"
},
"errors": [
{
"target": "com.amazonaws.greengrassv2#InternalServerException"
},
{
"target": "com.amazonaws.greengrassv2#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Updates connectivity information for a Greengrass core device.</p>\n <p>Connectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html\">Greengrass discovery API</a>,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html\">Connect client devices to\n core devices</a> in the <i>IoT Greengrass Version 2 Developer Guide</i>.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/greengrass/things/{thingName}/connectivityInfo",
"code": 200
}
}
},
"com.amazonaws.greengrassv2#UpdateConnectivityInfoRequest": {
"type": "structure",
"members": {
"thingName": {
"target": "com.amazonaws.greengrassv2#CoreDeviceThingName",
"traits": {
"smithy.api#documentation": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"smithy.api#httpLabel": {},
"smithy.api#jsonName": "ThingName",
"smithy.api#required": {}
}
},
"connectivityInfo": {
"target": "com.amazonaws.greengrassv2#connectivityInfoList",
"traits": {
"smithy.api#documentation": "<p>The connectivity information for the core device.</p>",
"smithy.api#jsonName": "ConnectivityInfo",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.greengrassv2#UpdateConnectivityInfoResponse": {
"type": "structure",
"members": {
"version": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>The new version of the connectivity information for the core device.</p>",
"smithy.api#jsonName": "Version"
}
},
"message": {
"target": "com.amazonaws.greengrassv2#String",
"traits": {
"smithy.api#documentation": "<p>A message about the connectivity information update request.</p>",
"smithy.api#jsonName": "Message"
}
}
}
},
"com.amazonaws.greengrassv2#ValidationException": {
"type": "structure",
"members": {
@ -4158,6 +4474,12 @@
}
]
}
},
"com.amazonaws.greengrassv2#connectivityInfoList": {
"type": "list",
"member": {
"target": "com.amazonaws.greengrassv2#ConnectivityInfo"
}
}
}
}

22
aws/sdk/aws-models/health.json
View File

@ -43,7 +43,7 @@
"name": "health"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<fullname>Health</fullname>\n \n <p>The Health API provides programmatic access to the Health information that\n appears in the <a href=\"https://phd.aws.amazon.com/phd/home#/\">Personal Health Dashboard</a>. You\n can use the API operations to get information about events that might affect your Amazon Web Services\n services and resources.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a> to use the\n Health API. If you call the Health API from an Amazon Web Services account that\n doesn't have a Business or Enterprise Support plan, you receive a\n <code>SubscriptionRequiredException</code> error.</p>\n </li>\n <li>\n <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to\n call the Health API operations. Health supports a multi-Region\n application architecture and has two regional endpoints in an active-passive\n configuration. You can use the high availability endpoint example to determine\n which Amazon Web Services Region is active, so that you can get the latest information from the\n API. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/health-api.html\">Accessing the Health API</a> in the\n <i>Health User Guide</i>.</p>\n </li>\n </ul>\n </note>\n <p>For authentication of requests, Health uses the <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing\n Process</a>.</p>\n <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational\n view feature. This feature provides a centralized view of Health events across all\n accounts in your organization. You can aggregate Health events in real time to\n identify accounts in your organization that are affected by an operational event or get\n notified of security vulnerabilities. Use the organizational view API operations to enable\n this feature and return event information. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating\n Health events</a> in the <i>Health User Guide</i>.</p>\n <note>\n <p>When you use the Health API operations to return Health events, see the\n following recommendations:</p>\n <ul>\n <li>\n <p>Use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode\">eventScopeCode</a> parameter to specify whether to return Health\n events that are public or account-specific.</p>\n </li>\n <li>\n <p>Use pagination to view all events from the response. For example, if you call\n the <code>DescribeEventsForOrganization</code> operation to get all events in your\n organization, you might receive several page results. Specify the\n <code>nextToken</code> in the next request to return more results.</p>\n </li>\n </ul>\n </note>",
"smithy.api#documentation": "<fullname>Health</fullname>\n \n <p>The Health API provides programmatic access to the Health information that\n appears in the <a href=\"https://phd.aws.amazon.com/phd/home#/\">Personal Health Dashboard</a>. You\n can use the API operations to get information about events that might affect your Amazon Web Services services and resources.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a> to use the Health\n API. If you call the Health API from an Amazon Web Services account that\n doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a\n <code>SubscriptionRequiredException</code> error.</p>\n </li>\n <li>\n <p>You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to\n call the Health API operations. Health supports a multi-Region\n application architecture and has two regional endpoints in an active-passive\n configuration. You can use the high availability endpoint example to determine\n which Amazon Web Services Region is active, so that you can get the latest information from the\n API. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/health-api.html\">Accessing the Health API</a> in the\n <i>Health User Guide</i>.</p>\n </li>\n </ul>\n </note>\n <p>For authentication of requests, Health uses the <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing\n Process</a>.</p>\n <p>If your Amazon Web Services account is part of Organizations, you can use the Health organizational\n view feature. This feature provides a centralized view of Health events across all\n accounts in your organization. You can aggregate Health events in real time to\n identify accounts in your organization that are affected by an operational event or get\n notified of security vulnerabilities. Use the organizational view API operations to enable\n this feature and return event information. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating\n Health events</a> in the <i>Health User Guide</i>.</p>\n <note>\n <p>When you use the Health API operations to return Health events, see the\n following recommendations:</p>\n <ul>\n <li>\n <p>Use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode\">eventScopeCode</a> parameter to specify whether to return Health\n events that are public or account-specific.</p>\n </li>\n <li>\n <p>Use pagination to view all events from the response. For example, if you call\n the <code>DescribeEventsForOrganization</code> operation to get all events in your\n organization, you might receive several page results. Specify the\n <code>nextToken</code> in the next request to return more results.</p>\n </li>\n </ul>\n </note>",
"smithy.api#title": "AWS Health APIs and Notifications"
},
"version": "2016-08-04",
@ -265,7 +265,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of entities that have been affected by the specified events, based on the\n specified filter criteria. Entities can refer to individual customer resources, groups of\n customer resources, or any other construct, depending on the Amazon Web Services service. Events that\n have impact beyond that of the affected entities, or where the extent of impact is unknown,\n include at least one entity indicating this.</p>\n <p>At least one event ARN is required.</p>\n \n <note>\n <ul>\n <li>\n <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>\n </li>\n <li>\n <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more\n information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>\n </li>\n </ul>\n </note>",
"smithy.api#documentation": "<p>Returns a list of entities that have been affected by the specified events, based on the\n specified filter criteria. Entities can refer to individual customer resources, groups of\n customer resources, or any other construct, depending on the Amazon Web Services service. Events that\n have impact beyond that of the affected entities, or where the extent of impact is unknown,\n include at least one entity indicating this.</p>\n <p>At least one event ARN is required.</p>\n\n <note>\n <ul>\n <li>\n <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>\n </li>\n <li>\n <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more\n information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>\n </li>\n </ul>\n </note>",
"smithy.api#idempotent": {},
"smithy.api#paginated": {
"inputToken": "nextToken",
@ -292,7 +292,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of entities that have been affected by one or more events for one or more\n accounts in your organization in Organizations, based on the filter criteria. Entities can refer\n to individual customer resources, groups of customer resources, or any other construct,\n depending on the Amazon Web Services service.</p>\n <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>\n <p>Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a>\n operation from your organization's management account.</p>\n <note>\n <ul>\n <li>\n <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>\n </li>\n <li>\n <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more\n information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>\n </li>\n </ul>\n \n </note>",
"smithy.api#documentation": "<p>Returns a list of entities that have been affected by one or more events for one or more\n accounts in your organization in Organizations, based on the filter criteria. Entities can refer\n to individual customer resources, groups of customer resources, or any other construct,\n depending on the Amazon Web Services service.</p>\n <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>\n <p>Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's\n management account.</p>\n <note>\n <ul>\n <li>\n <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>\n </li>\n <li>\n <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more\n information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>\n </li>\n </ul>\n\n </note>",
"smithy.api#idempotent": {},
"smithy.api#paginated": {
"inputToken": "nextToken",
@ -552,7 +552,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns detailed information about one or more specified events for one or more\n Amazon Web Services accounts in your organization. This information includes standard event data (such as the\n Amazon Web Services Region and service), an event description, and (depending on the event) possible\n metadata. This operation doesn't return affected entities, such as the resources related to\n the event. To return affected entities, use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html\">DescribeAffectedEntitiesForOrganization</a> operation.</p>\n <note>\n <p>Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's\n management account.</p>\n </note>\n <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify\n the <code>organizationEventDetailFilters</code> object in the request. Depending on the\n Health event type, note the following differences:</p>\n <ul>\n <li>\n <p>To return event details for a public event, you must specify a null value for the\n <code>awsAccountId</code> parameter. If you specify an account ID for a public\n event, Health returns an error message because public events aren't specific to\n an account.</p>\n </li>\n <li>\n <p>To return event details for an event that is specific to an account in your\n organization, you must specify the <code>awsAccountId</code> parameter in the\n request. If you don't specify an account ID, Health returns an error message\n because the event is specific to an account in your organization. </p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html\">Event</a>.</p>\n\n <note>\n <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more\n information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>\n </note>",
"smithy.api#documentation": "<p>Returns detailed information about one or more specified events for one or more\n Amazon Web Services accounts in your organization. This information includes standard event data (such as\n the Amazon Web Services Region and service), an event description, and (depending on the event) possible\n metadata. This operation doesn't return affected entities, such as the resources related to\n the event. To return affected entities, use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html\">DescribeAffectedEntitiesForOrganization</a> operation.</p>\n <note>\n <p>Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's\n management account.</p>\n </note>\n <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify\n the <code>organizationEventDetailFilters</code> object in the request. Depending on the\n Health event type, note the following differences:</p>\n <ul>\n <li>\n <p>To return event details for a public event, you must specify a null value for the\n <code>awsAccountId</code> parameter. If you specify an account ID for a public\n event, Health returns an error message because public events aren't specific to\n an account.</p>\n </li>\n <li>\n <p>To return event details for an event that is specific to an account in your\n organization, you must specify the <code>awsAccountId</code> parameter in the\n request. If you don't specify an account ID, Health returns an error message\n because the event is specific to an account in your organization. </p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html\">Event</a>.</p>\n\n <note>\n <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more\n information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>\n </note>",
"smithy.api#idempotent": {}
}
},
@ -661,7 +661,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the event types that meet the specified filter criteria. You can use this API\n operation to find information about the Health event, such as the category, Amazon Web Services\n service, and event code. The metadata for each event appears in the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html\">EventType</a> object. </p>\n <p>If you don't specify a filter criteria, the API operation returns all event types, in no\n particular order. </p>\n <note>\n <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>\n </note>",
"smithy.api#documentation": "<p>Returns the event types that meet the specified filter criteria. You can use this API\n operation to find information about the Health event, such as the category, Amazon Web Services\n service, and event code. The metadata for each event appears in the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html\">EventType</a> object. </p>\n <p>If you don't specify a filter criteria, the API operation returns all event types, in no\n particular order. </p>\n <note>\n <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>\n </note>",
"smithy.api#idempotent": {},
"smithy.api#paginated": {
"inputToken": "nextToken",
@ -879,7 +879,7 @@
"healthServiceAccessStatusForOrganization": {
"target": "com.amazonaws.health#healthServiceAccessStatusForOrganization",
"traits": {
"smithy.api#documentation": "<p>Information about the status of enabling or disabling the Health organizational\n view feature in\n your organization.</p>\n <p>Valid values are <code>ENABLED | DISABLED | PENDING</code>. </p>"
"smithy.api#documentation": "<p>Information about the status of enabling or disabling the Health organizational\n view feature in your organization.</p>\n <p>Valid values are <code>ENABLED | DISABLED | PENDING</code>. </p>"
}
}
}
@ -892,7 +892,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Disables Health from working with Organizations. To call this operation, you must sign\n in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not\n recommended) in the organization's management account. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating\n Health events</a> in the\n <i>Health User Guide</i>.</p>\n <p>This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to\n remove the service-linked role. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role\">Deleting a Service-Linked Role</a> in the\n <i>IAM User Guide</i>.</p>\n <note>\n <p>You can also disable the organizational feature by using the Organizations <a href=\"https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html\">DisableAWSServiceAccess</a> API operation. After you call this operation,\n Health stops aggregating events for all other Amazon Web Services accounts in your organization.\n If you call the Health API operations for organizational view, Health returns\n an error. Health continues to aggregate health events for your Amazon Web Services account.</p>\n </note>",
"smithy.api#documentation": "<p>Disables Health from working with Organizations. To call this operation, you must sign\n in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not\n recommended) in the organization's management account. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating\n Health events</a> in the <i>Health User Guide</i>.</p>\n <p>This operation doesn't remove the service-linked role from the management account in your\n organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the\n service-linked role. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role\">Deleting a Service-Linked Role</a> in the\n <i>IAM User Guide</i>.</p>\n <note>\n <p>You can also disable the organizational feature by using the Organizations <a href=\"https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html\">DisableAWSServiceAccess</a> API operation. After you call this operation,\n Health stops aggregating events for all other Amazon Web Services accounts in your organization.\n If you call the Health API operations for organizational view, Health returns\n an error. Health continues to aggregate health events for your\n Amazon Web Services account.</p>\n </note>",
"smithy.api#idempotent": {}
}
},
@ -904,7 +904,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Enables Health to work with Organizations. You can use the organizational view feature\n to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. </p>\n <p>This operation also creates a service-linked role for the management account in the\n organization. </p>\n <note>\n <p>To call this operation, you must meet the following requirements:</p>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a> to use the Health\n API. If you call the Health API from an Amazon Web Services account that doesn't have a\n Business or Enterprise Support plan, you receive a\n <code>SubscriptionRequiredException</code> error.</p>\n </li>\n <li>\n <p>You must have permission to call this operation from the organization's\n management account. For example IAM policies, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html\">Health\n identity-based policy examples</a>.</p>\n </li>\n </ul>\n </note>\n <p>If you don't have the required support plan, you can instead use the Health console\n to enable the organizational view feature. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating\n Health events</a> in the <i>Health User Guide</i>.</p>",
"smithy.api#documentation": "<p>Enables Health to work with Organizations. You can use the organizational view feature\n to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. </p>\n <p>This operation also creates a service-linked role for the management account in the\n organization. </p>\n <note>\n <p>To call this operation, you must meet the following requirements:</p>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a> to use the Health\n API. If you call the Health API from an Amazon Web Services account that doesn't have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a\n <code>SubscriptionRequiredException</code> error.</p>\n </li>\n <li>\n <p>You must have permission to call this operation from the organization's\n management account. For example IAM policies, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html\">Health\n identity-based policy examples</a>.</p>\n </li>\n </ul>\n </note>\n <p>If you don't have the required support plan, you can instead use the Health console\n to enable the organizational view feature. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating\n Health events</a> in the <i>Health User Guide</i>.</p>",
"smithy.api#idempotent": {}
}
},
@ -976,7 +976,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>The values to use to filter results from the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html\">DescribeAffectedEntities</a>\n operation.</p>"
"smithy.api#documentation": "<p>The values to use to filter results from the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html\">DescribeAffectedEntities</a> operation.</p>"
}
},
"com.amazonaws.health#EntityList": {
@ -1056,7 +1056,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>Summary information about an Health event.</p>\n <p>Health events can be public or account-specific:</p>\n <ul>\n <li>\n <p>\n <i>Public events</i> might be service events that are not specific\n to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region,\n Health provides information about the event, even if you don't use services or\n resources in that Region.</p>\n </li>\n <li>\n <p>\n <i>Account-specific</i> events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with\n Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event\n and the affected resources in the account.</p>\n </li>\n </ul>\n <p>You can determine if an event is public or account-specific by using the\n <code>eventScopeCode</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode\">eventScopeCode</a>.</p>"
"smithy.api#documentation": "<p>Summary information about an Health event.</p>\n <p>Health events can be public or account-specific:</p>\n <ul>\n <li>\n <p>\n <i>Public events</i> might be service events that are not specific\n to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region,\n Health provides information about the event, even if you don't use services or\n resources in that Region.</p>\n </li>\n <li>\n <p>\n <i>Account-specific</i> events are specific to either your\n Amazon Web Services account or an account in your organization. For example, if there's an issue\n with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the\n event and the affected resources in the account.</p>\n </li>\n </ul>\n <p>You can determine if an event is public or account-specific by using the\n <code>eventScopeCode</code> parameter. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html#AWSHealth-Type-Event-eventScopeCode\">eventScopeCode</a>.</p>"
}
},
"com.amazonaws.health#EventAccountFilter": {
@ -1557,7 +1557,7 @@
"errorMessage": {
"target": "com.amazonaws.health#string",
"traits": {
"smithy.api#documentation": "<p>A message that describes the error.</p>\n <p>If you call the <code>DescribeEventDetailsForOrganization</code> operation and receive one of the following errors, follow the recommendations in the message:</p> \n <ul>\n <li>\n <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.</p>\n </li>\n <li>\n <p>We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.</p>\n </li>\n <li>\n <p>Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business or Enterprise Support plan.</p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>A message that describes the error.</p> \n <p>If you call the <code>DescribeEventDetailsForOrganization</code> operation and receive one of the following errors, follow the recommendations in the message:</p> \n <ul>\n <li>\n <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.</p>\n </li>\n <li>\n <p>We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.</p>\n </li>\n <li>\n <p>Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the\nHealth API. You must have either a Business, Enterprise On-Ramp, or Enterprise Support plan.</p>\n </li>\n </ul>"
}
}
},

228
aws/sdk/aws-models/imagebuilder.json
View File

@ -174,6 +174,25 @@
"com.amazonaws.imagebuilder#Boolean": {
"type": "boolean"
},
"com.amazonaws.imagebuilder#BuildType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "USER_INITIATED",
"name": "USER_INITIATED"
},
{
"value": "SCHEDULED",
"name": "SCHEDULED"
},
{
"value": "IMPORT",
"name": "IMPORT"
}
]
}
},
"com.amazonaws.imagebuilder#CallRateLimitExceededException": {
"type": "structure",
"members": {
@ -243,7 +262,7 @@
"clientToken": {
"target": "com.amazonaws.imagebuilder#ClientToken",
"traits": {
"smithy.api#documentation": "<p>The idempotency token used to make this request idempotent.</p>",
"smithy.api#documentation": "<p>Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a> \n in the <i>Amazon EC2 API Reference</i>.</p>",
"smithy.api#idempotencyToken": {},
"smithy.api#required": {}
}
@ -262,7 +281,7 @@
"clientToken": {
"target": "com.amazonaws.imagebuilder#ClientToken",
"traits": {
"smithy.api#documentation": "<p>The idempotency token used to make this request idempotent.</p>"
"smithy.api#documentation": "<p>The idempotency token that was used for this request.</p>"
}
},
"imageBuildVersionArn": {
@ -2018,7 +2037,7 @@
"snsTopicArn": {
"target": "com.amazonaws.imagebuilder#SnsTopicArn",
"traits": {
"smithy.api#documentation": "<p>The SNS topic on which to send image build events.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</p>\n\t\t <note>\n\t\t\t <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.</p>\n\t\t </note>"
}
},
"resourceTags": {
@ -2565,6 +2584,25 @@
}
}
},
"com.amazonaws.imagebuilder#DiskImageFormat": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "VMDK",
"name": "VMDK"
},
{
"value": "RAW",
"name": "RAW"
},
{
"value": "VHD",
"name": "VHD"
}
]
}
},
"com.amazonaws.imagebuilder#Distribution": {
"type": "structure",
"members": {
@ -2598,6 +2636,12 @@
"traits": {
"smithy.api#documentation": "<p>A group of launchTemplateConfiguration settings that apply to image distribution \n\t\t\tfor specified accounts.</p>"
}
},
"s3ExportConfiguration": {
"target": "com.amazonaws.imagebuilder#S3ExportConfiguration",
"traits": {
"smithy.api#documentation": "<p>Configure export settings to deliver disk images created from your image build, \n\t\t\tusing a file format that is compatible with your VMs in that Region.</p>"
}
}
},
"traits": {
@ -3826,6 +3870,12 @@
"traits": {
"smithy.api#documentation": "<p>The tags of the image.</p>"
}
},
"buildType": {
"target": "com.amazonaws.imagebuilder#BuildType",
"traits": {
"smithy.api#documentation": "<p>Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <b>USER_INITIATED</b> – A manual \n\t\t\t\t\tpipeline build request.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <b>SCHEDULED</b> – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <b>IMPORT</b> – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.</p>\n\t\t\t </li>\n </ul>"
}
}
},
"traits": {
@ -4285,6 +4335,12 @@
"traits": {
"smithy.api#documentation": "<p>The tags of the image.</p>"
}
},
"buildType": {
"target": "com.amazonaws.imagebuilder#BuildType",
"traits": {
"smithy.api#documentation": "<p>Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <b>USER_INITIATED</b> – A manual \n\t\t\t\t\tpipeline build request.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <b>SCHEDULED</b> – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <b>IMPORT</b> – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.</p>\n\t\t\t </li>\n </ul>"
}
}
},
"traits": {
@ -4303,7 +4359,7 @@
"imageTestsEnabled": {
"target": "com.amazonaws.imagebuilder#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p>Defines if tests should be executed when building this image.</p>"
"smithy.api#documentation": "<p>Determines if tests should run after building the image. Image Builder defaults \n\t\t\tto enable tests to run following the image build, before image distribution.</p>"
}
},
"timeoutMinutes": {
@ -4314,7 +4370,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>Image tests configuration.</p>"
"smithy.api#documentation": "<p>Configure image tests for your pipeline build. Tests run after building \n\t\t\tthe image, to verify that the AMI or container image is valid before \n\t\t\tdistributing it.</p>"
}
},
"com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes": {
@ -4392,6 +4448,12 @@
"traits": {
"smithy.api#documentation": "<p>The date on which this specific version of the Image Builder image was created.</p>"
}
},
"buildType": {
"target": "com.amazonaws.imagebuilder#BuildType",
"traits": {
"smithy.api#documentation": "<p>Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <b>USER_INITIATED</b> – A manual \n\t\t\t\t\tpipeline build request.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <b>SCHEDULED</b> – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <b>IMPORT</b> – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.</p>\n\t\t\t </li>\n </ul>"
}
}
},
"traits": {
@ -4572,6 +4634,116 @@
}
}
},
"com.amazonaws.imagebuilder#ImportVmImage": {
"type": "operation",
"input": {
"target": "com.amazonaws.imagebuilder#ImportVmImageRequest"
},
"output": {
"target": "com.amazonaws.imagebuilder#ImportVmImageResponse"
},
"errors": [
{
"target": "com.amazonaws.imagebuilder#ClientException"
},
{
"target": "com.amazonaws.imagebuilder#ServiceException"
},
{
"target": "com.amazonaws.imagebuilder#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>When you export your virtual machine (VM) from its virtualization environment, \n\t\t\tthat process creates a set of one or more disk container files that act as \n\t\t\tsnapshots of your VM’s environment, settings, and data. The Amazon EC2 API \n\t\t\t<a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html\">ImportImage</a> \n\t\t\taction uses those files to import your VM and create an AMI. To import using the \n\t\t\tCLI command, see <a href=\"https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html\">import-image</a>\n\t\t </p>\n\t\t <p>You can reference the task ID from the VM import to pull in the AMI that \n\t\t\tthe import created as the base image for your Image Builder recipe.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/ImportVmImage",
"code": 200
}
}
},
"com.amazonaws.imagebuilder#ImportVmImageRequest": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The name of the base image that is created by the import process.</p>",
"smithy.api#required": {}
}
},
"semanticVersion": {
"target": "com.amazonaws.imagebuilder#VersionNumber",
"traits": {
"smithy.api#documentation": "<p>The semantic version to attach to the base image that was created during the \n\t\t\timport process. This version follows the semantic version syntax.</p>\n\t\t <note>\n\t\t\t <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>. \n\tYou can assign values for the first three, and can filter on all of them.</p>\n\t\t\t <p>\n <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.</p>\n\t\t\t <p>\n <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.</p>\n\t\t </note>",
"smithy.api#required": {}
}
},
"description": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The description for the base image that is created by the import process.</p>"
}
},
"platform": {
"target": "com.amazonaws.imagebuilder#Platform",
"traits": {
"smithy.api#documentation": "<p>The operating system platform for the imported VM.</p>",
"smithy.api#required": {}
}
},
"osVersion": {
"target": "com.amazonaws.imagebuilder#OsVersion",
"traits": {
"smithy.api#documentation": "<p>The operating system version for the imported VM.</p>"
}
},
"vmImportTaskId": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The <code>importTaskId</code> (API) or <code>ImportTaskId</code> (CLI) from the \n\t\t\tAmazon EC2 VM import process. Image Builder retrieves information from the import process to pull \n\t\t\tin the AMI that is created from the VM source as the base image for your recipe.</p>",
"smithy.api#required": {}
}
},
"tags": {
"target": "com.amazonaws.imagebuilder#TagMap",
"traits": {
"smithy.api#documentation": "<p>Tags that are attached to the import resources.</p>"
}
},
"clientToken": {
"target": "com.amazonaws.imagebuilder#ClientToken",
"traits": {
"smithy.api#documentation": "<p>Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a> \n in the <i>Amazon EC2 API Reference</i>.</p>",
"smithy.api#idempotencyToken": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.imagebuilder#ImportVmImageResponse": {
"type": "structure",
"members": {
"requestId": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The request ID that uniquely identifies this request.</p>"
}
},
"imageArn": {
"target": "com.amazonaws.imagebuilder#Arn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the AMI that was created during the VM \n\t\t\timport process. This AMI is used as the base image for the recipe that \n\t\t\timported the VM.</p>"
}
},
"clientToken": {
"target": "com.amazonaws.imagebuilder#ClientToken",
"traits": {
"smithy.api#documentation": "<p>The idempotency token that was used for this request.</p>"
}
}
}
},
"com.amazonaws.imagebuilder#InfrastructureConfiguration": {
"type": "structure",
"members": {
@ -4638,7 +4810,7 @@
"snsTopicArn": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</p>\n\t\t <note>\n\t\t\t <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.</p>\n\t\t </note>"
}
},
"dateCreated": {
@ -6759,19 +6931,54 @@
}
}
},
"com.amazonaws.imagebuilder#S3ExportConfiguration": {
"type": "structure",
"members": {
"roleName": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The name of the role that grants VM Import/Export permission to \n\t\t\texport images to your S3 bucket.</p>",
"smithy.api#required": {}
}
},
"diskImageFormat": {
"target": "com.amazonaws.imagebuilder#DiskImageFormat",
"traits": {
"smithy.api#documentation": "<p>Export the updated image to one of the following supported disk \n\t\t\timage formats:</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n <b>Virtual Hard Disk (VHD)</b> – \n\t\t\t\t\tCompatible with Citrix Xen and Microsoft Hyper-V virtualization products.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <b>Stream-optimized ESX Virtual Machine Disk \n\t\t\t\t\t(VMDK)</b> – Compatible with VMware ESX and \n\t\t\t\t\tVMware vSphere versions 4, 5, and 6.</p>\n\t\t\t </li>\n <li>\n\t\t\t\t <p>\n <b>Raw</b> – Raw format.</p>\n\t\t\t </li>\n </ul>",
"smithy.api#required": {}
}
},
"s3Bucket": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The S3 bucket in which to store the output disk images for your VM.</p>",
"smithy.api#required": {}
}
},
"s3Prefix": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The Amazon S3 path for the bucket where the output disk images for your VM are stored.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Properties that configure export from your build instance \n\t\t\tto a compatible file format for your VM.</p>"
}
},
"com.amazonaws.imagebuilder#S3Logs": {
"type": "structure",
"members": {
"s3BucketName": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The Amazon S3 bucket in which to store the logs.</p>"
"smithy.api#documentation": "<p>The S3 bucket in which to store the logs.</p>"
}
},
"s3KeyPrefix": {
"target": "com.amazonaws.imagebuilder#NonEmptyString",
"traits": {
"smithy.api#documentation": "<p>The Amazon S3 path in which to store the logs.</p>"
"smithy.api#documentation": "<p>The Amazon S3 path to the bucket where the logs are stored.</p>"
}
}
},
@ -7496,7 +7703,7 @@
"snsTopicArn": {
"target": "com.amazonaws.imagebuilder#SnsTopicArn",
"traits": {
"smithy.api#documentation": "<p>The SNS topic on which to send image build events.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</p>\n\t\t <note>\n\t\t\t <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.</p>\n\t\t </note>"
}
},
"clientToken": {
@ -7663,6 +7870,9 @@
{
"target": "com.amazonaws.imagebuilder#ImportComponent"
},
{
"target": "com.amazonaws.imagebuilder#ImportVmImage"
},
{
"target": "com.amazonaws.imagebuilder#ListComponentBuildVersions"
},

237
aws/sdk/aws-models/iot.json
View File

@ -2827,6 +2827,12 @@
"traits": {
"smithy.api#documentation": "<p>Specifies whether IoT validates the token signature in an authorization request.</p>"
}
},
"enableCachingForHttp": {
"target": "com.amazonaws.iot#EnableCachingForHttp",
"traits": {
"smithy.api#documentation": "<p>When <code>true</code>, the result from the authorizer’s Lambda function is\n\t cached for the time specified in <code>refreshAfterInSeconds</code>. The cached\n\t result is used while the device reuses the same HTTP connection.</p>"
}
}
},
"traits": {
@ -2839,7 +2845,8 @@
"smithy.api#length": {
"min": 0,
"max": 2048
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#AuthorizerName": {
@ -4222,15 +4229,18 @@
"smithy.api#length": {
"min": 1,
"max": 65536
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#CertificateSigningRequest": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1
}
"min": 1,
"max": 4096
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#CertificateStateException": {
@ -4969,6 +4979,12 @@
"traits": {
"smithy.api#documentation": "<p>Specifies whether IoT validates the token signature in an authorization request.</p>"
}
},
"enableCachingForHttp": {
"target": "com.amazonaws.iot#EnableCachingForHttp",
"traits": {
"smithy.api#documentation": "<p>When <code>true</code>, the result from the authorizer’s Lambda function is\n\t cached for clients that use persistent HTTP connections. The results are cached for the time\n\t specified by the Lambda function in <code>refreshAfterInSeconds</code>. This value\n does not affect authorization of clients that use MQTT connections.</p>\n <p>The default value is <code>false</code>.</p>"
}
}
}
},
@ -5801,7 +5817,7 @@
"abortConfig": {
"target": "com.amazonaws.iot#AbortConfig",
"traits": {
"smithy.api#documentation": "<p>Allows you to create criteria to abort a job.</p>"
"smithy.api#documentation": "<p>Allows you to create the criteria to abort a job.</p>"
}
},
"timeoutConfig": {
@ -5828,6 +5844,12 @@
"smithy.api#documentation": "<p>The ARN of the job template used to create the job.</p>"
}
},
"jobExecutionsRetryConfig": {
"target": "com.amazonaws.iot#JobExecutionsRetryConfig",
"traits": {
"smithy.api#documentation": "<p>Allows you to create the criteria to retry a job.</p>"
}
},
"documentParameters": {
"target": "com.amazonaws.iot#ParameterMap",
"traits": {
@ -5949,6 +5971,12 @@
"traits": {
"smithy.api#documentation": "<p>Metadata that can be used to manage the job template.</p>"
}
},
"jobExecutionsRetryConfig": {
"target": "com.amazonaws.iot#JobExecutionsRetryConfig",
"traits": {
"smithy.api#documentation": "<p>Allows you to create the criteria to retry a job.</p>"
}
}
}
},
@ -11130,6 +11158,12 @@
},
"timeoutConfig": {
"target": "com.amazonaws.iot#TimeoutConfig"
},
"jobExecutionsRetryConfig": {
"target": "com.amazonaws.iot#JobExecutionsRetryConfig",
"traits": {
"smithy.api#documentation": "<p>The configuration that determines how many retries are allowed for each failure type\n for a job.</p>"
}
}
}
},
@ -13077,7 +13111,8 @@
"smithy.api#length": {
"min": 1,
"max": 253
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#DomainType": {
@ -13326,6 +13361,12 @@
"com.amazonaws.iot#ElasticsearchType": {
"type": "string"
},
"com.amazonaws.iot#EnableCachingForHttp": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.iot#EnableIoTLoggingParams": {
"type": "structure",
"members": {
@ -13407,7 +13448,8 @@
"smithy.api#length": {
"min": 0,
"max": 128
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#Environment": {
@ -15327,7 +15369,8 @@
"smithy.api#length": {
"min": 1,
"max": 8192
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#HttpHeaderValue": {
@ -15336,7 +15379,8 @@
"smithy.api#length": {
"min": 1,
"max": 8192
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#HttpHeaders": {
@ -15354,7 +15398,8 @@
"smithy.api#length": {
"min": 1,
"max": 4096
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#HttpUrlDestinationConfiguration": {
@ -15855,6 +15900,12 @@
"smithy.api#documentation": "<p>The ARN of the job template used to create the job.</p>"
}
},
"jobExecutionsRetryConfig": {
"target": "com.amazonaws.iot#JobExecutionsRetryConfig",
"traits": {
"smithy.api#documentation": "<p>The configuration for the criteria to retry the job.</p>"
}
},
"documentParameters": {
"target": "com.amazonaws.iot#ParameterMap",
"traits": {
@ -16079,6 +16130,12 @@
"traits": {
"smithy.api#documentation": "<p>A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on\n this particular device. It can be used later in commands which return or update job execution\n information.</p>"
}
},
"retryAttempt": {
"target": "com.amazonaws.iot#RetryAttempt",
"traits": {
"smithy.api#documentation": "<p>The number that indicates how many retry attempts have been completed for this \n job on this device.</p>"
}
}
},
"traits": {
@ -16137,6 +16194,21 @@
"target": "com.amazonaws.iot#JobExecutionSummaryForThing"
}
},
"com.amazonaws.iot#JobExecutionsRetryConfig": {
"type": "structure",
"members": {
"criteriaList": {
"target": "com.amazonaws.iot#RetryCriteriaList",
"traits": {
"smithy.api#documentation": "<p>The list of criteria that determines how many retries are allowed for each failure\n type for a job.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configuration that determines how many retries are allowed for each failure \n type for a job.</p>"
}
},
"com.amazonaws.iot#JobExecutionsRolloutConfig": {
"type": "structure",
"members": {
@ -16466,7 +16538,8 @@
"smithy.api#length": {
"min": 0,
"max": 5120
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#KinesisAction": {
@ -18407,6 +18480,13 @@
"smithy.api#documentation": "<p>The token to retrieve the next set of results.</p>",
"smithy.api#httpQuery": "nextToken"
}
},
"jobId": {
"target": "com.amazonaws.iot#JobId",
"traits": {
"smithy.api#documentation": "<p>The unique identifier you assigned to this job when it was created.</p>",
"smithy.api#httpQuery": "jobId"
}
}
}
},
@ -21638,7 +21718,8 @@
"smithy.api#length": {
"min": 0,
"max": 128
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#MessageFormat": {
@ -21996,7 +22077,8 @@
"smithy.api#length": {
"min": 1,
"max": 65535
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#MqttContext": {
@ -22040,7 +22122,8 @@
"smithy.api#length": {
"min": 1,
"max": 65535
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#NamedShadowIndexingMode": {
@ -22143,6 +22226,16 @@
"target": "com.amazonaws.iot#Number"
}
},
"com.amazonaws.iot#NumberOfRetries": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 0,
"max": 10
}
}
},
"com.amazonaws.iot#NumberOfThings": {
"type": "integer",
"traits": {
@ -22512,7 +22605,14 @@
}
},
"com.amazonaws.iot#Parameter": {
"type": "string"
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 2048
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#ParameterKey": {
"type": "string",
@ -22654,7 +22754,14 @@
"type": "string"
},
"com.amazonaws.iot#PolicyDocument": {
"type": "string"
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 404600
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#PolicyDocuments": {
"type": "list",
@ -24051,7 +24158,8 @@
"smithy.api#length": {
"min": 0,
"max": 2048
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#ResourceAlreadyExistsException": {
@ -24230,6 +24338,65 @@
"target": "com.amazonaws.iot#Resource"
}
},
"com.amazonaws.iot#RetryAttempt": {
"type": "integer",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.iot#RetryCriteria": {
"type": "structure",
"members": {
"failureType": {
"target": "com.amazonaws.iot#RetryableFailureType",
"traits": {
"smithy.api#documentation": "<p>The type of job execution failures that can initiate a job retry.</p>",
"smithy.api#required": {}
}
},
"numberOfRetries": {
"target": "com.amazonaws.iot#NumberOfRetries",
"traits": {
"smithy.api#documentation": "<p>The number of retries allowed for a failure type for the job.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>The criteria that determines how many retries are allowed for each failure\n type for a job.</p>"
}
},
"com.amazonaws.iot#RetryCriteriaList": {
"type": "list",
"member": {
"target": "com.amazonaws.iot#RetryCriteria"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 2
}
}
},
"com.amazonaws.iot#RetryableFailureType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "FAILED",
"name": "FAILED"
},
{
"value": "TIMED_OUT",
"name": "TIMED_OUT"
},
{
"value": "ALL",
"name": "ALL"
}
]
}
},
"com.amazonaws.iot#RoleAlias": {
"type": "string",
"traits": {
@ -24844,7 +25011,8 @@
"smithy.api#length": {
"min": 1,
"max": 253
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#ServiceName": {
@ -26391,7 +26559,14 @@
"type": "string"
},
"com.amazonaws.iot#TemplateBody": {
"type": "string"
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 10240
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#TemplateDescription": {
"type": "string",
@ -27368,7 +27543,8 @@
"smithy.api#length": {
"min": 1,
"max": 6144
}
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#TokenKeyName": {
@ -28172,6 +28348,12 @@
"traits": {
"smithy.api#documentation": "<p>The status of the update authorizer request.</p>"
}
},
"enableCachingForHttp": {
"target": "com.amazonaws.iot#EnableCachingForHttp",
"traits": {
"smithy.api#documentation": "<p>When <code>true</code>, the result from the authorizer’s Lambda function is\n\t cached for the time specified in <code>refreshAfterInSeconds</code>. The cached\n\t result is used while the device reuses the same HTTP connection.</p>"
}
}
}
},
@ -29081,6 +29263,12 @@
"smithy.api#documentation": "<p>The namespace used to indicate that a job is a customer-managed job.</p>\n <p>When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.</p>\n <p>\n <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code>\n </p>\n <note>\n <p>The <code>namespaceId</code> feature is in public preview.</p>\n </note>",
"smithy.api#httpQuery": "namespaceId"
}
},
"jobExecutionsRetryConfig": {
"target": "com.amazonaws.iot#JobExecutionsRetryConfig",
"traits": {
"smithy.api#documentation": "<p>Allows you to create the criteria to retry a job.</p>"
}
}
}
},
@ -30047,7 +30235,14 @@
}
},
"com.amazonaws.iot#Value": {
"type": "string"
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 4096
},
"smithy.api#pattern": "^[\\s\\S]*$"
}
},
"com.amazonaws.iot#Variance": {
"type": "double"

364
aws/sdk/aws-models/lakeformation.json
View File

@ -111,6 +111,12 @@
{
"target": "com.amazonaws.lakeformation#GetTableObjects"
},
{
"target": "com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentials"
},
{
"target": "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentials"
},
{
"target": "com.amazonaws.lakeformation#GetWorkUnitResults"
},
@ -192,6 +198,9 @@
"smithy.api#httpError": 403
}
},
"com.amazonaws.lakeformation#AccessKeyIdString": {
"type": "string"
},
"com.amazonaws.lakeformation#AddLFTagsToResource": {
"type": "operation",
"input": {
@ -322,6 +331,36 @@
"smithy.api#error": "client"
}
},
"com.amazonaws.lakeformation#AuditContext": {
"type": "structure",
"members": {
"AdditionalAuditContext": {
"target": "com.amazonaws.lakeformation#AuditContextString",
"traits": {
"smithy.api#documentation": "<p>The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A structure used to include auditing information on the privileged API. </p>"
}
},
"com.amazonaws.lakeformation#AuditContextString": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 2048
},
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$"
}
},
"com.amazonaws.lakeformation#AuthorizedSessionTagValueList": {
"type": "list",
"member": {
"target": "com.amazonaws.lakeformation#NameString"
}
},
"com.amazonaws.lakeformation#BatchGrantPermissions": {
"type": "operation",
"input": {
@ -874,6 +913,16 @@
"type": "structure",
"members": {}
},
"com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 900,
"max": 43200
}
}
},
"com.amazonaws.lakeformation#DataCellsFilter": {
"type": "structure",
"members": {
@ -920,7 +969,7 @@
"ColumnWildcard": {
"target": "com.amazonaws.lakeformation#ColumnWildcard",
"traits": {
"smithy.api#documentation": "<p>A wildcard with exclusions.</p>"
"smithy.api#documentation": "<p>A wildcard with exclusions.</p>\n \n <p>You must specify either a <code>ColumnNames</code> list or the\n <code>ColumnWildCard</code>. </p>"
}
}
},
@ -977,7 +1026,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>The AWS Lake Formation principal. Supported principals are IAM users or IAM roles.</p>"
"smithy.api#documentation": "<p>The Lake Formation principal. Supported principals are IAM users\n or IAM roles.</p>"
}
},
"com.amazonaws.lakeformation#DataLakePrincipalList": {
@ -1066,6 +1115,24 @@
"traits": {
"smithy.api#documentation": "<p>A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log.</p>\n\t\n\t <p>You may want to specify this property when you are in a high-trust boundary, such as the same team or company. </p>"
}
},
"AllowExternalDataFiltering": {
"target": "com.amazonaws.lakeformation#NullableBoolean",
"traits": {
"smithy.api#documentation": "<p>Whether to allow Amazon EMR clusters to access data managed by Lake Formation. </p>\n\t\n <p>If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.</p>\n\t\n <p>If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.</p>\n \n <p>For more information, see <a href=\"https://docs-aws.amazon.com/lake-formation/latest/dg/getting-started-setup.html#emr-switch\">(Optional) Allow Data Filtering on Amazon EMR</a>.</p>"
}
},
"ExternalDataFilteringAllowList": {
"target": "com.amazonaws.lakeformation#DataLakePrincipalList",
"traits": {
"smithy.api#documentation": "<p>A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.></p>"
}
},
"AuthorizedSessionTagValueList": {
"target": "com.amazonaws.lakeformation#AuthorizedSessionTagValueList",
"traits": {
"smithy.api#documentation": "<p>Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = \"LakeFormationTrustedCaller\" and value = \"TRUE\" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation's administrative APIs.</p>"
}
}
},
"traits": {
@ -1615,6 +1682,9 @@
"smithy.api#documentation": "<p>Statistics related to the processing of a query statement.</p>"
}
},
"com.amazonaws.lakeformation#ExpirationTimestamp": {
"type": "timestamp"
},
"com.amazonaws.lakeformation#ExpiredException": {
"type": "structure",
"members": {
@ -2321,6 +2391,219 @@
}
}
},
"com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentials": {
"type": "operation",
"input": {
"target": "com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentialsRequest"
},
"output": {
"target": "com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentialsResponse"
},
"errors": [
{
"target": "com.amazonaws.lakeformation#AccessDeniedException"
},
{
"target": "com.amazonaws.lakeformation#EntityNotFoundException"
},
{
"target": "com.amazonaws.lakeformation#InternalServiceException"
},
{
"target": "com.amazonaws.lakeformation#InvalidInputException"
},
{
"target": "com.amazonaws.lakeformation#OperationTimeoutException"
},
{
"target": "com.amazonaws.lakeformation#PermissionTypeMismatchException"
}
],
"traits": {
"smithy.api#documentation": "<p>This API is identical to <code>GetTemporaryTableCredentials</code> except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/GetTemporaryGluePartitionCredentials",
"code": 200
}
}
},
"com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentialsRequest": {
"type": "structure",
"members": {
"TableArn": {
"target": "com.amazonaws.lakeformation#ResourceArnString",
"traits": {
"smithy.api#documentation": "<p>The ARN of the partitions' table.</p>",
"smithy.api#required": {}
}
},
"Partition": {
"target": "com.amazonaws.lakeformation#PartitionValueList",
"traits": {
"smithy.api#documentation": "<p>A list of partition values identifying a single partition.</p>",
"smithy.api#required": {}
}
},
"Permissions": {
"target": "com.amazonaws.lakeformation#PermissionList",
"traits": {
"smithy.api#documentation": "<p>Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).</p>"
}
},
"DurationSeconds": {
"target": "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger",
"traits": {
"smithy.api#documentation": "<p>The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.</p>"
}
},
"AuditContext": {
"target": "com.amazonaws.lakeformation#AuditContext",
"traits": {
"smithy.api#documentation": "<p>A structure representing context to access a resource (column names, query ID, etc).</p>"
}
},
"SupportedPermissionTypes": {
"target": "com.amazonaws.lakeformation#PermissionTypeList",
"traits": {
"smithy.api#documentation": "<p>A list of supported permission types for the partition. Valid values are <code>COLUMN_PERMISSION</code> and <code>CELL_FILTER_PERMISSION</code>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentialsResponse": {
"type": "structure",
"members": {
"AccessKeyId": {
"target": "com.amazonaws.lakeformation#AccessKeyIdString",
"traits": {
"smithy.api#documentation": "<p>The access key ID for the temporary credentials.</p>"
}
},
"SecretAccessKey": {
"target": "com.amazonaws.lakeformation#SecretAccessKeyString",
"traits": {
"smithy.api#documentation": "<p>The secret key for the temporary credentials.</p>"
}
},
"SessionToken": {
"target": "com.amazonaws.lakeformation#SessionTokenString",
"traits": {
"smithy.api#documentation": "<p>The session token for the temporary credentials.</p>"
}
},
"Expiration": {
"target": "com.amazonaws.lakeformation#ExpirationTimestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time when the temporary credentials expire.</p>"
}
}
}
},
"com.amazonaws.lakeformation#GetTemporaryGlueTableCredentials": {
"type": "operation",
"input": {
"target": "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentialsRequest"
},
"output": {
"target": "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentialsResponse"
},
"errors": [
{
"target": "com.amazonaws.lakeformation#AccessDeniedException"
},
{
"target": "com.amazonaws.lakeformation#EntityNotFoundException"
},
{
"target": "com.amazonaws.lakeformation#InternalServiceException"
},
{
"target": "com.amazonaws.lakeformation#InvalidInputException"
},
{
"target": "com.amazonaws.lakeformation#OperationTimeoutException"
},
{
"target": "com.amazonaws.lakeformation#PermissionTypeMismatchException"
}
],
"traits": {
"smithy.api#documentation": "<p>Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/GetTemporaryGlueTableCredentials",
"code": 200
}
}
},
"com.amazonaws.lakeformation#GetTemporaryGlueTableCredentialsRequest": {
"type": "structure",
"members": {
"TableArn": {
"target": "com.amazonaws.lakeformation#ResourceArnString",
"traits": {
"smithy.api#documentation": "<p>The ARN identifying a table in the Data Catalog for the temporary credentials request.</p>",
"smithy.api#required": {}
}
},
"Permissions": {
"target": "com.amazonaws.lakeformation#PermissionList",
"traits": {
"smithy.api#documentation": "<p>Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).</p>"
}
},
"DurationSeconds": {
"target": "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger",
"traits": {
"smithy.api#documentation": "<p>The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.</p>"
}
},
"AuditContext": {
"target": "com.amazonaws.lakeformation#AuditContext",
"traits": {
"smithy.api#documentation": "<p>A structure representing context to access a resource (column names, query ID, etc).</p>"
}
},
"SupportedPermissionTypes": {
"target": "com.amazonaws.lakeformation#PermissionTypeList",
"traits": {
"smithy.api#documentation": "<p>A list of supported permission types for the table. Valid values are <code>COLUMN_PERMISSION</code> and <code>CELL_FILTER_PERMISSION</code>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.lakeformation#GetTemporaryGlueTableCredentialsResponse": {
"type": "structure",
"members": {
"AccessKeyId": {
"target": "com.amazonaws.lakeformation#AccessKeyIdString",
"traits": {
"smithy.api#documentation": "<p>The access key ID for the temporary credentials.</p>"
}
},
"SecretAccessKey": {
"target": "com.amazonaws.lakeformation#SecretAccessKeyString",
"traits": {
"smithy.api#documentation": "<p>The secret key for the temporary credentials.</p>"
}
},
"SessionToken": {
"target": "com.amazonaws.lakeformation#SessionTokenString",
"traits": {
"smithy.api#documentation": "<p>The session token for the temporary credentials.</p>"
}
},
"Expiration": {
"target": "com.amazonaws.lakeformation#ExpirationTimestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time when the temporary credentials expire.</p>"
}
}
}
},
"com.amazonaws.lakeformation#GetWorkUnitResults": {
"type": "operation",
"input": {
@ -3421,6 +3704,21 @@
"smithy.api#documentation": "<p>A structure containing a list of partition values and table objects.</p>"
}
},
"com.amazonaws.lakeformation#PartitionValueList": {
"type": "structure",
"members": {
"Values": {
"target": "com.amazonaws.lakeformation#ValueStringList",
"traits": {
"smithy.api#documentation": "<p>The list of partition values.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains a list of values defining partitions.</p>"
}
},
"com.amazonaws.lakeformation#PartitionValueString": {
"type": "string",
"traits": {
@ -3521,6 +3819,48 @@
"target": "com.amazonaws.lakeformation#Permission"
}
},
"com.amazonaws.lakeformation#PermissionType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "COLUMN_PERMISSION",
"name": "COLUMN_PERMISSION"
},
{
"value": "CELL_FILTER_PERMISSION",
"name": "CELL_FILTER_PERMISSION"
}
]
}
},
"com.amazonaws.lakeformation#PermissionTypeList": {
"type": "list",
"member": {
"target": "com.amazonaws.lakeformation#PermissionType"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 255
}
}
},
"com.amazonaws.lakeformation#PermissionTypeMismatchException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.lakeformation#MessageString",
"traits": {
"smithy.api#documentation": "<p>A message describing the problem.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The engine does not support filtering data based on the enforced permissions. For example, if you call the <code>GetTemporaryGlueTableCredentials</code> operation with <code>SupportedPermissionType</code> equal to <code>ColumnPermission</code>, but cell-level permissions exist on the table, this exception is thrown.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.lakeformation#PlanningStatistics": {
"type": "structure",
"members": {
@ -4351,6 +4691,12 @@
}
}
},
"com.amazonaws.lakeformation#SecretAccessKeyString": {
"type": "string"
},
"com.amazonaws.lakeformation#SessionTokenString": {
"type": "string"
},
"com.amazonaws.lakeformation#StartQueryPlanning": {
"type": "operation",
"input": {
@ -5268,6 +5614,20 @@
}
}
},
"com.amazonaws.lakeformation#ValueString": {
"type": "string"
},
"com.amazonaws.lakeformation#ValueStringList": {
"type": "list",
"member": {
"target": "com.amazonaws.lakeformation#ValueString"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.lakeformation#VirtualObject": {
"type": "structure",
"members": {

321
aws/sdk/aws-models/location.json
View File

@ -328,8 +328,7 @@
}
],
"traits": {
"smithy.api#auth": [],
"smithy.api#documentation": "<p>Evaluates device positions against the geofence geometries from a given geofence\n collection.</p>\n <p>This operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:</p>\n <ul>\n <li>\n <p>\n <code>ENTER</code> if Amazon Location determines that the tracked device has entered\n a geofenced area.</p>\n </li>\n <li>\n <p>\n <code>EXIT</code> if Amazon Location determines that the tracked device has exited a\n geofenced area.</p>\n </li>\n </ul>\n <note>\n <p>The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.</p>\n </note>",
"smithy.api#documentation": "<p>Evaluates device positions against the geofence geometries from a given geofence\n collection.</p>\n <p>This operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:</p>\n <ul>\n <li>\n <p>\n <code>ENTER</code> if Amazon Location determines that the tracked device has entered\n a geofenced area.</p>\n </li>\n <li>\n <p>\n <code>EXIT</code> if Amazon Location determines that the tracked device has exited a\n geofenced area.</p>\n </li>\n </ul>\n <note>\n <p>The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.</p>\n </note>\n <note>\n <p>Geofence evaluation uses the given device position. It does not account for the \n optional <code>Accuracy</code> of a <code>DevicePositionUpdate</code>.</p>\n </note>",
"smithy.api#endpoint": {
"hostPrefix": "geofencing."
},
@ -771,7 +770,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Uploads position update data for one or more devices to a tracker resource. Amazon Location\n uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 \n days.</p>\n <note>\n <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker. \n When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections, \n and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than \n every 30 seconds, only one update per 30 seconds is stored for each unique device ID.\n When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence \n collections only if the device has moved more than 30 m (98.4 ft).</p>\n </note>",
"smithy.api#documentation": "<p>Uploads position update data for one or more devices to a tracker resource. Amazon Location\n uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 \n days.</p>\n <note>\n <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker. \n When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections, \n and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than \n every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>\n <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence \n collections only if the device has moved more than 30 m (98.4 ft).</p>\n <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering,\n location data is stored and evaluated against linked geofence collections only if the\n device has moved more than the measured accuracy. For example, if two consecutive\n updates from a device have a horizontal accuracy of 5 m and 10 m, the second update\n is neither stored or evaluated if the device has moved less than 15 m. If\n <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location\n uses the default value <code>{ \"Horizontal\": 0}</code> when accuracy is not provided on\n a <code>DevicePositionUpdate</code>.</p>\n </note>",
"smithy.api#endpoint": {
"hostPrefix": "tracking."
},
@ -1194,8 +1193,7 @@
"PricingPlan": {
"target": "com.amazonaws.location#PricingPlan",
"traits": {
"smithy.api#documentation": "<p>Specifies the pricing plan for the geofence collection.</p>\n <p>For additional details and restrictions on each pricing plan option, see the <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing\n page</a>.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>Optionally specifies the pricing plan for the geofence collection. Defaults to\n <code>RequestBasedUsage</code>.</p>\n <p>For additional details and restrictions on each pricing plan option, see the <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing\n page</a>.</p>"
}
},
"PricingPlanDataSource": {
@ -1308,8 +1306,7 @@
"PricingPlan": {
"target": "com.amazonaws.location#PricingPlan",
"traits": {
"smithy.api#documentation": "<p>Specifies the pricing plan for your map resource.</p>\n <p>For additional details and restrictions on each pricing plan option, see <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing</a>.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>Optionally specifies the pricing plan for the map resource. Defaults to\n <code>RequestBasedUsage</code>.</p>\n <p>For additional details and restrictions on each pricing plan option, see <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing</a>.</p>"
}
},
"Description": {
@ -1378,7 +1375,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a place index resource in your AWS account. Use a place index resource to\n geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,\n and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation.</p>",
"smithy.api#documentation": "<p>Creates a place index resource in your AWS account. Use a place index resource to\n geocode addresses and other text queries by using the <code>SearchPlaceIndexForText</code> operation,\n and reverse geocode coordinates by using the <code>SearchPlaceIndexForPosition</code> operation, and\n enable autosuggestions by using the <code>SearchPlaceIndexForSuggestions</code> operation.</p>",
"smithy.api#endpoint": {
"hostPrefix": "places."
},
@ -1410,8 +1407,7 @@
"PricingPlan": {
"target": "com.amazonaws.location#PricingPlan",
"traits": {
"smithy.api#documentation": "<p>Specifies the pricing plan for your place index resource.</p>\n <p>For additional details and restrictions on each pricing plan option, see <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing</a>.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>Optionally specifies the pricing plan for the place index resource. Defaults to\n <code>RequestBasedUsage</code>.</p>\n <p>For additional details and restrictions on each pricing plan option, see <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing</a>.</p>"
}
},
"Description": {
@ -1518,8 +1514,7 @@
"PricingPlan": {
"target": "com.amazonaws.location#PricingPlan",
"traits": {
"smithy.api#documentation": "<p>Specifies the pricing plan for your route calculator resource.</p>\n <p>For additional details and restrictions on each pricing plan option, see <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing</a>.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>Optionally specifies the pricing plan for the route calculator resource. Defaults to\n <code>RequestBasedUsage</code>.</p>\n <p>For additional details and restrictions on each pricing plan option, see <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing</a>.</p>"
}
},
"Description": {
@ -1613,8 +1608,7 @@
"PricingPlan": {
"target": "com.amazonaws.location#PricingPlan",
"traits": {
"smithy.api#documentation": "<p>Specifies the pricing plan for the tracker resource.</p>\n <p>For additional details and restrictions on each pricing plan option, see <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing</a>.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>Optionally specifies the pricing plan for the tracker resource. Defaults to\n <code>RequestBasedUsage</code>.</p>\n <p>For additional details and restrictions on each pricing plan option, see <a href=\"https://aws.amazon.com/location/pricing/\">Amazon Location Service pricing</a>.</p>"
}
},
"KmsKeyId": {
@ -1644,7 +1638,7 @@
"PositionFiltering": {
"target": "com.amazonaws.location#PositionFiltering",
"traits": {
"smithy.api#documentation": "<p>Specifies the position filtering for the tracker resource.</p>\n <p>Valid values:</p>\n <ul>\n <li>\n <p>\n <code>TimeBased</code> - Location updates are evaluated against linked geofence collections, \n but not every location update is stored. If your update frequency is more often than 30 seconds, \n only one update per 30 seconds is stored for each unique device ID.\n </p>\n </li>\n <li>\n <p>\n <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are \n ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored.\n This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.\n Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.\n </p>\n </li>\n </ul>\n <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>"
"smithy.api#documentation": "<p>Specifies the position filtering for the tracker resource.</p>\n <p>Valid values:</p>\n <ul>\n <li>\n <p>\n <code>TimeBased</code> - Location updates are evaluated against linked geofence collections, \n but not every location update is stored. If your update frequency is more often than 30 seconds, \n only one update per 30 seconds is stored for each unique device ID.\n </p>\n </li>\n <li>\n <p>\n <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are \n ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored.\n This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.\n Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.\n </p>\n </li>\n <li>\n <p>\n <code>AccuracyBased</code> - If the device has moved less than the measured accuracy,\n location updates are ignored. For example, if two consecutive updates from a device\n have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device\n has moved less than 15 m. Ignored location updates are neither evaluated against\n linked geofence collections, nor stored. This can reduce the effects of GPS noise\n when displaying device trajectories on a map, and can help control your costs by reducing the\n number of geofence evaluations.\n </p>\n </li>\n </ul>\n <p>This field is optional. If not specified, the default value is <code>TimeBased</code>.</p>"
}
}
}
@ -1990,7 +1984,6 @@
}
],
"traits": {
"smithy.api#auth": [],
"smithy.api#documentation": "<p>Retrieves the geofence collection details.</p>",
"smithy.api#endpoint": {
"hostPrefix": "geofencing."
@ -2107,7 +2100,6 @@
}
],
"traits": {
"smithy.api#auth": [],
"smithy.api#documentation": "<p>Retrieves the map resource details.</p>",
"smithy.api#endpoint": {
"hostPrefix": "maps."
@ -2226,7 +2218,6 @@
}
],
"traits": {
"smithy.api#auth": [],
"smithy.api#documentation": "<p>Retrieves the place index resource details.</p>",
"smithy.api#endpoint": {
"hostPrefix": "places."
@ -2345,7 +2336,6 @@
}
],
"traits": {
"smithy.api#auth": [],
"smithy.api#documentation": "<p>Retrieves the route calculator resource details.</p>",
"smithy.api#endpoint": {
"hostPrefix": "routes."
@ -2457,7 +2447,6 @@
}
],
"traits": {
"smithy.api#auth": [],
"smithy.api#documentation": "<p>Retrieves the tracker resource details.</p>",
"smithy.api#endpoint": {
"hostPrefix": "tracking."
@ -2589,6 +2578,18 @@
"smithy.api#documentation": "<p>The last known device position.</p>",
"smithy.api#required": {}
}
},
"Accuracy": {
"target": "com.amazonaws.location#PositionalAccuracy",
"traits": {
"smithy.api#documentation": "<p>The accuracy of the device position.</p>"
}
},
"PositionProperties": {
"target": "com.amazonaws.location#PropertyMap",
"traits": {
"smithy.api#documentation": "<p>The properties associated with the position.</p>"
}
}
},
"traits": {
@ -2624,6 +2625,18 @@
"smithy.api#documentation": "<p>The latest device position defined in <a href=\"https://earth-info.nga.mil/GandG/wgs84/index.html\">WGS 84</a> format:\n <code>[X or longitude, Y or latitude]</code>.</p>",
"smithy.api#required": {}
}
},
"Accuracy": {
"target": "com.amazonaws.location#PositionalAccuracy",
"traits": {
"smithy.api#documentation": "<p>The accuracy of the device position.</p>"
}
},
"PositionProperties": {
"target": "com.amazonaws.location#PropertyMap",
"traits": {
"smithy.api#documentation": "<p>Associates one of more properties with the position update. A property is a key-value\n pair stored with the position update and added to any geofence event the update may\n trigger.</p>\n <p>Format: <code>\"key\" : \"value\"</code>\n </p>"
}
}
},
"traits": {
@ -3000,6 +3013,18 @@
"smithy.api#documentation": "<p>The last known device position.</p>",
"smithy.api#required": {}
}
},
"Accuracy": {
"target": "com.amazonaws.location#PositionalAccuracy",
"traits": {
"smithy.api#documentation": "<p>The accuracy of the device position.</p>"
}
},
"PositionProperties": {
"target": "com.amazonaws.location#PropertyMap",
"traits": {
"smithy.api#documentation": "<p>The properties associated with the position.</p>"
}
}
}
},
@ -3735,6 +3760,18 @@
"smithy.api#documentation": "<p>The last known device position. Empty if no positions currently stored.</p>",
"smithy.api#required": {}
}
},
"Accuracy": {
"target": "com.amazonaws.location#PositionalAccuracy",
"traits": {
"smithy.api#documentation": "<p>The accuracy of the device position.</p>"
}
},
"PositionProperties": {
"target": "com.amazonaws.location#PropertyMap",
"traits": {
"smithy.api#documentation": "<p>The properties associated with the position.</p>"
}
}
},
"traits": {
@ -4937,6 +4974,9 @@
{
"target": "com.amazonaws.location#SearchPlaceIndexForPosition"
},
{
"target": "com.amazonaws.location#SearchPlaceIndexForSuggestions"
},
{
"target": "com.amazonaws.location#SearchPlaceIndexForText"
}
@ -4995,6 +5035,25 @@
]
}
},
"com.amazonaws.location#PositionalAccuracy": {
"type": "structure",
"members": {
"Horizontal": {
"target": "smithy.api#Double",
"traits": {
"smithy.api#documentation": "<p>Estimated maximum distance, in meters, between the measured position and the true\n position of a device, along the Earth's surface.</p>",
"smithy.api#range": {
"min": 0,
"max": 10000
},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Defines the level of certainty of the position.</p>"
}
},
"com.amazonaws.location#PricingPlan": {
"type": "string",
"traits": {
@ -5014,6 +5073,34 @@
]
}
},
"com.amazonaws.location#PropertyMap": {
"type": "map",
"key": {
"target": "smithy.api#String",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 20
}
}
},
"value": {
"target": "smithy.api#String",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 40
}
}
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 3
},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.location#PutGeofence": {
"type": "operation",
"input": {
@ -5212,6 +5299,27 @@
"target": "com.amazonaws.location#SearchForPositionResult"
}
},
"com.amazonaws.location#SearchForSuggestionsResult": {
"type": "structure",
"members": {
"Text": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The text of the place suggestion, typically formatted as an address string.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.</p>"
}
},
"com.amazonaws.location#SearchForSuggestionsResultList": {
"type": "list",
"member": {
"target": "com.amazonaws.location#SearchForSuggestionsResult"
}
},
"com.amazonaws.location#SearchForTextResult": {
"type": "structure",
"members": {
@ -5375,6 +5483,175 @@
"smithy.api#documentation": "<p>A summary of the request sent by using <code>SearchPlaceIndexForPosition</code>.</p>"
}
},
"com.amazonaws.location#SearchPlaceIndexForSuggestions": {
"type": "operation",
"input": {
"target": "com.amazonaws.location#SearchPlaceIndexForSuggestionsRequest"
},
"output": {
"target": "com.amazonaws.location#SearchPlaceIndexForSuggestionsResponse"
},
"errors": [
{
"target": "com.amazonaws.location#AccessDeniedException"
},
{
"target": "com.amazonaws.location#InternalServerException"
},
{
"target": "com.amazonaws.location#ResourceNotFoundException"
},
{
"target": "com.amazonaws.location#ThrottlingException"
},
{
"target": "com.amazonaws.location#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Generates suggestions for addresses and points of interest based on partial or\n misspelled free-form text. This operation is also known as autocomplete, autosuggest,\n or fuzzy matching.</p>\n <p>Optional parameters let you narrow your search results by bounding box or\n country, or bias your search toward a specific position on the globe.</p>\n <note>\n <p>You can search for suggested place names near a specified position by using <code>BiasPosition</code>, or\n filter results within a bounding box by using <code>FilterBBox</code>. These parameters are mutually exclusive; \n using both <code>BiasPosition</code> and <code>FilterBBox</code> in the same command returns an error.</p>\n </note>",
"smithy.api#endpoint": {
"hostPrefix": "places."
},
"smithy.api#http": {
"method": "POST",
"uri": "/places/v0/indexes/{IndexName}/search/suggestions",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.location#SearchPlaceIndexForSuggestionsRequest": {
"type": "structure",
"members": {
"IndexName": {
"target": "com.amazonaws.location#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the place index resource you want to use for the search.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"Text": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The free-form partial text to use to generate place suggestions. For example,\n <code>eiffel tow</code>.</p>",
"smithy.api#length": {
"min": 1,
"max": 200
},
"smithy.api#required": {},
"smithy.api#sensitive": {}
}
},
"BiasPosition": {
"target": "com.amazonaws.location#Position",
"traits": {
"smithy.api#documentation": "<p>An optional parameter that indicates a preference for place suggestions that are closer to a specified position.</p>\n <p>\n If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; \n the second number represents the Y coordinate, or latitude.</p>\n <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with\n longitude <code>-123.1174</code> and\n latitude <code>49.2847</code>.</p>\n <note>\n <p>\n <code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options results in an error.\n </p>\n </note>"
}
},
"FilterBBox": {
"target": "com.amazonaws.location#BoundingBox",
"traits": {
"smithy.api#documentation": "<p>An optional parameter that limits the search results by returning only suggestions within a specified bounding box.</p>\n <p>\n If provided, this parameter must contain a total of four consecutive numbers in two pairs.\n The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the northeast corner of the bounding box.</p>\n <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents\n a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>, \n and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p>\n <note>\n <p>\n <code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.\n </p>\n </note>"
}
},
"FilterCountries": {
"target": "com.amazonaws.location#CountryCodeList",
"traits": {
"smithy.api#documentation": "<p>An optional parameter that limits the search results by returning only suggestions within the provided list of countries.</p>\n <ul>\n <li>\n <p>Use the <a href=\"https://www.iso.org/iso-3166-country-codes.html\">ISO 3166</a> 3-digit\n country code. For example, Australia uses three upper-case characters:\n <code>AUS</code>.</p>\n </li>\n </ul>"
}
},
"MaxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>An optional parameter. The maximum number of results returned per request. </p>\n <p>The default: <code>5</code>\n </p>",
"smithy.api#range": {
"min": 1,
"max": 15
}
}
},
"Language": {
"target": "com.amazonaws.location#LanguageTag",
"traits": {
"smithy.api#documentation": "<p>The preferred language used to return results. The value must be a valid <a href=\"https://tools.ietf.org/search/bcp47\">BCP 47</a> language tag, for example,\n <code>en</code> for English.</p> \n <p>This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.</p>\n <p>Used only when the partner selected is Here.</p>"
}
}
}
},
"com.amazonaws.location#SearchPlaceIndexForSuggestionsResponse": {
"type": "structure",
"members": {
"Summary": {
"target": "com.amazonaws.location#SearchPlaceIndexForSuggestionsSummary",
"traits": {
"smithy.api#documentation": "<p>Contains a summary of the request. Echoes the input values for <code>BiasPosition</code>,\n <code>FilterBBox</code>, <code>FilterCountries</code>, <code>Language</code>, <code>MaxResults</code>,\n and <code>Text</code>. Also includes the <code>DataSource</code> of the place index.\n </p>",
"smithy.api#required": {}
}
},
"Results": {
"target": "com.amazonaws.location#SearchForSuggestionsResultList",
"traits": {
"smithy.api#documentation": "<p>A list of place suggestions that best match the search text.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.location#SearchPlaceIndexForSuggestionsSummary": {
"type": "structure",
"members": {
"Text": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The free-form partial text input specified in the request.</p>",
"smithy.api#required": {},
"smithy.api#sensitive": {}
}
},
"BiasPosition": {
"target": "com.amazonaws.location#Position",
"traits": {
"smithy.api#documentation": "<p>Contains the coordinates for the optional bias position specified in the request.</p>\n <p>This parameter contains a pair of numbers. The first number represents the X \n coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>\n <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with\n longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p>"
}
},
"FilterBBox": {
"target": "com.amazonaws.location#BoundingBox",
"traits": {
"smithy.api#documentation": "<p>Contains the coordinates for the optional bounding box specified in the request.</p>"
}
},
"FilterCountries": {
"target": "com.amazonaws.location#CountryCodeList",
"traits": {
"smithy.api#documentation": "<p>Contains the optional country filter specified in the request.</p>"
}
},
"MaxResults": {
"target": "smithy.api#Integer",
"traits": {
"smithy.api#documentation": "<p>Contains the optional result count limit specified in the request.</p>"
}
},
"DataSource": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:</p>\n <ul>\n <li>\n <p>Esri</p>\n </li>\n <li>\n <p>Here</p>\n </li>\n </ul>\n <p>For more information about data providers, see <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html\">Amazon Location Service data providers</a>.</p>",
"smithy.api#required": {}
}
},
"Language": {
"target": "com.amazonaws.location#LanguageTag",
"traits": {
"smithy.api#documentation": "<p>The preferred language used to return results. Matches the language in the request. \n The value is a valid <a href=\"https://tools.ietf.org/search/bcp47\">BCP 47</a> language tag, for example,\n <code>en</code> for English.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A summary of the request sent by using <code>SearchPlaceIndexForSuggestions</code>.</p>"
}
},
"com.amazonaws.location#SearchPlaceIndexForText": {
"type": "operation",
"input": {
@ -5501,7 +5778,7 @@
"BiasPosition": {
"target": "com.amazonaws.location#Position",
"traits": {
"smithy.api#documentation": "<p>Contains the coordinates for the optional bias position specified in the request.</p>"
"smithy.api#documentation": "<p>Contains the coordinates for the optional bias position specified in the request.</p>\n <p>This parameter contains a pair of numbers. The first number represents the X \n coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>\n <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with\n longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p>"
}
},
"FilterBBox": {
@ -6427,7 +6704,7 @@
"PositionFiltering": {
"target": "com.amazonaws.location#PositionFiltering",
"traits": {
"smithy.api#documentation": "<p>Updates the position filtering for the tracker resource.</p>\n <p>Valid values:</p>\n <ul>\n <li>\n <p>\n <code>TimeBased</code> - Location updates are evaluated against linked geofence collections, \n but not every location update is stored. If your update frequency is more often than 30 seconds, \n only one update per 30 seconds is stored for each unique device ID.\n </p>\n </li>\n <li>\n <p>\n <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are \n ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. \n This helps control costs by reducing the number of geofence evaluations and device positions to retrieve. \n Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.\n </p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>Updates the position filtering for the tracker resource.</p>\n <p>Valid values:</p>\n <ul>\n <li>\n <p>\n <code>TimeBased</code> - Location updates are evaluated against linked geofence collections, \n but not every location update is stored. If your update frequency is more often than 30 seconds, \n only one update per 30 seconds is stored for each unique device ID.\n </p>\n </li>\n <li>\n <p>\n <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are \n ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored.\n This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through.\n Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.\n </p>\n </li>\n <li>\n <p>\n <code>AccuracyBased</code> - If the device has moved less than the measured accuracy,\n location updates are ignored. For example, if two consecutive updates from a device\n have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device\n has moved less than 15 m. Ignored location updates are neither evaluated against\n linked geofence collections, nor stored. This helps educe the effects of GPS noise \n when displaying device trajectories on a map, and can help control costs by reducing the\n number of geofence evaluations.\n </p>\n </li>\n </ul>"
}
}
}

17
aws/sdk/aws-models/logs.json
View File

@ -1799,6 +1799,12 @@
"target": "com.amazonaws.cloudwatchlogs#FilteredLogEvent"
}
},
"com.amazonaws.cloudwatchlogs#ForceUpdate": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.cloudwatchlogs#GetLogEvents": {
"type": "operation",
"input": {
@ -2890,6 +2896,12 @@
"smithy.api#documentation": "<p>An IAM policy document that authorizes cross-account users to deliver their log events\n to the associated destination. This can be up to 5120 bytes.</p>",
"smithy.api#required": {}
}
},
"forceUpdate": {
"target": "com.amazonaws.cloudwatchlogs#ForceUpdate",
"traits": {
"smithy.api#documentation": "<p>Specify true if you are updating an existing destination policy to grant permission to\n an organization ID instead of granting permission to individual AWS accounts. Before\n you update a destination policy this way, you must first update the subscription\n filters in the accounts that send logs to this destination. If you do not, the subscription\n filters might stop working. By specifying <code>true</code>\n for <code>forceUpdate</code>, you are affirming that you have already updated the subscription \n filters.\n For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Cross-Account-Log_Subscription-Update.html\">\n Updating an existing cross-account subscription</a>\n </p>\n <p>If you omit this parameter, the default of <code>false</code> is used.</p>"
}
}
}
},
@ -3082,6 +3094,9 @@
{
"target": "com.amazonaws.cloudwatchlogs#InvalidParameterException"
},
{
"target": "com.amazonaws.cloudwatchlogs#LimitExceededException"
},
{
"target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException"
},
@ -3170,7 +3185,7 @@
"policyDocument": {
"target": "com.amazonaws.cloudwatchlogs#PolicyDocument",
"traits": {
"smithy.api#documentation": "<p>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.</p>\n <p>The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace <code>\"logArn\"</code> with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.</p>\n <p>CloudWatch Logs also supports <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn\">aws:SourceArn</a>\n and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount\">aws:SourceAccount</a>\ncondition context keys.</p>\n <p>In the example resource policy, you would replace the value of <code>SourceArn</code> with the resource making the\n call from Route 53 to CloudWatch Logs and replace the value of <code>SourceAccount</code> with \n the Amazon Web Services account ID making that call.</p>\n <p></p>\n <p>\n <code>{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}</code>\n \n </p>"
"smithy.api#documentation": "<p>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.</p>\n <p>The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace <code>\"logArn\"</code> with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.</p>\n <p>CloudWatch Logs also supports <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn\">aws:SourceArn</a>\n and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount\">aws:SourceAccount</a>\ncondition context keys.</p>\n <p>In the example resource policy, you would replace the value of <code>SourceArn</code> with the resource making the\n call from Route 53 to CloudWatch Logs and replace the value of <code>SourceAccount</code> with \n the Amazon Web Services account ID making that call.</p>\n <p></p>\n <p>\n <code>{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}</code>\n \n </p>"
}
}
}

192
aws/sdk/aws-models/lookoutmetrics.json
View File

@ -2168,6 +2168,44 @@
"com.amazonaws.lookoutmetrics#Integer": {
"type": "integer"
},
"com.amazonaws.lookoutmetrics#InterMetricImpactDetails": {
"type": "structure",
"members": {
"MetricName": {
"target": "com.amazonaws.lookoutmetrics#MetricName",
"traits": {
"smithy.api#documentation": "<p>The name of the measure.</p>"
}
},
"AnomalyGroupId": {
"target": "com.amazonaws.lookoutmetrics#UUID",
"traits": {
"smithy.api#documentation": "<p>The ID of the anomaly group.</p>"
}
},
"RelationshipType": {
"target": "com.amazonaws.lookoutmetrics#RelationshipType",
"traits": {
"smithy.api#documentation": "<p>Whether a measure is a potential cause of the anomaly group\n (<code>CAUSE_OF_INPUT_ANOMALY_GROUP</code>), or whether the measure is impacted by the\n anomaly group (<code>EFFECT_OF_INPUT_ANOMALY_GROUP</code>).</p>"
}
},
"ContributionPercentage": {
"target": "com.amazonaws.lookoutmetrics#MetricChangePercentage",
"traits": {
"smithy.api#documentation": "<p>For potential causes (<code>CAUSE_OF_INPUT_ANOMALY_GROUP</code>), the percentage\n contribution the measure has in causing the anomalies.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Aggregated details about the measures contributing to the anomaly group, and the measures\n potentially impacted by the anomaly group.</p>\n <p></p>"
}
},
"com.amazonaws.lookoutmetrics#InterMetricImpactList": {
"type": "list",
"member": {
"target": "com.amazonaws.lookoutmetrics#InterMetricImpactDetails"
}
},
"com.amazonaws.lookoutmetrics#InternalServerException": {
"type": "structure",
"members": {
@ -2431,6 +2469,100 @@
}
}
},
"com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetrics": {
"type": "operation",
"input": {
"target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsRequest"
},
"output": {
"target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsResponse"
},
"errors": [
{
"target": "com.amazonaws.lookoutmetrics#AccessDeniedException"
},
{
"target": "com.amazonaws.lookoutmetrics#InternalServerException"
},
{
"target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException"
},
{
"target": "com.amazonaws.lookoutmetrics#TooManyRequestsException"
},
{
"target": "com.amazonaws.lookoutmetrics#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of measures that are potential causes or effects of an\n anomaly group.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/ListAnomalyGroupRelatedMetrics",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
"pageSize": "MaxResults"
}
}
},
"com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsRequest": {
"type": "structure",
"members": {
"AnomalyDetectorArn": {
"target": "com.amazonaws.lookoutmetrics#Arn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the anomaly detector.</p>",
"smithy.api#required": {}
}
},
"AnomalyGroupId": {
"target": "com.amazonaws.lookoutmetrics#UUID",
"traits": {
"smithy.api#documentation": "<p>The ID of the anomaly group.</p>",
"smithy.api#required": {}
}
},
"RelationshipTypeFilter": {
"target": "com.amazonaws.lookoutmetrics#RelationshipType",
"traits": {
"smithy.api#documentation": "<p>Filter for potential causes (<code>CAUSE_OF_INPUT_ANOMALY_GROUP</code>) or\n downstream effects (<code>EFFECT_OF_INPUT_ANOMALY_GROUP</code>) of the anomaly group.</p>"
}
},
"MaxResults": {
"target": "com.amazonaws.lookoutmetrics#MaxResults",
"traits": {
"smithy.api#box": {},
"smithy.api#documentation": "<p>The maximum number of results to return.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.lookoutmetrics#NextToken",
"traits": {
"smithy.api#documentation": "<p>Specify the pagination token that's returned by a previous request to retrieve the next\n page of results.</p>"
}
}
}
},
"com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsResponse": {
"type": "structure",
"members": {
"InterMetricImpactList": {
"target": "com.amazonaws.lookoutmetrics#InterMetricImpactList",
"traits": {
"smithy.api#documentation": "<p>Aggregated details about the measures contributing to the anomaly group, and the measures\n potentially impacted by the anomaly group.</p>"
}
},
"NextToken": {
"target": "com.amazonaws.lookoutmetrics#NextToken",
"traits": {
"smithy.api#documentation": "<p>The pagination token that's included if more results are available.</p>"
}
}
}
},
"com.amazonaws.lookoutmetrics#ListAnomalyGroupSummaries": {
"type": "operation",
"input": {
@ -2774,6 +2906,21 @@
},
"com.amazonaws.lookoutmetrics#LookoutMetrics": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "LookoutMetrics",
"arnNamespace": "lookoutmetrics",
"cloudFormationName": "LookoutMetrics",
"cloudTrailEventSource": "lookoutmetrics.amazonaws.com",
"endpointPrefix": "lookoutmetrics"
},
"aws.auth#sigv4": {
"name": "lookoutmetrics"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>This is the <i>Amazon Lookout for Metrics API Reference</i>. For an introduction to the service\n with tutorials for getting started, visit <a href=\"https://docs.aws.amazon.com/lookoutmetrics/latest/dev\">Amazon\n Lookout for Metrics Developer Guide</a>.</p>",
"smithy.api#title": "Amazon Lookout for Metrics"
},
"version": "2017-07-25",
"operations": [
{
@ -2824,6 +2971,9 @@
{
"target": "com.amazonaws.lookoutmetrics#ListAnomalyDetectors"
},
{
"target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetrics"
},
{
"target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummaries"
},
@ -2851,22 +3001,7 @@
{
"target": "com.amazonaws.lookoutmetrics#UpdateMetricSet"
}
],
"traits": {
"aws.api#service": {
"sdkId": "LookoutMetrics",
"arnNamespace": "lookoutmetrics",
"cloudFormationName": "LookoutMetrics",
"cloudTrailEventSource": "lookoutmetrics.amazonaws.com",
"endpointPrefix": "lookoutmetrics"
},
"aws.auth#sigv4": {
"name": "lookoutmetrics"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>This is the <i>Amazon Lookout for Metrics API Reference</i>. For an introduction to the service\n with tutorials for getting started, visit <a href=\"https://docs.aws.amazon.com/lookoutmetrics/latest/dev\">Amazon\n Lookout for Metrics Developer Guide</a>.</p>",
"smithy.api#title": "Amazon Lookout for Metrics"
}
]
},
"com.amazonaws.lookoutmetrics#MaxResults": {
"type": "integer",
@ -2908,6 +3043,16 @@
"smithy.api#documentation": "<p>A calculation made by contrasting a measure and a dimension from your source data.</p>"
}
},
"com.amazonaws.lookoutmetrics#MetricChangePercentage": {
"type": "double",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 0.0,
"max": 100.0
}
}
},
"com.amazonaws.lookoutmetrics#MetricLevelImpact": {
"type": "structure",
"members": {
@ -3363,6 +3508,21 @@
"smithy.api#documentation": "<p>Provides information about the Amazon Redshift database configuration.</p>"
}
},
"com.amazonaws.lookoutmetrics#RelationshipType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CAUSE_OF_INPUT_ANOMALY_GROUP",
"name": "CAUSE_OF_INPUT_ANOMALY_GROUP"
},
{
"value": "EFFECT_OF_INPUT_ANOMALY_GROUP",
"name": "EFFECT_OF_INPUT_ANOMALY_GROUP"
}
]
}
},
"com.amazonaws.lookoutmetrics#ResourceId": {
"type": "string"
},

795
aws/sdk/aws-models/lookoutvision.json
View File

File diff suppressed because it is too large Load Diff

129
aws/sdk/aws-models/mediaconnect.json
View File

@ -468,7 +468,7 @@
"MaxLatency": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The maximum latency in milliseconds for Zixi-based streams.",
"smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.",
"smithy.api#jsonName": "maxLatency"
}
},
@ -515,6 +515,13 @@
"smithy.api#jsonName": "remoteId"
}
},
"SenderControlPort": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.",
"smithy.api#jsonName": "senderControlPort"
}
},
"SmoothingLatency": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
@ -1500,7 +1507,7 @@
}
},
"traits": {
"smithy.api#documentation": "The settings for source failover"
"smithy.api#documentation": "The settings for source failover."
}
},
"com.amazonaws.mediaconnect#FailoverMode": {
@ -2482,6 +2489,21 @@
},
"com.amazonaws.mediaconnect#MediaConnect": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "MediaConnect",
"arnNamespace": "mediaconnect",
"cloudFormationName": "MediaConnect",
"cloudTrailEventSource": "mediaconnect.amazonaws.com",
"endpointPrefix": "mediaconnect"
},
"aws.auth#sigv4": {
"name": "mediaconnect"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "API for AWS Elemental MediaConnect",
"smithy.api#title": "AWS MediaConnect"
},
"version": "2018-11-14",
"operations": [
{
@ -2574,22 +2596,7 @@
{
"target": "com.amazonaws.mediaconnect#UpdateFlowSource"
}
],
"traits": {
"aws.api#service": {
"sdkId": "MediaConnect",
"arnNamespace": "mediaconnect",
"cloudFormationName": "MediaConnect",
"cloudTrailEventSource": "mediaconnect.amazonaws.com",
"endpointPrefix": "mediaconnect"
},
"aws.auth#sigv4": {
"name": "mediaconnect"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "API for AWS Elemental MediaConnect",
"smithy.api#title": "AWS MediaConnect"
}
]
},
"com.amazonaws.mediaconnect#MediaStream": {
"type": "structure",
@ -3129,6 +3136,10 @@
{
"value": "srt-listener",
"name": "srt_listener"
},
{
"value": "fujitsu-qos",
"name": "fujitsu_qos"
}
]
}
@ -3872,7 +3883,7 @@
"MaxLatency": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.",
"smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.",
"smithy.api#jsonName": "maxLatency"
}
},
@ -3911,6 +3922,20 @@
"smithy.api#jsonName": "protocol"
}
},
"SenderControlPort": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.",
"smithy.api#jsonName": "senderControlPort"
}
},
"SenderIpAddress": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
"smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.",
"smithy.api#jsonName": "senderIpAddress"
}
},
"StreamId": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
@ -3997,6 +4022,20 @@
"smithy.api#required": {}
}
},
"SenderControlPort": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.",
"smithy.api#jsonName": "senderControlPort"
}
},
"SenderIpAddress": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
"smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.",
"smithy.api#jsonName": "senderIpAddress"
}
},
"SourceArn": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
@ -4381,7 +4420,7 @@
"MaxLatency": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.",
"smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.",
"smithy.api#jsonName": "maxLatency"
}
},
@ -4414,6 +4453,20 @@
"smithy.api#jsonName": "remoteId"
}
},
"SenderControlPort": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.",
"smithy.api#jsonName": "senderControlPort"
}
},
"SenderIpAddress": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
"smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.",
"smithy.api#jsonName": "senderIpAddress"
}
},
"SmoothingLatency": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
@ -4582,7 +4635,7 @@
}
},
"traits": {
"smithy.api#documentation": "The settings for source failover"
"smithy.api#documentation": "The settings for source failover."
}
},
"com.amazonaws.mediaconnect#UpdateFlow": {
@ -4925,7 +4978,7 @@
"MaxLatency": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The maximum latency in milliseconds for Zixi-based streams.",
"smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.",
"smithy.api#jsonName": "maxLatency"
}
},
@ -4972,6 +5025,20 @@
"smithy.api#jsonName": "remoteId"
}
},
"SenderControlPort": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.",
"smithy.api#jsonName": "senderControlPort"
}
},
"SenderIpAddress": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
"smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.",
"smithy.api#jsonName": "senderIpAddress"
}
},
"SmoothingLatency": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
@ -5136,7 +5203,7 @@
"MaxLatency": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.",
"smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.",
"smithy.api#jsonName": "maxLatency"
}
},
@ -5168,6 +5235,20 @@
"smithy.api#jsonName": "protocol"
}
},
"SenderControlPort": {
"target": "com.amazonaws.mediaconnect#__integer",
"traits": {
"smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.",
"smithy.api#jsonName": "senderControlPort"
}
},
"SenderIpAddress": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
"smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.",
"smithy.api#jsonName": "senderIpAddress"
}
},
"SourceArn": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
@ -5227,7 +5308,7 @@
"Name": {
"target": "com.amazonaws.mediaconnect#__string",
"traits": {
"smithy.api#documentation": "Immutable and has to be a unique against other VpcInterfaces in this Flow",
"smithy.api#documentation": "Immutable and has to be a unique against other VpcInterfaces in this Flow.",
"smithy.api#jsonName": "name",
"smithy.api#required": {}
}

37
aws/sdk/aws-models/mediaconvert.json
View File

@ -1223,7 +1223,7 @@
}
},
"ExternalAudioFileInput": {
"target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSS",
"target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSOOGGGGaA",
"traits": {
"smithy.api#documentation": "Specifies audio data from an external file source.",
"smithy.api#jsonName": "externalAudioFileInput"
@ -15023,7 +15023,7 @@
"com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening": {
"type": "string",
"traits": {
"smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can use this setting to apply sharpening. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply filtering, depending on input type and quality. When you set Noise reducer to Temporal, your output bandwidth is reduced. When Post temporal sharpening is also enabled, that bandwidth reduction is smaller.",
"smithy.api#documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the sharpness of your output is reduced. You can optionally use Post temporal sharpening (PostTemporalSharpening) to apply sharpening to the edges of your output. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (PostTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.",
"smithy.api#enum": [
{
"value": "DISABLED",
@ -15040,6 +15040,26 @@
]
}
},
"com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpeningStrength": {
"type": "string",
"traits": {
"smithy.api#documentation": "Use Post temporal sharpening strength (PostTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), or leave blank, to apply a low amount of sharpening. Set Post temporal sharpening strength to Medium (MEDIUM) to apply medium amount of sharpening. Set Post temporal sharpening strength to High (HIGH) to apply a high amount of sharpening.",
"smithy.api#enum": [
{
"value": "LOW",
"name": "LOW"
},
{
"value": "MEDIUM",
"name": "MEDIUM"
},
{
"value": "HIGH",
"name": "HIGH"
}
]
}
},
"com.amazonaws.mediaconvert#NoiseReducer": {
"type": "structure",
"members": {
@ -15173,10 +15193,17 @@
"PostTemporalSharpening": {
"target": "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening",
"traits": {
"smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can use this setting to apply sharpening. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply filtering, depending on input type and quality. When you set Noise reducer to Temporal, your output bandwidth is reduced. When Post temporal sharpening is also enabled, that bandwidth reduction is smaller.",
"smithy.api#documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the sharpness of your output is reduced. You can optionally use Post temporal sharpening (PostTemporalSharpening) to apply sharpening to the edges of your output. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (PostTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.",
"smithy.api#jsonName": "postTemporalSharpening"
}
},
"PostTemporalSharpeningStrength": {
"target": "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpeningStrength",
"traits": {
"smithy.api#documentation": "Use Post temporal sharpening strength (PostTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), or leave blank, to apply a low amount of sharpening. Set Post temporal sharpening strength to Medium (MEDIUM) to apply medium amount of sharpening. Set Post temporal sharpening strength to High (HIGH) to apply a high amount of sharpening.",
"smithy.api#jsonName": "postTemporalSharpeningStrength"
}
},
"Speed": {
"target": "com.amazonaws.mediaconvert#__integerMinNegative1Max3",
"traits": {
@ -20849,10 +20876,10 @@
"smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA]|[aA][tT][mM][oO][sS]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA]|[aA][tT][mM][oO][sS])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
}
},
"com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSS": {
"com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSOOGGGGaA": {
"type": "string",
"traits": {
"smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]|[aA][tT][mM][oO][sS]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]|[aA][tT][mM][oO][sS])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
"smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]|[aA][tT][mM][oO][sS]|[oO][gG][gGaA]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]|[aA][tT][mM][oO][sS]|[oO][gG][gGaA])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
}
},
"com.amazonaws.mediaconvert#__stringPatternSNManifestConfirmConditionNotificationNS": {

145
aws/sdk/aws-models/models.lex.v2.json
View File

@ -3073,8 +3073,7 @@
"valueSelectionSetting": {
"target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting",
"traits": {
"smithy.api#documentation": "<p>Determines the strategy that Amazon Lex uses to select a value from the\n list of possible values. The field can be set to one of the following\n values:</p>\n <ul>\n <li>\n <p>\n <code>OriginalValue</code> - Returns the value entered by the\n user, if the user value is similar to the slot value.</p>\n </li>\n <li>\n <p>\n <code>TopResolution</code> - If there is a resolution list for\n the slot, return the first value in the resolution list. If there\n is no resolution list, return null.</p>\n </li>\n </ul>\n <p>If you don't specify the <code>valueSelectionSetting</code>\n parameter, the default is <code>OriginalValue</code>.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>Determines the strategy that Amazon Lex uses to select a value from the\n list of possible values. The field can be set to one of the following\n values:</p>\n <ul>\n <li>\n <p>\n <code>OriginalValue</code> - Returns the value entered by the\n user, if the user value is similar to the slot value.</p>\n </li>\n <li>\n <p>\n <code>TopResolution</code> - If there is a resolution list for\n the slot, return the first value in the resolution list. If there\n is no resolution list, return null.</p>\n </li>\n </ul>\n <p>If you don't specify the <code>valueSelectionSetting</code>\n parameter, the default is <code>OriginalValue</code>.</p>"
}
},
"parentSlotTypeSignature": {
@ -3106,6 +3105,12 @@
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"externalSourceSetting": {
"target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting",
"traits": {
"smithy.api#documentation": "<p>Sets the type of external information used to create the slot\n type.</p>"
}
}
}
},
@ -3171,6 +3176,12 @@
"traits": {
"smithy.api#documentation": "<p>A timestamp of the date and time that the slot type was\n created.</p>"
}
},
"externalSourceSetting": {
"target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting",
"traits": {
"smithy.api#documentation": "<p>The type of external information used to create the slot\n type.</p>"
}
}
}
},
@ -4758,6 +4769,12 @@
"traits": {
"smithy.api#documentation": "<p>History of changes, such as when a locale is used in an alias, that\n have taken place for the locale.</p>"
}
},
"recommendedActions": {
"target": "com.amazonaws.lexmodelsv2#RecommendedActions",
"traits": {
"smithy.api#documentation": "<p>Recommended actions to take to resolve an error in the\n <code>failureReasons</code> field.</p>"
}
}
}
},
@ -5961,6 +5978,9 @@
"traits": {
"smithy.api#documentation": "<p>A timestamp of the date and time that the slot type was last\n updated.</p>"
}
},
"externalSourceSetting": {
"target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting"
}
}
},
@ -6235,6 +6255,20 @@
"target": "com.amazonaws.lexmodelsv2#ExportSummary"
}
},
"com.amazonaws.lexmodelsv2#ExternalSourceSetting": {
"type": "structure",
"members": {
"grammarSlotTypeSetting": {
"target": "com.amazonaws.lexmodelsv2#GrammarSlotTypeSetting",
"traits": {
"smithy.api#documentation": "<p>Settings required for a slot type based on a grammar that you\n provide.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides information about the external source of the slot type's\n definition.</p>"
}
},
"com.amazonaws.lexmodelsv2#FailureReason": {
"type": "string"
},
@ -6422,6 +6456,48 @@
"smithy.api#documentation": "<p>Provides information for updating the user on the progress of\n fulfilling an intent.</p>"
}
},
"com.amazonaws.lexmodelsv2#GrammarSlotTypeSetting": {
"type": "structure",
"members": {
"source": {
"target": "com.amazonaws.lexmodelsv2#GrammarSlotTypeSource",
"traits": {
"smithy.api#documentation": "<p>The source of the grammar used to create the slot type.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Settings requried for a slot type based on a grammar that you\n provide.</p>"
}
},
"com.amazonaws.lexmodelsv2#GrammarSlotTypeSource": {
"type": "structure",
"members": {
"s3BucketName": {
"target": "com.amazonaws.lexmodelsv2#S3BucketName",
"traits": {
"smithy.api#documentation": "<p>The name of the S3 bucket that contains the grammar source.</p>",
"smithy.api#required": {}
}
},
"s3ObjectKey": {
"target": "com.amazonaws.lexmodelsv2#S3ObjectPath",
"traits": {
"smithy.api#documentation": "<p>The path to the grammar in the S3 bucket.</p>",
"smithy.api#required": {}
}
},
"kmsKeyArn": {
"target": "com.amazonaws.lexmodelsv2#KmsKeyArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon KMS key required to decrypt the contents of the grammar,\n if any.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the Amazon S3 bucket name and location for the grammar\n that is the source for the slot type.</p>"
}
},
"com.amazonaws.lexmodelsv2#HitCount": {
"type": "integer",
"traits": {
@ -9331,6 +9407,15 @@
}
}
},
"com.amazonaws.lexmodelsv2#RecommendedAction": {
"type": "string"
},
"com.amazonaws.lexmodelsv2#RecommendedActions": {
"type": "list",
"member": {
"target": "com.amazonaws.lexmodelsv2#RecommendedAction"
}
},
"com.amazonaws.lexmodelsv2#RecommendedIntentSummary": {
"type": "structure",
"members": {
@ -9545,6 +9630,16 @@
"smithy.api#documentation": "<p>The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.</p>"
}
},
"com.amazonaws.lexmodelsv2#S3ObjectPath": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$"
}
},
"com.amazonaws.lexmodelsv2#SSMLMessage": {
"type": "structure",
"members": {
@ -10084,6 +10179,25 @@
"target": "com.amazonaws.lexmodelsv2#SlotSummary"
}
},
"com.amazonaws.lexmodelsv2#SlotTypeCategory": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "Custom",
"name": "Custom"
},
{
"value": "Extended",
"name": "Extended"
},
{
"value": "ExternalGrammar",
"name": "ExternalGrammar"
}
]
}
},
"com.amazonaws.lexmodelsv2#SlotTypeFilter": {
"type": "structure",
"members": {
@ -10120,6 +10234,10 @@
{
"value": "SlotTypeName",
"name": "SlotTypeName"
},
{
"value": "ExternalSourceType",
"name": "ExternalSourceType"
}
]
}
@ -10237,6 +10355,12 @@
"traits": {
"smithy.api#documentation": "<p>A timestamp of the date and time that the slot type was last\n updated.</p>"
}
},
"slotTypeCategory": {
"target": "com.amazonaws.lexmodelsv2#SlotTypeCategory",
"traits": {
"smithy.api#documentation": "<p>Indicates the type of the slot type.</p>\n <ul>\n <li>\n <p>\n <code>Custom</code> - A slot type that you created using\n custom values. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/custom-slot-types.html\">Creating custom slot\n types</a>.</p>\n </li>\n <li>\n <p>\n <code>Extended</code> - A slot type created by extending the\n AMAZON.AlphaNumeric built-in slot type. For more information, see\n <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html\">AMAZON.AlphaNumeric</a>.</p>\n </li>\n <li>\n <p>\n <code>ExternalGrammar</code> - A slot type using a custom\n GRXML grammar to define values. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/building-grxml.html\">Using a custom grammar slot type</a>.</p>\n </li>\n </ul>"
}
}
},
"traits": {
@ -11342,6 +11466,12 @@
"traits": {
"smithy.api#documentation": "<p>A timestamp of the date and time that the locale was last\n updated.</p>"
}
},
"recommendedActions": {
"target": "com.amazonaws.lexmodelsv2#RecommendedActions",
"traits": {
"smithy.api#documentation": "<p>Recommended actions to take to resolve an error in the\n <code>failureReasons</code> field.</p>"
}
}
}
},
@ -12306,8 +12436,7 @@
"valueSelectionSetting": {
"target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting",
"traits": {
"smithy.api#documentation": "<p>The strategy that Amazon Lex should use when deciding on a value from the\n list of slot type values.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The strategy that Amazon Lex should use when deciding on a value from the\n list of slot type values.</p>"
}
},
"parentSlotTypeSignature": {
@ -12339,6 +12468,9 @@
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"externalSourceSetting": {
"target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting"
}
}
},
@ -12410,6 +12542,9 @@
"traits": {
"smithy.api#documentation": "<p>A timestamp of the date and time that the slot type was last\n updated.</p>"
}
},
"externalSourceSetting": {
"target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting"
}
}
},
@ -12484,7 +12619,7 @@
"engine": {
"target": "com.amazonaws.lexmodelsv2#VoiceEngine",
"traits": {
"smithy.api#documentation": "<p>Indicates the type of Amazon Polly\n voice that Amazon Lex should use for voice interaction with the user. \n For more information, see <a href=\"https://docs.aws.amazon.com/polly/latest/dg/voicelist.html\">Voices in Amazon Polly</a>.</p>"
"smithy.api#documentation": "<p>Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more\n information, see the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine\">\n <code>engine</code> parameter of the\n <code>SynthesizeSpeech</code> operation</a> in the\n <i>Amazon Polly developer guide</i>.</p>\n <p>If you do not specify a value, the default is\n <code>standard</code>.</p>"
}
}
},

206
aws/sdk/aws-models/network-firewall.json
View File

@ -1186,6 +1186,95 @@
"smithy.api#documentation": "<p>Returns the data objects for the specified rule group. </p>"
}
},
"com.amazonaws.networkfirewall#DescribeRuleGroupMetadata": {
"type": "operation",
"input": {
"target": "com.amazonaws.networkfirewall#DescribeRuleGroupMetadataRequest"
},
"output": {
"target": "com.amazonaws.networkfirewall#DescribeRuleGroupMetadataResponse"
},
"errors": [
{
"target": "com.amazonaws.networkfirewall#InternalServerError"
},
{
"target": "com.amazonaws.networkfirewall#InvalidRequestException"
},
{
"target": "com.amazonaws.networkfirewall#ResourceNotFoundException"
},
{
"target": "com.amazonaws.networkfirewall#ThrottlingException"
}
],
"traits": {
"smithy.api#documentation": "<p>High-level information about a rule group, returned by operations like create and describe. \n You can use the information provided in the metadata to retrieve and manage a rule group. \n You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>.\n </p>"
}
},
"com.amazonaws.networkfirewall#DescribeRuleGroupMetadataRequest": {
"type": "structure",
"members": {
"RuleGroupName": {
"target": "com.amazonaws.networkfirewall#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> \n <p>You must specify the ARN or the name, and you can specify both. </p>"
}
},
"RuleGroupArn": {
"target": "com.amazonaws.networkfirewall#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> \n <p>You must specify the ARN or the name, and you can specify both. </p>"
}
},
"Type": {
"target": "com.amazonaws.networkfirewall#RuleGroupType",
"traits": {
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
}
}
}
},
"com.amazonaws.networkfirewall#DescribeRuleGroupMetadataResponse": {
"type": "structure",
"members": {
"RuleGroupArn": {
"target": "com.amazonaws.networkfirewall#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> \n <p>You must specify the ARN or the name, and you can specify both. </p>",
"smithy.api#required": {}
}
},
"RuleGroupName": {
"target": "com.amazonaws.networkfirewall#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> \n <p>You must specify the ARN or the name, and you can specify both. </p>",
"smithy.api#required": {}
}
},
"Description": {
"target": "com.amazonaws.networkfirewall#Description",
"traits": {
"smithy.api#documentation": "<p>Returns the metadata objects for the specified rule group.\n </p>"
}
},
"Type": {
"target": "com.amazonaws.networkfirewall#RuleGroupType",
"traits": {
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
}
},
"Capacity": {
"target": "com.amazonaws.networkfirewall#RuleCapacity",
"traits": {
"smithy.api#documentation": "<p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. \n When you update a rule group, you are limited to this capacity. When you reference a rule group \n from a firewall policy, Network Firewall reserves this capacity for the rule group. </p> \n <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling \n <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p>"
}
},
"StatefulRuleOptions": {
"target": "com.amazonaws.networkfirewall#StatefulRuleOptions"
}
}
},
"com.amazonaws.networkfirewall#DescribeRuleGroupRequest": {
"type": "structure",
"members": {
@ -1530,7 +1619,7 @@
"StatefulDefaultActions": {
"target": "com.amazonaws.networkfirewall#StatefulActions",
"traits": {
"smithy.api#documentation": "<p>The default actions to take on a packet that doesn't match any stateful rules.</p>"
"smithy.api#documentation": "<p>The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, \n and is only valid when using the strict rule order.</p>\n <p>Valid values of the stateful default action:</p>\n <ul>\n <li>\n <p>aws:drop_strict</p>\n </li>\n <li>\n <p>aws:drop_established</p>\n </li>\n <li>\n <p>aws:alert_strict</p>\n </li>\n <li>\n <p>aws:alert_established</p>\n </li>\n </ul>\n <p>For more information, see \n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-strict-rule-evaluation-order.html\">Strict evaluation order</a> in the <i>AWS Network Firewall Developer Guide</i>.\n </p>"
}
},
"StatefulEngineOptions": {
@ -2063,6 +2152,12 @@
"traits": {
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more \n objects are available, in the response, Network Firewall provides a \n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
}
},
"Scope": {
"target": "com.amazonaws.networkfirewall#ResourceManagedStatus",
"traits": {
"smithy.api#documentation": "<p>The scope of the request. The default setting of <code>ACCOUNT</code> or a setting of \n <code>NULL</code> returns all of the rule groups in your account. A setting of \n <code>MANAGED</code> returns all available managed rule groups.</p>"
}
}
}
},
@ -2092,11 +2187,17 @@
"target": "com.amazonaws.networkfirewall#ListTagsForResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.networkfirewall#InternalServerError"
},
{
"target": "com.amazonaws.networkfirewall#InvalidRequestException"
},
{
"target": "com.amazonaws.networkfirewall#ResourceNotFoundException"
},
{
"target": "com.amazonaws.networkfirewall#ThrottlingException"
}
],
"traits": {
@ -2305,6 +2406,21 @@
},
"com.amazonaws.networkfirewall#NetworkFirewall_20201112": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "Network Firewall",
"arnNamespace": "network-firewall",
"cloudFormationName": "NetworkFirewall",
"cloudTrailEventSource": "networkfirewall.amazonaws.com",
"endpointPrefix": "network-firewall"
},
"aws.auth#sigv4": {
"name": "network-firewall"
},
"aws.protocols#awsJson1_0": {},
"smithy.api#documentation": "<p>This is the API Reference for AWS Network Firewall. This guide is for developers who need\n detailed information about the Network Firewall API actions, data types, and errors. </p>\n <ul>\n <li>\n <p>The REST API requires you to handle connection details, such as calculating\n signatures, handling request retries, and error handling. For general information\n about using the AWS REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">AWS APIs</a>. </p>\n <p>To access Network Firewall using the REST API endpoint:\n <code>https://network-firewall.<region>.amazonaws.com </code>\n </p>\n </li>\n <li>\n <p>Alternatively, you can use one of the AWS SDKs to access an API that's tailored to\n the programming language or platform that you're using. For more information, see\n <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p>\n </li>\n <li>\n <p>For descriptions of Network Firewall features, including and step-by-step\n instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer\n Guide</a>.</p>\n </li>\n </ul>\n <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and\n prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the\n perimeter of your VPC. This includes filtering traffic going to and coming from an internet\n gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible\n with Suricata, a free, open source intrusion detection system (IDS) engine. \n AWS Network Firewall supports Suricata version 5.0.2. For information about Suricata, \n see the <a href=\"https://suricata-ids.org/\">Suricata website</a>.</p>\n <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways.\n The following are just a few examples: </p>\n <ul>\n <li>\n <p>Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and\n block all other forms of traffic.</p>\n </li>\n <li>\n <p>Use custom lists of known bad domains to limit the types of domain names that your\n applications can access.</p>\n </li>\n <li>\n <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p>\n </li>\n <li>\n <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.</p>\n </li>\n </ul>\n <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in\n Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p>\n <p>To start using Network Firewall, do the following: </p>\n <ol>\n <li>\n <p>(Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC. </p>\n </li>\n <li>\n <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a\n subnet for the sole use of Network Firewall. </p>\n </li>\n <li>\n <p>In Network Firewall, create stateless and stateful rule groups, \n to define the components of the network traffic filtering behavior that you want your firewall to have. </p>\n </li>\n <li>\n <p>In Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior. </p>\n </li>\n <li>\n <p>In Network Firewall, create a firewall and specify your new firewall policy and \n VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you\n specify, with the behavior that's defined in the firewall policy.</p>\n </li>\n <li>\n <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.</p>\n </li>\n </ol>",
"smithy.api#title": "AWS Network Firewall"
},
"version": "2020-11-12",
"operations": [
{
@ -2349,6 +2465,9 @@
{
"target": "com.amazonaws.networkfirewall#DescribeRuleGroup"
},
{
"target": "com.amazonaws.networkfirewall#DescribeRuleGroupMetadata"
},
{
"target": "com.amazonaws.networkfirewall#DisassociateSubnets"
},
@ -2394,22 +2513,7 @@
{
"target": "com.amazonaws.networkfirewall#UpdateSubnetChangeProtection"
}
],
"traits": {
"aws.api#service": {
"sdkId": "Network Firewall",
"arnNamespace": "network-firewall",
"cloudFormationName": "NetworkFirewall",
"cloudTrailEventSource": "networkfirewall.amazonaws.com",
"endpointPrefix": "network-firewall"
},
"aws.auth#sigv4": {
"name": "network-firewall"
},
"aws.protocols#awsJson1_0": {},
"smithy.api#documentation": "<p>This is the API Reference for AWS Network Firewall. This guide is for developers who need\n detailed information about the Network Firewall API actions, data types, and errors. </p>\n <ul>\n <li>\n <p>The REST API requires you to handle connection details, such as calculating\n signatures, handling request retries, and error handling. For general information\n about using the AWS REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">AWS APIs</a>. </p>\n <p>To access Network Firewall using the REST API endpoint:\n <code>https://network-firewall.<region>.amazonaws.com </code>\n </p>\n </li>\n <li>\n <p>Alternatively, you can use one of the AWS SDKs to access an API that's tailored to\n the programming language or platform that you're using. For more information, see\n <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p>\n </li>\n <li>\n <p>For descriptions of Network Firewall features, including and step-by-step\n instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer\n Guide</a>.</p>\n </li>\n </ul>\n <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and\n prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the\n perimeter of your VPC. This includes filtering traffic going to and coming from an internet\n gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible\n with Suricata, a free, open source intrusion detection system (IDS) engine. \n AWS Network Firewall supports Suricata version 5.0.2. For information about Suricata, \n see the <a href=\"https://suricata-ids.org/\">Suricata website</a>.</p>\n <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways.\n The following are just a few examples: </p>\n <ul>\n <li>\n <p>Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and\n block all other forms of traffic.</p>\n </li>\n <li>\n <p>Use custom lists of known bad domains to limit the types of domain names that your\n applications can access.</p>\n </li>\n <li>\n <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p>\n </li>\n <li>\n <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.</p>\n </li>\n </ul>\n <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in\n Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p>\n <p>To start using Network Firewall, do the following: </p>\n <ol>\n <li>\n <p>(Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC. </p>\n </li>\n <li>\n <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a\n subnet for the sole use of Network Firewall. </p>\n </li>\n <li>\n <p>In Network Firewall, create stateless and stateful rule groups, \n to define the components of the network traffic filtering behavior that you want your firewall to have. </p>\n </li>\n <li>\n <p>In Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior. </p>\n </li>\n <li>\n <p>In Network Firewall, create a firewall and specify your new firewall policy and \n VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you\n specify, with the behavior that's defined in the firewall policy.</p>\n </li>\n <li>\n <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.</p>\n </li>\n </ol>",
"smithy.api#title": "AWS Network Firewall"
}
]
},
"com.amazonaws.networkfirewall#NumberOfAssociations": {
"type": "integer",
@ -2417,6 +2521,17 @@
"smithy.api#box": {}
}
},
"com.amazonaws.networkfirewall#OverrideAction": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "DROP_TO_ALERT",
"name": "DROP_TO_ALERT"
}
]
}
},
"com.amazonaws.networkfirewall#PaginationMaxResults": {
"type": "integer",
"traits": {
@ -2663,6 +2778,21 @@
"smithy.api#pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$"
}
},
"com.amazonaws.networkfirewall#ResourceManagedStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "MANAGED",
"name": "MANAGED"
},
{
"value": "ACCOUNT",
"name": "ACCOUNT"
}
]
}
},
"com.amazonaws.networkfirewall#ResourceName": {
"type": "string",
"traits": {
@ -2995,7 +3125,7 @@
"Targets": {
"target": "com.amazonaws.networkfirewall#RuleTargets",
"traits": {
"smithy.api#documentation": "<p>The domains that you want to inspect for in your traffic flows. To provide multiple\n domains, separate them with commas. Valid domain specifications are the following:</p>\n <ul>\n <li>\n <p>Explicit names. For example, <code>abc.example.com</code> matches only the domain <code>abc.example.com</code>.</p>\n </li>\n <li>\n <p>Names that use a domain wildcard, which you indicate with an initial '<code>.</code>'. For example,<code>.example.com</code> matches <code>example.com</code> and matches all subdomains of <code>example.com</code>, such as <code>abc.example.com</code> and <code>www.example.com</code>. </p>\n\t </li>\n </ul>",
"smithy.api#documentation": "<p>The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:</p>\n <ul>\n <li>\n <p>Explicit names. For example, <code>abc.example.com</code> matches only the domain <code>abc.example.com</code>.</p>\n </li>\n <li>\n <p>Names that use a domain wildcard, which you indicate with an initial '<code>.</code>'. For example,<code>.example.com</code> matches <code>example.com</code> and matches all subdomains of <code>example.com</code>, such as <code>abc.example.com</code> and <code>www.example.com</code>. </p>\n\t </li>\n </ul>",
"smithy.api#required": {}
}
},
@ -3084,7 +3214,7 @@
"RuleOrder": {
"target": "com.amazonaws.networkfirewall#RuleOrder",
"traits": {
"smithy.api#documentation": "<p>Indicates how to manage the order of stateful rule evaluation for the policy. By default, Network Firewall\n leaves the rule evaluation order up to the Suricata rule processing engine. If you set \n this to <code>STRICT_ORDER</code>, your rules are evaluated in the exact order that you provide them\n in the policy. With strict ordering, the rule groups are evaluated by order of priority, starting from the lowest number, and \n the rules in each rule group are processed in the order that they're defined. </p>"
"smithy.api#documentation": "<p>Indicates how to manage the order of stateful rule evaluation for the policy. <code>DEFAULT_ACTION_ORDER</code> is\n the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\n based on certain settings. For more information, see \n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html\">Evaluation order for stateful rules</a> in the <i>AWS Network Firewall Developer Guide</i>.\n </p>"
}
}
},
@ -3136,6 +3266,20 @@
]
}
},
"com.amazonaws.networkfirewall#StatefulRuleGroupOverride": {
"type": "structure",
"members": {
"Action": {
"target": "com.amazonaws.networkfirewall#OverrideAction",
"traits": {
"smithy.api#documentation": "<p>The action that changes the rule group from <code>DROP</code> to <code>ALERT</code>. This only applies to\n managed rule groups.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The setting that allows the policy owner to change the behavior of the rule group within a policy. </p>"
}
},
"com.amazonaws.networkfirewall#StatefulRuleGroupReference": {
"type": "structure",
"members": {
@ -3152,6 +3296,12 @@
"smithy.api#box": {},
"smithy.api#documentation": "<p>An integer setting that indicates the order in which to run the stateful rule groups in\n a single <a>FirewallPolicy</a>. This setting only applies to firewall policies\n that specify the <code>STRICT_ORDER</code> rule order in the stateful engine options settings.</p>\n <p>Network Firewall evalutes each stateful rule group\n against a packet starting with the group that has the lowest priority setting. You must ensure\n that the priority settings are unique within each policy.</p>\n <p>You can change the priority settings of your rule groups at any time. To make it easier to\n insert rule groups later, number them so there's a wide range in between, for example use 100,\n 200, and so on. </p>"
}
},
"Override": {
"target": "com.amazonaws.networkfirewall#StatefulRuleGroupOverride",
"traits": {
"smithy.api#documentation": "<p>The action that allows the policy owner to override the behavior of the rule group within a policy.</p>"
}
}
},
"traits": {
@ -3170,7 +3320,7 @@
"RuleOrder": {
"target": "com.amazonaws.networkfirewall#RuleOrder",
"traits": {
"smithy.api#documentation": "<p>Indicates how to manage the order of the rule evaluation for the rule group. By default, Network Firewall\n leaves the rule evaluation order up to the Suricata rule processing engine. If you set \n this to <code>STRICT_ORDER</code>, your rules are evaluated in the exact order that they're listed \n in your Suricata rules string. </p>"
"smithy.api#documentation": "<p>Indicates how to manage the order of the rule evaluation for the rule group. <code>DEFAULT_ACTION_ORDER</code> is\n the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\n based on certain settings. For more information, see \n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html\">Evaluation order for stateful rules</a> in the <i>AWS Network Firewall Developer Guide</i>.\n </p>"
}
}
},
@ -3540,11 +3690,17 @@
"target": "com.amazonaws.networkfirewall#TagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.networkfirewall#InternalServerError"
},
{
"target": "com.amazonaws.networkfirewall#InvalidRequestException"
},
{
"target": "com.amazonaws.networkfirewall#ResourceNotFoundException"
},
{
"target": "com.amazonaws.networkfirewall#ThrottlingException"
}
],
"traits": {
@ -3648,11 +3804,17 @@
"target": "com.amazonaws.networkfirewall#UntagResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.networkfirewall#InternalServerError"
},
{
"target": "com.amazonaws.networkfirewall#InvalidRequestException"
},
{
"target": "com.amazonaws.networkfirewall#ResourceNotFoundException"
},
{
"target": "com.amazonaws.networkfirewall#ThrottlingException"
}
],
"traits": {
@ -3762,7 +3924,7 @@
"DeleteProtection": {
"target": "com.amazonaws.networkfirewall#Boolean",
"traits": {
"smithy.api#documentation": "<p></p>"
"smithy.api#documentation": "<p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> indicates\n that the firewall is protected against deletion. Use this setting to protect against\n accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to <code>TRUE</code>.</p>"
}
},
"UpdateToken": {
@ -3918,7 +4080,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p></p>"
"smithy.api#documentation": "<p>Modifies the flag, <code>ChangeProtection</code>, which indicates whether it \n is possible to change the firewall. If the flag is set to <code>TRUE</code>, the firewall is protected \n from changes. This setting helps protect against accidentally changing a firewall that's in use.</p>"
}
},
"com.amazonaws.networkfirewall#UpdateFirewallPolicyChangeProtectionRequest": {

4695
aws/sdk/aws-models/networkmanager.json
View File

File diff suppressed because it is too large Load Diff

482
aws/sdk/aws-models/nimble.json
View File

File diff suppressed because it is too large Load Diff

89
aws/sdk/aws-models/outposts.json
View File

@ -585,6 +585,7 @@
"SiteId": {
"target": "com.amazonaws.outposts#SiteId",
"traits": {
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the site.\n </p>",
"smithy.api#required": {}
}
},
@ -742,7 +743,7 @@
"OutpostId": {
"target": "com.amazonaws.outposts#OutpostId",
"traits": {
"smithy.api#documentation": "<p>\n The ID of the Outpost.\n </p>",
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
@ -793,6 +794,7 @@
"SiteId": {
"target": "com.amazonaws.outposts#SiteId",
"traits": {
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the site.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
@ -1024,7 +1026,7 @@
"OutpostId": {
"target": "com.amazonaws.outposts#OutpostId",
"traits": {
"smithy.api#documentation": "<p>\n The ID of the Outpost.\n </p>",
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
@ -1068,7 +1070,7 @@
"OutpostId": {
"target": "com.amazonaws.outposts#OutpostId",
"traits": {
"smithy.api#documentation": "<p>\n The ID of the Outpost.\n </p>",
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
@ -1183,6 +1185,7 @@
"SiteId": {
"target": "com.amazonaws.outposts#SiteId",
"traits": {
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the site.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
@ -1223,6 +1226,7 @@
"SiteId": {
"target": "com.amazonaws.outposts#SiteId",
"traits": {
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the site.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
@ -1918,7 +1922,7 @@
"OutpostId": {
"target": "com.amazonaws.outposts#OutpostIdOnly",
"traits": {
"smithy.api#documentation": "<p> The ID of the Outpost in the order. </p>"
"smithy.api#documentation": "<p>\n The ID of the Outpost in the order.\n </p>"
}
},
"OrderId": {
@ -2096,7 +2100,7 @@
"OutpostId": {
"target": "com.amazonaws.outposts#OutpostId",
"traits": {
"smithy.api#documentation": "<p> The ID of the Outpost. </p>"
"smithy.api#documentation": "<p>\n The ID of the Outpost.\n </p>"
}
},
"OwnerId": {
@ -2282,6 +2286,9 @@
{
"target": "com.amazonaws.outposts#UntagResource"
},
{
"target": "com.amazonaws.outposts#UpdateOutpost"
},
{
"target": "com.amazonaws.outposts#UpdateSite"
},
@ -2593,7 +2600,7 @@
"com.amazonaws.outposts#SiteId": {
"type": "string",
"traits": {
"smithy.api#documentation": "<p>The ID of the site.</p>",
"smithy.api#documentation": "<p>\n The ID of the site.\n </p>",
"smithy.api#length": {
"min": 1,
"max": 255
@ -2860,6 +2867,73 @@
"type": "structure",
"members": {}
},
"com.amazonaws.outposts#UpdateOutpost": {
"type": "operation",
"input": {
"target": "com.amazonaws.outposts#UpdateOutpostInput"
},
"output": {
"target": "com.amazonaws.outposts#UpdateOutpostOutput"
},
"errors": [
{
"target": "com.amazonaws.outposts#AccessDeniedException"
},
{
"target": "com.amazonaws.outposts#ConflictException"
},
{
"target": "com.amazonaws.outposts#InternalServerException"
},
{
"target": "com.amazonaws.outposts#NotFoundException"
},
{
"target": "com.amazonaws.outposts#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>\n Updates an Outpost.\n </p>",
"smithy.api#http": {
"method": "PATCH",
"uri": "/outposts/{OutpostId}",
"code": 200
}
}
},
"com.amazonaws.outposts#UpdateOutpostInput": {
"type": "structure",
"members": {
"OutpostId": {
"target": "com.amazonaws.outposts#OutpostId",
"traits": {
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"Name": {
"target": "com.amazonaws.outposts#OutpostName"
},
"Description": {
"target": "com.amazonaws.outposts#OutpostDescription"
},
"SupportedHardwareType": {
"target": "com.amazonaws.outposts#SupportedHardwareType",
"traits": {
"smithy.api#documentation": "<p>\n The type of hardware for this Outpost.\n </p>"
}
}
}
},
"com.amazonaws.outposts#UpdateOutpostOutput": {
"type": "structure",
"members": {
"Outpost": {
"target": "com.amazonaws.outposts#Outpost"
}
}
},
"com.amazonaws.outposts#UpdateSite": {
"type": "operation",
"input": {
@ -2934,6 +3008,7 @@
"SiteId": {
"target": "com.amazonaws.outposts#SiteId",
"traits": {
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the site.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
@ -2977,6 +3052,7 @@
"SiteId": {
"target": "com.amazonaws.outposts#SiteId",
"traits": {
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the site.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
@ -3043,6 +3119,7 @@
"SiteId": {
"target": "com.amazonaws.outposts#SiteId",
"traits": {
"smithy.api#documentation": "<p>\n The ID or the Amazon Resource Name (ARN) of the site.\n </p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}

99
aws/sdk/aws-models/qldb.json
View File

@ -31,6 +31,24 @@
"shapes": {
"com.amazonaws.qldb#AmazonQLDB": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "QLDB",
"arnNamespace": "qldb",
"cloudFormationName": "QLDB",
"cloudTrailEventSource": "qldb.amazonaws.com",
"endpointPrefix": "qldb"
},
"aws.auth#sigv4": {
"name": "qldb"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>The control plane for Amazon QLDB</p>",
"smithy.api#title": "Amazon QLDB",
"smithy.api#xmlNamespace": {
"uri": "http://ledger.amazonaws.com/doc/2019-01-02/"
}
},
"version": "2019-01-02",
"operations": [
{
@ -93,25 +111,7 @@
{
"target": "com.amazonaws.qldb#UpdateLedgerPermissionsMode"
}
],
"traits": {
"aws.api#service": {
"sdkId": "QLDB",
"arnNamespace": "qldb",
"cloudFormationName": "QLDB",
"cloudTrailEventSource": "qldb.amazonaws.com",
"endpointPrefix": "qldb"
},
"aws.auth#sigv4": {
"name": "qldb"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>The control plane for Amazon QLDB</p>",
"smithy.api#title": "Amazon QLDB",
"smithy.api#xmlNamespace": {
"uri": "http://ledger.amazonaws.com/doc/2019-01-02/"
}
}
]
},
"com.amazonaws.qldb#Arn": {
"type": "string",
@ -211,7 +211,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a new ledger in your account in the current Region.</p>",
"smithy.api#documentation": "<p>Creates a new ledger in your Amazon Web Services account in the current Region.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/ledgers",
@ -225,7 +225,7 @@
"Name": {
"target": "com.amazonaws.qldb#LedgerName",
"traits": {
"smithy.api#documentation": "<p>The name of the ledger that you want to create. The name must be unique among all of\n the ledgers in your account in the current Region.</p>\n <p>Naming constraints for ledger names are defined in <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming\">Quotas in Amazon QLDB</a>\n in the <i>Amazon QLDB Developer Guide</i>.</p>",
"smithy.api#documentation": "<p>The name of the ledger that you want to create. The name must be unique among all of the\n ledgers in your Amazon Web Services account in the current Region.</p>\n <p>Naming constraints for ledger names are defined in <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming\">Quotas in Amazon QLDB</a>\n in the <i>Amazon QLDB Developer Guide</i>.</p>",
"smithy.api#required": {}
}
},
@ -251,7 +251,7 @@
"KmsKey": {
"target": "com.amazonaws.qldb#KmsKey",
"traits": {
"smithy.api#documentation": "<p>The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html\">Encryption at rest</a> in\n the <i>Amazon QLDB Developer Guide</i>.</p>\n <p>Use one of the following options to specify this parameter:</p>\n <ul>\n <li>\n <p>\n <code>AWS_OWNED_KMS_KEY</code>: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.</p>\n </li>\n <li>\n <p>\n <b>Undefined</b>: By default, use an Amazon Web Services owned KMS\n key.</p>\n </li>\n <li>\n <p>\n <b>A valid symmetric customer managed KMS key</b>: Use\n the specified KMS key in your account that you create, own, and manage.</p>\n <p>Amazon QLDB does not support asymmetric keys. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer\n Guide</i>.</p>\n </li>\n </ul>\n <p>To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n <code>\"alias/\"</code>. To specify a key in a different account, you must use the key\n ARN or alias ARN.</p>\n <p>For example:</p>\n <ul>\n <li>\n <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Key ARN:\n <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Alias name: <code>alias/ExampleAlias</code>\n </p>\n </li>\n <li>\n <p>Alias ARN:\n <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>\n </p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id\">Key identifiers (KeyId)</a> in\n the <i>Key Management Service Developer Guide</i>.</p>"
"smithy.api#documentation": "<p>The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html\">Encryption at rest</a> in\n the <i>Amazon QLDB Developer Guide</i>.</p>\n <p>Use one of the following options to specify this parameter:</p>\n <ul>\n <li>\n <p>\n <code>AWS_OWNED_KMS_KEY</code>: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.</p>\n </li>\n <li>\n <p>\n <b>Undefined</b>: By default, use an Amazon Web Services owned KMS\n key.</p>\n </li>\n <li>\n <p>\n <b>A valid symmetric customer managed KMS key</b>: Use\n the specified KMS key in your account that you create, own, and manage.</p>\n <p>Amazon QLDB does not support asymmetric keys. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer\n Guide</i>.</p>\n </li>\n </ul>\n <p>To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n <code>\"alias/\"</code>. To specify a key in a different Amazon Web Services account, you must use the key\n ARN or alias ARN.</p>\n <p>For example:</p>\n <ul>\n <li>\n <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Key ARN:\n <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Alias name: <code>alias/ExampleAlias</code>\n </p>\n </li>\n <li>\n <p>Alias ARN:\n <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>\n </p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id\">Key identifiers (KeyId)</a> in\n the <i>Key Management Service Developer Guide</i>.</p>"
}
}
}
@ -613,7 +613,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Exports journal contents within a date and time range from a ledger into a specified\n Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.</p>\n <p>If the ledger with the given <code>Name</code> doesn't exist, then throws\n <code>ResourceNotFoundException</code>.</p>\n <p>If the ledger with the given <code>Name</code> is in <code>CREATING</code> status, then\n throws <code>ResourcePreconditionNotMetException</code>.</p>\n <p>You can initiate up to two concurrent journal export requests for each ledger. Beyond\n this limit, journal export requests throw <code>LimitExceededException</code>.</p>",
"smithy.api#documentation": "<p>Exports journal contents within a date and time range from a ledger into a specified\n Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text\n or binary representation of Amazon Ion format, or in <i>JSON Lines</i> text\n format.</p>\n <p>In JSON Lines format, each journal block in the exported data object is a valid JSON\n object that is delimited by a newline. You can use this format to easily integrate JSON\n exports with analytics tools such as Glue and Amazon Athena\n because these services can parse newline-delimited JSON automatically. For more information\n about the format, see <a href=\"https://jsonlines.org/\">JSON Lines</a>.</p>\n <p>If the ledger with the given <code>Name</code> doesn't exist, then throws\n <code>ResourceNotFoundException</code>.</p>\n <p>If the ledger with the given <code>Name</code> is in <code>CREATING</code> status, then\n throws <code>ResourcePreconditionNotMetException</code>.</p>\n <p>You can initiate up to two concurrent journal export requests for each ledger. Beyond\n this limit, journal export requests throw <code>LimitExceededException</code>.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/ledgers/{Name}/journal-s3-exports",
@ -656,9 +656,15 @@
"RoleArn": {
"target": "com.amazonaws.qldb#Arn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:</p>\n <ul>\n <li>\n <p>Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.</p>\n </li>\n <li>\n <p>(Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side\n encryption of your exported data.</p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:</p>\n <ul>\n <li>\n <p>Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.</p>\n </li>\n <li>\n <p>(Optional) Use your customer managed key in Key Management Service (KMS) for server-side\n encryption of your exported data.</p>\n </li>\n </ul>\n <p>To pass a role to QLDB when requesting a journal export, you must have permissions to\n perform the <code>iam:PassRole</code> action on the IAM role resource. This is required for\n all journal export requests.</p>",
"smithy.api#required": {}
}
},
"OutputFormat": {
"target": "com.amazonaws.qldb#OutputFormat",
"traits": {
"smithy.api#documentation": "<p>The output format of your exported journal data. If this parameter is not specified, the\n exported data defaults to <code>ION_TEXT</code> format.</p>"
}
}
}
},
@ -1053,14 +1059,14 @@
"InclusiveStartTime": {
"target": "com.amazonaws.qldb#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The inclusive start date and time for the range of journal contents that are specified\n in the original export request.</p>",
"smithy.api#documentation": "<p>The inclusive start date and time for the range of journal contents that was specified\n in the original export request.</p>",
"smithy.api#required": {}
}
},
"ExclusiveEndTime": {
"target": "com.amazonaws.qldb#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The exclusive end date and time for the range of journal contents that are specified in\n the original export request.</p>",
"smithy.api#documentation": "<p>The exclusive end date and time for the range of journal contents that was specified in\n the original export request.</p>",
"smithy.api#required": {}
}
},
@ -1073,9 +1079,15 @@
"RoleArn": {
"target": "com.amazonaws.qldb#Arn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:</p>\n <ul>\n <li>\n <p>Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.</p>\n </li>\n <li>\n <p>(Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side\n encryption of your exported data.</p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:</p>\n <ul>\n <li>\n <p>Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.</p>\n </li>\n <li>\n <p>(Optional) Use your customer managed key in Key Management Service (KMS) for server-side\n encryption of your exported data.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"OutputFormat": {
"target": "com.amazonaws.qldb#OutputFormat",
"traits": {
"smithy.api#documentation": "<p>The output format of the exported journal data.</p>"
}
}
},
"traits": {
@ -1316,7 +1328,7 @@
"target": "com.amazonaws.qldb#ListJournalS3ExportsResponse"
},
"traits": {
"smithy.api#documentation": "<p>Returns an array of journal export job descriptions for all ledgers that are associated\n with the current account and Region.</p>\n <p>This action returns a maximum of <code>MaxResults</code> items, and is paginated so that\n you can retrieve all the items by calling <code>ListJournalS3Exports</code> multiple\n times.</p>\n <p>This action does not return any expired export jobs. For more information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration\">Export job expiration</a> in the <i>Amazon QLDB Developer\n Guide</i>.</p>",
"smithy.api#documentation": "<p>Returns an array of journal export job descriptions for all ledgers that are associated\n with the current Amazon Web Services account and Region.</p>\n <p>This action returns a maximum of <code>MaxResults</code> items, and is paginated so that\n you can retrieve all the items by calling <code>ListJournalS3Exports</code> multiple\n times.</p>\n <p>This action does not return any expired export jobs. For more information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration\">Export job expiration</a> in the <i>Amazon QLDB Developer\n Guide</i>.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/journal-s3-exports",
@ -1420,7 +1432,7 @@
"JournalS3Exports": {
"target": "com.amazonaws.qldb#JournalS3ExportList",
"traits": {
"smithy.api#documentation": "<p>The array of journal export job descriptions for all ledgers that are associated with\n the current account and Region.</p>"
"smithy.api#documentation": "<p>The array of journal export job descriptions for all ledgers that are associated with\n the current Amazon Web Services account and Region.</p>"
}
},
"NextToken": {
@ -1440,7 +1452,7 @@
"target": "com.amazonaws.qldb#ListLedgersResponse"
},
"traits": {
"smithy.api#documentation": "<p>Returns an array of ledger summaries that are associated with the current account\n and Region.</p>\n <p>This action returns a maximum of 100 items and is paginated so that you can\n retrieve all the items by calling <code>ListLedgers</code> multiple times.</p>",
"smithy.api#documentation": "<p>Returns an array of ledger summaries that are associated with the current Amazon Web Services account\n and Region.</p>\n <p>This action returns a maximum of 100 items and is paginated so that you can\n retrieve all the items by calling <code>ListLedgers</code> multiple times.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/ledgers",
@ -1478,7 +1490,7 @@
"Ledgers": {
"target": "com.amazonaws.qldb#LedgerList",
"traits": {
"smithy.api#documentation": "<p>The array of ledger summaries that are associated with the current account and\n Region.</p>"
"smithy.api#documentation": "<p>The array of ledger summaries that are associated with the current Amazon Web Services account and\n Region.</p>"
}
},
"NextToken": {
@ -1558,6 +1570,25 @@
"smithy.api#pattern": "^[A-Za-z-0-9+/=]+$"
}
},
"com.amazonaws.qldb#OutputFormat": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ION_BINARY",
"name": "ION_BINARY"
},
{
"value": "ION_TEXT",
"name": "ION_TEXT"
},
{
"value": "JSON",
"name": "JSON"
}
]
}
},
"com.amazonaws.qldb#ParameterName": {
"type": "string"
},
@ -1705,7 +1736,7 @@
"KmsKeyArn": {
"target": "com.amazonaws.qldb#Arn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) in Key Management Service\n (KMS). Amazon S3 does not support asymmetric CMKs.</p>\n <p>You must provide a <code>KmsKeyArn</code> if you specify <code>SSE_KMS</code> as the\n <code>ObjectEncryptionType</code>.</p>\n <p>\n <code>KmsKeyArn</code> is not required if you specify <code>SSE_S3</code> as the\n <code>ObjectEncryptionType</code>.</p>"
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not\n support asymmetric KMS keys.</p>\n <p>You must provide a <code>KmsKeyArn</code> if you specify <code>SSE_KMS</code> as the\n <code>ObjectEncryptionType</code>.</p>\n <p>\n <code>KmsKeyArn</code> is not required if you specify <code>SSE_S3</code> as the\n <code>ObjectEncryptionType</code>.</p>"
}
}
},
@ -1812,7 +1843,7 @@
"RoleArn": {
"target": "com.amazonaws.qldb#Arn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal stream to write data records to a Kinesis Data Streams resource.</p>",
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal stream to write data records to a Kinesis Data Streams resource.</p>\n <p>To pass a role to QLDB when requesting a journal stream, you must have permissions to\n perform the <code>iam:PassRole</code> action on the IAM role resource. This is required for\n all journal stream requests.</p>",
"smithy.api#required": {}
}
},
@ -2170,7 +2201,7 @@
"KmsKey": {
"target": "com.amazonaws.qldb#KmsKey",
"traits": {
"smithy.api#documentation": "<p>The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html\">Encryption at rest</a> in\n the <i>Amazon QLDB Developer Guide</i>.</p>\n <p>Use one of the following options to specify this parameter:</p>\n <ul>\n <li>\n <p>\n <code>AWS_OWNED_KMS_KEY</code>: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.</p>\n </li>\n <li>\n <p>\n <b>Undefined</b>: Make no changes to the KMS key of the\n ledger.</p>\n </li>\n <li>\n <p>\n <b>A valid symmetric customer managed KMS key</b>: Use\n the specified KMS key in your account that you create, own, and manage.</p>\n <p>Amazon QLDB does not support asymmetric keys. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer\n Guide</i>.</p>\n </li>\n </ul>\n <p>To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n <code>\"alias/\"</code>. To specify a key in a different account, you must use the key\n ARN or alias ARN.</p>\n <p>For example:</p>\n <ul>\n <li>\n <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Key ARN:\n <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Alias name: <code>alias/ExampleAlias</code>\n </p>\n </li>\n <li>\n <p>Alias ARN:\n <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>\n </p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id\">Key identifiers (KeyId)</a> in\n the <i>Key Management Service Developer Guide</i>.</p>"
"smithy.api#documentation": "<p>The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html\">Encryption at rest</a> in\n the <i>Amazon QLDB Developer Guide</i>.</p>\n <p>Use one of the following options to specify this parameter:</p>\n <ul>\n <li>\n <p>\n <code>AWS_OWNED_KMS_KEY</code>: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.</p>\n </li>\n <li>\n <p>\n <b>Undefined</b>: Make no changes to the KMS key of the\n ledger.</p>\n </li>\n <li>\n <p>\n <b>A valid symmetric customer managed KMS key</b>: Use\n the specified KMS key in your account that you create, own, and manage.</p>\n <p>Amazon QLDB does not support asymmetric keys. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer\n Guide</i>.</p>\n </li>\n </ul>\n <p>To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n <code>\"alias/\"</code>. To specify a key in a different Amazon Web Services account, you must use the key\n ARN or alias ARN.</p>\n <p>For example:</p>\n <ul>\n <li>\n <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Key ARN:\n <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>\n </p>\n </li>\n <li>\n <p>Alias name: <code>alias/ExampleAlias</code>\n </p>\n </li>\n <li>\n <p>Alias ARN:\n <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code>\n </p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id\">Key identifiers (KeyId)</a> in\n the <i>Key Management Service Developer Guide</i>.</p>"
}
}
}

8
aws/sdk/aws-models/quicksight.json
View File

@ -1681,7 +1681,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a dataset.</p>",
"smithy.api#documentation": "<p>Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/accounts/{AwsAccountId}/data-sets",
@ -2580,7 +2580,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates and starts a new SPICE ingestion on a dataset</p>\n\t\t\n\t\t <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/\">How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags?</a> in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.</p>",
"smithy.api#documentation": "<p>Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in\n\t\t\tan Enterprise edition account 32 times in a 24-hour period. You can manually refresh\n\t\t\tdatasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period\n\t\t\tis measured starting 24 hours before the current date and time.</p>\n\t\t\n\t\t <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/\">How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags?</a> in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}",
@ -6800,7 +6800,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Describes a dataset. </p>",
"smithy.api#documentation": "<p>Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}",
@ -17602,7 +17602,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Updates a dataset.</p>",
"smithy.api#documentation": "<p>Updates a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}",

545
aws/sdk/aws-models/ram.json
View File

File diff suppressed because it is too large Load Diff

70
aws/sdk/aws-models/rds.json
View File

File diff suppressed because one or more lines are too long

12
aws/sdk/aws-models/redshift.json
View File

@ -616,7 +616,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts. To authorize a datashare for a data consumer, the producer account\n must have the correct access privileges.</p>"
"smithy.api#documentation": "<p>From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account\n must have the correct access privileges.</p>"
}
},
"com.amazonaws.redshift#AuthorizeDataShareMessage": {
@ -632,7 +632,7 @@
"ConsumerIdentifier": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID.</p>",
"smithy.api#documentation": "<p>The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.</p>",
"smithy.api#required": {}
}
}
@ -3717,6 +3717,12 @@
"traits": {
"smithy.api#documentation": "<p>A value that specifies when the datashare has an association between a producer and data consumers.</p>"
}
},
"ManagedBy": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The identifier of a datashare to show its managing entity.</p>"
}
}
}
},
@ -3920,7 +3926,7 @@
"ConsumerIdentifier": {
"target": "com.amazonaws.redshift#String",
"traits": {
"smithy.api#documentation": "<p>The identifier of the data consumer that is to have authorization removed from the datashare. \n This identifier is an Amazon Web Services account ID.</p>",
"smithy.api#documentation": "<p>The identifier of the data consumer that is to have authorization removed from the datashare. \n This identifier is an Amazon Web Services account ID or a keyword, such as ADX.</p>",
"smithy.api#required": {}
}
}

40
aws/sdk/aws-models/rekognition.json
View File

File diff suppressed because one or more lines are too long

493
aws/sdk/aws-models/route53-recovery-control-config.json
View File

File diff suppressed because it is too large Load Diff

79
aws/sdk/aws-models/route53.json
View File

@ -34,6 +34,24 @@
},
"com.amazonaws.route53#AWSDnsV20130401": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "Route 53",
"arnNamespace": "route53",
"cloudFormationName": "Route53",
"cloudTrailEventSource": "route53.amazonaws.com",
"endpointPrefix": "route53"
},
"aws.auth#sigv4": {
"name": "route53"
},
"aws.protocols#restXml": {},
"smithy.api#documentation": "<p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.</p>",
"smithy.api#title": "Amazon Route 53",
"smithy.api#xmlNamespace": {
"uri": "https://route53.amazonaws.com/doc/2013-04-01/"
}
},
"version": "2013-04-01",
"operations": [
{
@ -228,25 +246,7 @@
{
"target": "com.amazonaws.route53#UpdateTrafficPolicyInstance"
}
],
"traits": {
"aws.api#service": {
"sdkId": "Route 53",
"arnNamespace": "route53",
"cloudFormationName": "Route53",
"cloudTrailEventSource": "route53.amazonaws.com",
"endpointPrefix": "route53"
},
"aws.auth#sigv4": {
"name": "route53"
},
"aws.protocols#restXml": {},
"smithy.api#documentation": "<p>Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.</p>",
"smithy.api#title": "Amazon Route 53",
"smithy.api#xmlNamespace": {
"uri": "https://route53.amazonaws.com/doc/2013-04-01/"
}
}
]
},
"com.amazonaws.route53#AccountLimit": {
"type": "structure",
@ -941,6 +941,10 @@
"value": "ap-southeast-2",
"name": "ap_southeast_2"
},
{
"value": "ap-southeast-3",
"name": "ap_southeast_3"
},
{
"value": "ap-northeast-1",
"name": "ap_northeast_1"
@ -989,6 +993,10 @@
"value": "us-iso-east-1",
"name": "us_iso_east_1"
},
{
"value": "us-iso-west-1",
"name": "us_iso_west_1"
},
{
"value": "us-isob-east-1",
"name": "us_isob_east_1"
@ -1199,7 +1207,7 @@
"VPC": {
"target": "com.amazonaws.route53#VPC",
"traits": {
"smithy.api#documentation": "<p>(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.</p>\n\t\t <p>You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, \n\t\t\tuse <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html\">AssociateVPCWithHostedZone</a>\n\t\t\tafter you create a hosted zone.</p>"
"smithy.api#documentation": "<p>(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.</p>\n\t\t <p>You can specify only one Amazon VPC when you create a private hosted zone. If you are associating a VPC with a hosted zone with this request,\n\t\t\tthe paramaters \n\t\t\t<code>VPCId</code> and <code>VPCRegion</code> are also required.</p>\n\t\t <p>To associate additional Amazon VPCs with the hosted zone, \n\t\t\tuse <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html\">AssociateVPCWithHostedZone</a>\n\t\t\tafter you create a hosted zone.</p>"
}
},
"CallerReference": {
@ -1338,7 +1346,7 @@
"KeyManagementServiceArn": {
"target": "com.amazonaws.route53#SigningKeyString",
"traits": {
"smithy.api#documentation": "<p>The Amazon resource name (ARN) for a customer managed customer master key (CMK) in Key Management Service (KMS).\n\t\t\tThe <code>KeyManagementServiceArn</code> must be unique for each key-signing key (KSK) in a single hosted zone. \n\t\t\tTo see an example of <code>KeyManagementServiceArn</code> that grants the correct permissions for DNSSEC, \n\t\t\tscroll down to <b>Example</b>. </p>\n\t\t <p>You must configure the customer managed CMK as follows:</p>\n\t\t <dl>\n <dt>Status</dt>\n <dd>\n <p>Enabled</p>\n </dd>\n <dt>Key spec</dt>\n <dd>\n <p>ECC_NIST_P256</p>\n </dd>\n <dt>Key usage</dt>\n <dd>\n <p>Sign and verify</p>\n </dd>\n <dt>Key policy</dt>\n <dd>\n <p>The key policy must give permission for the following actions:</p>\n\t\t\t\t\t <ul>\n <li>\n <p>DescribeKey</p>\n </li>\n <li>\n <p>GetPublicKey</p>\n </li>\n <li>\n <p>Sign</p>\n </li>\n </ul>\n\t\t\t\t\t <p>The key policy must also include the Amazon Route 53 service in the principal for your account. \n\t\t\t\t\t\tSpecify the following:</p>\n\t\t\t\t\t <ul>\n <li>\n <p>\n <code>\"Service\": \"dnssec-route53.amazonaws.com\"</code>\n </p>\n </li>\n </ul>\n\t\t\t\t </dd>\n </dl>\n\t\t <p>For more information about working with a customer managed CMK in KMS, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">Key Management Service concepts</a>.</p>",
"smithy.api#documentation": "<p>The Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS).\n\t\t\tThe <code>KeyManagementServiceArn</code> must be unique for each key-signing key (KSK) in a single hosted zone. \n\t\t\tTo see an example of <code>KeyManagementServiceArn</code> that grants the correct permissions for DNSSEC, \n\t\t\tscroll down to <b>Example</b>. </p>\n\t\t <p>You must configure the customer managed customer managed key as follows:</p>\n\t\t <dl>\n <dt>Status</dt>\n <dd>\n <p>Enabled</p>\n </dd>\n <dt>Key spec</dt>\n <dd>\n <p>ECC_NIST_P256</p>\n </dd>\n <dt>Key usage</dt>\n <dd>\n <p>Sign and verify</p>\n </dd>\n <dt>Key policy</dt>\n <dd>\n <p>The key policy must give permission for the following actions:</p>\n\t\t\t\t\t <ul>\n <li>\n <p>DescribeKey</p>\n </li>\n <li>\n <p>GetPublicKey</p>\n </li>\n <li>\n <p>Sign</p>\n </li>\n </ul>\n\t\t\t\t\t <p>The key policy must also include the Amazon Route 53 service in the principal for your account. \n\t\t\t\t\t\tSpecify the following:</p>\n\t\t\t\t\t <ul>\n <li>\n <p>\n <code>\"Service\": \"dnssec-route53.amazonaws.com\"</code>\n </p>\n </li>\n </ul>\n\t\t\t\t </dd>\n </dl>\n\t\t <p>For more information about working with a customer managed key in KMS, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">Key Management Service concepts</a>.</p>",
"smithy.api#required": {}
}
},
@ -1916,7 +1924,7 @@
"ServeSignature": {
"target": "com.amazonaws.route53#ServeSignature",
"traits": {
"smithy.api#documentation": "<p>A string that represents the current hosted zone signing status.</p>\n\t\t <p>Status can have one of the following values:</p>\n\t\t <dl>\n <dt>SIGNING</dt>\n <dd>\n <p>DNSSEC signing is enabled for the hosted zone.</p>\n </dd>\n <dt>NOT_SIGNING</dt>\n <dd>\n <p>DNSSEC signing is not enabled for the hosted zone.</p>\n </dd>\n <dt>DELETING</dt>\n <dd>\n <p>DNSSEC signing is in the process of being removed for the hosted zone.</p>\n </dd>\n <dt>ACTION_NEEDED</dt>\n <dd>\n <p>There is a problem with signing in the hosted zone that requires you to take action to resolve.\n\t\t\t\t\tFor example, the customer managed customer master key (CMK) might have been deleted, or the\n\t\t\t\t\tpermissions for the customer managed CMK might have been changed.</p>\n </dd>\n <dt>INTERNAL_FAILURE</dt>\n <dd>\n <p>There was an error during a request. Before you can continue to work with DNSSEC\n\t\t\t\t\tsigning, including with key-signing keys (KSKs), you must correct the problem by enabling or \n\t\t\t\t\tdisabling DNSSEC signing for the hosted zone.</p>\n </dd>\n </dl>"
"smithy.api#documentation": "<p>A string that represents the current hosted zone signing status.</p>\n\t\t <p>Status can have one of the following values:</p>\n\t\t <dl>\n <dt>SIGNING</dt>\n <dd>\n <p>DNSSEC signing is enabled for the hosted zone.</p>\n </dd>\n <dt>NOT_SIGNING</dt>\n <dd>\n <p>DNSSEC signing is not enabled for the hosted zone.</p>\n </dd>\n <dt>DELETING</dt>\n <dd>\n <p>DNSSEC signing is in the process of being removed for the hosted zone.</p>\n </dd>\n <dt>ACTION_NEEDED</dt>\n <dd>\n <p>There is a problem with signing in the hosted zone that requires you to take action to resolve.\n\t\t\t\t\tFor example, the customer managed key might have been deleted, or the\n\t\t\t\t\tpermissions for the customer managed key might have been changed.</p>\n </dd>\n <dt>INTERNAL_FAILURE</dt>\n <dd>\n <p>There was an error during a request. Before you can continue to work with DNSSEC\n\t\t\t\t\tsigning, including with key-signing keys (KSKs), you must correct the problem by enabling or \n\t\t\t\t\tdisabling DNSSEC signing for the hosted zone.</p>\n </dd>\n </dl>"
}
},
"StatusMessage": {
@ -2272,7 +2280,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be\n\t\tdeactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.</p>",
"smithy.api#documentation": "<p>Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be\n\t\tdeactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.</p>\n\t\t <p>You can use <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_DeactivateKeySigningKey.html\">DeactivateKeySigningKey</a> \n\t\t\tto deactivate the key before you delete it.</p>\n\t\t <p>Use <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetDNSSEC.html\">GetDNSSEC</a> to verify that the KSK is in an <code>INACTIVE</code>\n\t\t\tstatus.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}",
@ -4973,7 +4981,7 @@
"KmsArn": {
"target": "com.amazonaws.route53#SigningKeyString",
"traits": {
"smithy.api#documentation": "<p>The Amazon resource name (ARN) used to identify the customer managed customer master key (CMK) in Key Management Service (KMS).\n\t\t\tThe <code>KmsArn</code> must be unique for each key-signing key (KSK) in a single hosted zone.</p>\n\t\t <p>You must configure the CMK as follows:</p>\n\t\t <dl>\n <dt>Status</dt>\n <dd>\n <p>Enabled</p>\n </dd>\n <dt>Key spec</dt>\n <dd>\n <p>ECC_NIST_P256</p>\n </dd>\n <dt>Key usage</dt>\n <dd>\n <p>Sign and verify</p>\n </dd>\n <dt>Key policy</dt>\n <dd>\n <p>The key policy must give permission for the following actions:</p>\n\t\t\t\t <ul>\n <li>\n <p>DescribeKey</p>\n </li>\n <li>\n <p>GetPublicKey</p>\n </li>\n <li>\n <p>Sign</p>\n </li>\n </ul>\n\t\t\t\t\t <p>The key policy must also include the Amazon Route 53 service in the principal for your account. \n\t\t\t\t\t\tSpecify the following:</p>\n\t\t\t\t\t <ul>\n <li>\n <p>\n <code>\"Service\": \"dnssec-route53.amazonaws.com\"</code>\n </p>\n </li>\n </ul>\n\t\t\t\t </dd>\n </dl>\n\t\t <p>For more information about working with the customer managed CMK in KMS, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">Key Management Service concepts</a>.</p>"
"smithy.api#documentation": "<p>The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).\n\t\t\tThe <code>KmsArn</code> must be unique for each key-signing key (KSK) in a single hosted zone.</p>\n\t\t <p>You must configure the customer managed key as follows:</p>\n\t\t <dl>\n <dt>Status</dt>\n <dd>\n <p>Enabled</p>\n </dd>\n <dt>Key spec</dt>\n <dd>\n <p>ECC_NIST_P256</p>\n </dd>\n <dt>Key usage</dt>\n <dd>\n <p>Sign and verify</p>\n </dd>\n <dt>Key policy</dt>\n <dd>\n <p>The key policy must give permission for the following actions:</p>\n\t\t\t\t <ul>\n <li>\n <p>DescribeKey</p>\n </li>\n <li>\n <p>GetPublicKey</p>\n </li>\n <li>\n <p>Sign</p>\n </li>\n </ul>\n\t\t\t\t\t <p>The key policy must also include the Amazon Route 53 service in the principal for your account. \n\t\t\t\t\t\tSpecify the following:</p>\n\t\t\t\t\t <ul>\n <li>\n <p>\n <code>\"Service\": \"dnssec-route53.amazonaws.com\"</code>\n </p>\n </li>\n </ul>\n\t\t\t\t </dd>\n </dl>\n\t\t <p>For more information about working with the customer managed key in KMS, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">Key Management Service concepts</a>.</p>"
}
},
"Flag": {
@ -5039,7 +5047,7 @@
"Status": {
"target": "com.amazonaws.route53#SigningKeyStatus",
"traits": {
"smithy.api#documentation": "<p>A string that represents the current key-signing key (KSK) status.</p>\n\t\t <p>Status can have one of the following values:</p>\n\t\t <dl>\n <dt>ACTIVE</dt>\n <dd>\n <p>The KSK is being used for signing.</p>\n </dd>\n <dt>INACTIVE</dt>\n <dd>\n <p>The KSK is not being used for signing.</p>\n </dd>\n <dt>DELETING</dt>\n <dd>\n <p>The KSK is in the process of being deleted.</p>\n </dd>\n <dt>ACTION_NEEDED</dt>\n <dd>\n <p>There is a problem with the KSK that requires you to take action to resolve.\n\t\t\t\tFor example, the customer managed customer master key (CMK) might have been deleted, or the\n\t\t\t\tpermissions for the customer managed CMK might have been changed.</p>\n </dd>\n <dt>INTERNAL_FAILURE</dt>\n <dd>\n <p>There was an error during a request. Before you can continue to work with DNSSEC\n\t\t\t\t\tsigning, including actions that involve this KSK, you must correct the problem. For example,\n\t\t\t\t\tyou may need to activate or deactivate the KSK.</p>\n </dd>\n </dl>"
"smithy.api#documentation": "<p>A string that represents the current key-signing key (KSK) status.</p>\n\t\t <p>Status can have one of the following values:</p>\n\t\t <dl>\n <dt>ACTIVE</dt>\n <dd>\n <p>The KSK is being used for signing.</p>\n </dd>\n <dt>INACTIVE</dt>\n <dd>\n <p>The KSK is not being used for signing.</p>\n </dd>\n <dt>DELETING</dt>\n <dd>\n <p>The KSK is in the process of being deleted.</p>\n </dd>\n <dt>ACTION_NEEDED</dt>\n <dd>\n <p>There is a problem with the KSK that requires you to take action to resolve.\n\t\t\t\t\tFor example, the customer managed key might have been deleted, or the\n\t\t\t\t\tpermissions for the customer managed key might have been changed.</p>\n </dd>\n <dt>INTERNAL_FAILURE</dt>\n <dd>\n <p>There was an error during a request. Before you can continue to work with DNSSEC\n\t\t\t\t\tsigning, including actions that involve this KSK, you must correct the problem. For example,\n\t\t\t\t\tyou may need to activate or deactivate the KSK.</p>\n </dd>\n </dl>"
}
},
"StatusMessage": {
@ -5073,7 +5081,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>You've already created a key-signing key (KSK) with this name or with the same customer managed customer master key (CMK) ARN.</p>",
"smithy.api#documentation": "<p>You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
@ -7390,6 +7398,10 @@
"value": "ap-southeast-2",
"name": "ap_southeast_2"
},
{
"value": "ap-southeast-3",
"name": "ap_southeast_3"
},
{
"value": "ap-northeast-1",
"name": "ap_northeast_1"
@ -8503,7 +8515,7 @@
"InsufficientDataHealthStatus": {
"target": "com.amazonaws.route53#InsufficientDataHealthStatus",
"traits": {
"smithy.api#documentation": "<p>When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign \n\t\t\tto the health check:</p>\n\t\t <ul>\n <li>\n <p>\n <code>Healthy</code>: Route 53 considers the health check to be healthy.</p>\n </li>\n <li>\n <p>\n <code>Unhealthy</code>: Route 53 considers the health check to be unhealthy.</p>\n </li>\n <li>\n <p>\n <code>LastKnownStatus</code>: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data \n\t\t\t\tto determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.</p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign \n\t\t\tto the health check:</p>\n\t\t <ul>\n <li>\n <p>\n <code>Healthy</code>: Route 53 considers the health check to be healthy.</p>\n </li>\n <li>\n <p>\n <code>Unhealthy</code>: Route 53 considers the health check to be unhealthy.</p>\n </li>\n <li>\n <p>\n <code>LastKnownStatus</code>: By default, Route 53 uses the status of the health check from the last time CloudWatch had sufficient data \n\t\t\t\tto determine the alarm state. For new health checks that have no last known status, the status for the health check is healthy.</p>\n </li>\n </ul>"
}
},
"ResetElements": {
@ -8546,6 +8558,9 @@
},
{
"target": "com.amazonaws.route53#NoSuchHostedZone"
},
{
"target": "com.amazonaws.route53#PriorRequestNotComplete"
}
],
"traits": {
@ -8776,7 +8791,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>(Private hosted zones only) A complex type that contains information about an Amazon VPC.</p>"
"smithy.api#documentation": "<p>(Private hosted zones only) A complex type that contains information about an Amazon VPC.</p>\n\t\t <p>If you associate a private hosted zone with an Amazon VPC when you make a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html\">CreateHostedZone</a> request, the following parameters are also\n\t\t\trequired.</p>"
}
},
"com.amazonaws.route53#VPCAssociationAuthorizationNotFound": {
@ -8877,6 +8892,10 @@
"value": "us-iso-east-1",
"name": "us_iso_east_1"
},
{
"value": "us-iso-west-1",
"name": "us_iso_west_1"
},
{
"value": "us-isob-east-1",
"name": "us_isob_east_1"
@ -8889,6 +8908,10 @@
"value": "ap-southeast-2",
"name": "ap_southeast_2"
},
{
"value": "ap-southeast-3",
"name": "ap_southeast_3"
},
{
"value": "ap-south-1",
"name": "ap_south_1"

608
aws/sdk/aws-models/route53domains.json
View File

File diff suppressed because one or more lines are too long

10
aws/sdk/aws-models/s3.json
View File

File diff suppressed because one or more lines are too long

2
aws/sdk/aws-models/s3control.json
View File

@ -6186,7 +6186,7 @@
"target": "com.amazonaws.s3control#S3ExpirationInDays",
"traits": {
"smithy.api#box": {},
"smithy.api#documentation": "<p>This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3.\n S3 Initiate Restore Object jobs that\n target S3 Glacier and S3 Glacier Deep Archive objects require <code>ExpirationInDays</code> set to 1\n or greater.</p>\n <p>Conversely, do <i>not</i> set <code>ExpirationInDays</code> when\n creating S3 Initiate Restore Object jobs that target\n S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in\n S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so\n specifying <code>ExpirationInDays</code> results in restore request failure.</p>\n <p>S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class\n objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier\n objects, but not both types in the same job. If you need to restore objects of both types\n you <i>must</i> create separate Batch Operations jobs. </p>"
"smithy.api#documentation": "<p>This argument specifies how long the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive object remains available in Amazon S3.\n S3 Initiate Restore Object jobs that\n target S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive objects require <code>ExpirationInDays</code> set to 1\n or greater.</p>\n <p>Conversely, do <i>not</i> set <code>ExpirationInDays</code> when\n creating S3 Initiate Restore Object jobs that target\n S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in\n S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so\n specifying <code>ExpirationInDays</code> results in restore request failure.</p>\n <p>S3 Batch Operations jobs can operate either on S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive storage class\n objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier\n objects, but not both types in the same job. If you need to restore objects of both types\n you <i>must</i> create separate Batch Operations jobs. </p>"
}
},
"GlacierJobTier": {

289
aws/sdk/aws-models/sagemaker.json
View File

@ -1899,6 +1899,12 @@
"smithy.api#documentation": "<p>The name of the target variable in supervised learning, usually represented by\n 'y'.</p>",
"smithy.api#required": {}
}
},
"ContentType": {
"target": "com.amazonaws.sagemaker#ContentType",
"traits": {
"smithy.api#documentation": "<p>The content type of the data from the input source. You can use\n <code>text/csv;header=present</code> or <code>x-application/vnd.amazon+parquet</code>.\n The default value is <code>text/csv;header=present</code>.</p>"
}
}
},
"traits": {
@ -2724,6 +2730,16 @@
"smithy.api#pattern": "^[^ ~^:?*\\[]+$"
}
},
"com.amazonaws.sagemaker#BucketName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 3,
"max": 63
},
"smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$"
}
},
"com.amazonaws.sagemaker#CacheHitResult": {
"type": "structure",
"members": {
@ -5125,7 +5141,7 @@
"smithy.api#deprecated": {
"message": "This property is deprecated, use KmsKeyId instead."
},
"smithy.api#documentation": "<p>This member is deprecated and replaced with <code>KmsKeyId</code>.</p>"
"smithy.api#documentation": "<p>Use <code>KmsKeyId</code>.</p>"
}
},
"KmsKeyId": {
@ -6894,8 +6910,13 @@
"PipelineDefinition": {
"target": "com.amazonaws.sagemaker#PipelineDefinition",
"traits": {
"smithy.api#documentation": "<p>The JSON pipeline definition of the pipeline.</p>",
"smithy.api#required": {}
"smithy.api#documentation": "<p>The JSON pipeline definition of the pipeline.</p>"
}
},
"PipelineDefinitionS3Location": {
"target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location",
"traits": {
"smithy.api#documentation": "<p>The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.</p>"
}
},
"PipelineDescription": {
@ -6924,6 +6945,12 @@
"traits": {
"smithy.api#documentation": "<p>A list of tags to apply to the created pipeline.</p>"
}
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>This is the configuration that controls the parallelism of the pipeline. \n If specified, it applies to all runs of this pipeline by default.</p>"
}
}
}
},
@ -7982,7 +8009,7 @@
"traits": {
"smithy.api#length": {
"min": 0,
"max": 30
"max": 200
}
}
},
@ -11163,7 +11190,7 @@
"smithy.api#deprecated": {
"message": "This property is deprecated, use KmsKeyId instead."
},
"smithy.api#documentation": "<p>This member is deprecated and replaced with <code>KmsKeyId</code>.</p>"
"smithy.api#documentation": "<p>Use <code>KmsKeyId</code>.</p>"
}
},
"SubnetIds": {
@ -13963,6 +13990,12 @@
},
"LastModifiedBy": {
"target": "com.amazonaws.sagemaker#UserContext"
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>The parallelism configuration applied to the pipeline.</p>"
}
}
}
},
@ -14046,6 +14079,12 @@
},
"LastModifiedBy": {
"target": "com.amazonaws.sagemaker#UserContext"
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>Lists the parallelism configuration applied to the pipeline.</p>"
}
}
}
},
@ -16110,6 +16149,38 @@
"smithy.api#documentation": "<p>Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package. </p>"
}
},
"com.amazonaws.sagemaker#EMRStepMetadata": {
"type": "structure",
"members": {
"ClusterId": {
"target": "com.amazonaws.sagemaker#String256",
"traits": {
"smithy.api#documentation": "<p>The identifier of the EMR cluster.</p>"
}
},
"StepId": {
"target": "com.amazonaws.sagemaker#String256",
"traits": {
"smithy.api#documentation": "<p>The identifier of the EMR cluster step.</p>"
}
},
"StepName": {
"target": "com.amazonaws.sagemaker#String256",
"traits": {
"smithy.api#documentation": "<p>The name of the EMR cluster step.</p>"
}
},
"LogFilePath": {
"target": "com.amazonaws.sagemaker#String1024",
"traits": {
"smithy.api#documentation": "<p>The path to the log file where the cluster step's failure root cause \n is recorded.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The configurations and outcomes of an Amazon EMR step execution.</p>"
}
},
"com.amazonaws.sagemaker#Edge": {
"type": "structure",
"members": {
@ -20061,7 +20132,7 @@
"FrameworkVersion": {
"target": "com.amazonaws.sagemaker#FrameworkVersion",
"traits": {
"smithy.api#documentation": "<p>Specifies the framework version to use.</p>\n <p>This API field is only supported for PyTorch framework versions <code>1.4</code>, \n <code>1.5</code>, and <code>1.6</code> for \n cloud instance target devices: <code>ml_c4</code>, <code>ml_c5</code>, <code>ml_m4</code>, \n <code>ml_m5</code>, <code>ml_p2</code>, <code>ml_p3</code>, and <code>ml_g4dn</code>.</p>"
"smithy.api#documentation": "<p>Specifies the framework version to use. This API field is only supported for the PyTorch and TensorFlow frameworks.</p>\n <p>For information about framework versions supported for cloud targets and edge devices, see \n <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-cloud.html\">Cloud Supported Instance Types and Frameworks</a> and \n <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-devices-edge-frameworks.html\">Edge Supported Frameworks</a>.</p>"
}
}
},
@ -20430,6 +20501,9 @@
}
}
},
"com.amazonaws.sagemaker#IntegerValue": {
"type": "integer"
},
"com.amazonaws.sagemaker#InvocationsMaxRetries": {
"type": "integer",
"traits": {
@ -20648,6 +20722,16 @@
}
}
},
"com.amazonaws.sagemaker#Key": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^.+$"
}
},
"com.amazonaws.sagemaker#KmsKeyId": {
"type": "string",
"traits": {
@ -26534,6 +26618,14 @@
}
}
},
"com.amazonaws.sagemaker#MaxParallelExecutionSteps": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1
}
}
},
"com.amazonaws.sagemaker#MaxParallelOfTests": {
"type": "integer",
"traits": {
@ -30121,13 +30213,28 @@
"smithy.api#pattern": ".*"
}
},
"com.amazonaws.sagemaker#ParallelismConfiguration": {
"type": "structure",
"members": {
"MaxParallelExecutionSteps": {
"target": "com.amazonaws.sagemaker#MaxParallelExecutionSteps",
"traits": {
"smithy.api#documentation": "<p>The max number of steps that can be executed in parallel. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Configuration that controls the parallelism of the pipeline. \n By default, the parallelism configuration specified applies to all \n executions of the pipeline unless overridden.</p>"
}
},
"com.amazonaws.sagemaker#Parameter": {
"type": "structure",
"members": {
"Name": {
"target": "com.amazonaws.sagemaker#PipelineParameterName",
"traits": {
"smithy.api#documentation": "<p>The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.</p>",
"smithy.api#documentation": "<p>The name of the parameter to assign a value to. This \n parameter name must match a named parameter in the \n pipeline definition.</p>",
"smithy.api#required": {}
}
},
@ -30537,6 +30644,12 @@
"LastModifiedBy": {
"target": "com.amazonaws.sagemaker#UserContext"
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>The parallelism configuration applied to the pipeline.</p>"
}
},
"Tags": {
"target": "com.amazonaws.sagemaker#TagList",
"traits": {
@ -30568,6 +30681,34 @@
"smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$"
}
},
"com.amazonaws.sagemaker#PipelineDefinitionS3Location": {
"type": "structure",
"members": {
"Bucket": {
"target": "com.amazonaws.sagemaker#BucketName",
"traits": {
"smithy.api#documentation": "<p>Name of the S3 bucket.</p>",
"smithy.api#required": {}
}
},
"ObjectKey": {
"target": "com.amazonaws.sagemaker#Key",
"traits": {
"smithy.api#documentation": "<p>The object key (or key name) uniquely identifies the \n object in an S3 bucket. </p>",
"smithy.api#required": {}
}
},
"VersionId": {
"target": "com.amazonaws.sagemaker#VersionId",
"traits": {
"smithy.api#documentation": "<p>Version Id of the pipeline definition file. If not specified, Amazon SageMaker \n will retrieve the latest version.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The location of the pipeline definition stored in Amazon S3.</p>"
}
},
"com.amazonaws.sagemaker#PipelineDescription": {
"type": "string",
"traits": {
@ -30638,6 +30779,12 @@
"LastModifiedBy": {
"target": "com.amazonaws.sagemaker#UserContext"
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>The parallelism configuration applied to the pipeline execution.</p>"
}
},
"PipelineParameters": {
"target": "com.amazonaws.sagemaker#ParameterList",
"traits": {
@ -30725,6 +30872,18 @@
"smithy.api#documentation": "<p>The name of the step that is executed.</p>"
}
},
"StepDisplayName": {
"target": "com.amazonaws.sagemaker#StepDisplayName",
"traits": {
"smithy.api#documentation": "<p>The display name of the step.</p>"
}
},
"StepDescription": {
"target": "com.amazonaws.sagemaker#StepDescription",
"traits": {
"smithy.api#documentation": "<p>The description of the step.</p>"
}
},
"StartTime": {
"target": "com.amazonaws.sagemaker#Timestamp",
"traits": {
@ -30749,6 +30908,12 @@
"smithy.api#documentation": "<p>If this pipeline execution step was cached, details on the cache hit.</p>"
}
},
"AttemptCount": {
"target": "com.amazonaws.sagemaker#IntegerValue",
"traits": {
"smithy.api#documentation": "<p>The current attempt of the execution step. For more information, see <a href=\"https://docs.aws.amazon.com/https:/docs.aws.amazon.com/sagemaker/latest/dg/pipelines-retry-policy.html\">Retry Policy for Amazon SageMaker Pipelines steps</a>.</p>"
}
},
"FailureReason": {
"target": "com.amazonaws.sagemaker#FailureReason",
"traits": {
@ -30846,6 +31011,12 @@
"traits": {
"smithy.api#documentation": "<p>Container for the metadata for a Clarify check step. The configurations \n and outcomes of the check step execution. This includes: </p>\n <ul>\n <li>\n <p>The type of the check conducted,</p>\n </li>\n <li>\n <p>The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.</p>\n </li>\n <li>\n <p>The Amazon S3 URIs of newly calculated baseline constraints and statistics.</p>\n </li>\n <li>\n <p>The model package group name provided.</p>\n </li>\n <li>\n <p>The Amazon S3 URI of the violation report if violations detected.</p>\n </li>\n <li>\n <p>The Amazon Resource Name (ARN) of check processing job initiated by the step execution.</p>\n </li>\n <li>\n <p>The boolean flags indicating if the drift check is skipped.</p>\n </li>\n <li>\n <p>If step property <code>BaselineUsedForDriftCheck</code> is set the same as \n <code>CalculatedBaseline</code>.</p>\n </li>\n </ul>"
}
},
"EMR": {
"target": "com.amazonaws.sagemaker#EMRStepMetadata",
"traits": {
"smithy.api#documentation": "<p>The configurations and outcomes of an EMR step execution.</p>"
}
}
},
"traits": {
@ -34324,6 +34495,12 @@
"smithy.api#idempotencyToken": {},
"smithy.api#required": {}
}
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline.</p>"
}
}
}
},
@ -36427,6 +36604,12 @@
"smithy.api#idempotencyToken": {},
"smithy.api#required": {}
}
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.</p>"
}
}
}
},
@ -36454,7 +36637,17 @@
"com.amazonaws.sagemaker#StatusMessage": {
"type": "string"
},
"com.amazonaws.sagemaker#StepName": {
"com.amazonaws.sagemaker#StepDescription": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 3072
},
"smithy.api#pattern": ".*"
}
},
"com.amazonaws.sagemaker#StepDisplayName": {
"type": "string",
"traits": {
"smithy.api#length": {
@ -36464,6 +36657,16 @@
"smithy.api#pattern": ".*"
}
},
"com.amazonaws.sagemaker#StepName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 64
},
"smithy.api#pattern": "^[A-Za-z0-9\\-_]*$"
}
},
"com.amazonaws.sagemaker#StepStatus": {
"type": "string",
"traits": {
@ -36707,7 +36910,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Stops a pipeline execution.</p>\n\n <p>\n <b>Callback Step</b>\n </p>\n <p>A pipeline execution won't stop while a callback step is running.\n When you call <code>StopPipelineExecution</code>\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".</p>\n <p>You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n <code>SendPipelineExecutionStepSuccess</code> or\n <code>SendPipelineExecutionStepFailure</code>.</p>\n <p>Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.</p>\n\n <p>\n <b>Lambda Step</b>\n </p>\n <p>A pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is <code>Stopped</code>. If the timeout is hit\n the pipeline execution status is <code>Failed</code>.</p>"
"smithy.api#documentation": "<p>Stops a pipeline execution.</p>\n\n <p>\n <b>Callback Step</b>\n </p>\n <p>A pipeline execution won't stop while a callback step is running.\n When you call <code>StopPipelineExecution</code>\n on a pipeline execution with a running callback step, Amazon SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".</p>\n <p>You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n <code>SendPipelineExecutionStepSuccess</code> or\n <code>SendPipelineExecutionStepFailure</code>.</p>\n <p>Only when Amazon SageMaker Pipelines receives one of these calls will it stop the pipeline execution.</p>\n\n <p>\n <b>Lambda Step</b>\n </p>\n <p>A pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is <code>Stopped</code>. If the timeout is hit\n the pipeline execution status is <code>Failed</code>.</p>"
}
},
"com.amazonaws.sagemaker#StopPipelineExecutionRequest": {
@ -36804,7 +37007,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Stops a transform job.</p>\n <p>When Amazon SageMaker receives a <code>StopTransformJob</code> request, the status of the job\n changes to <code>Stopping</code>. After Amazon SageMaker\n stops\n the job, the status is set to <code>Stopped</code>. When you stop a transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.</p>"
"smithy.api#documentation": "<p>Stops a batch transform job.</p>\n <p>When Amazon SageMaker receives a <code>StopTransformJob</code> request, the status of the job\n changes to <code>Stopping</code>. After Amazon SageMaker\n stops\n the job, the status is set to <code>Stopped</code>. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.</p>"
}
},
"com.amazonaws.sagemaker#StopTransformJobRequest": {
@ -36813,7 +37016,7 @@
"TransformJobName": {
"target": "com.amazonaws.sagemaker#TransformJobName",
"traits": {
"smithy.api#documentation": "<p>The name of the transform job to stop.</p>",
"smithy.api#documentation": "<p>The name of the batch transform job to stop.</p>",
"smithy.api#required": {}
}
}
@ -37311,6 +37514,10 @@
"value": "sitara_am57x",
"name": "SITARA_AM57X"
},
{
"value": "amba_cv2",
"name": "AMBA_CV2"
},
{
"value": "amba_cv22",
"name": "AMBA_CV22"
@ -37926,6 +38133,38 @@
{
"value": "ml.c5n.18xlarge",
"name": "ML_C5N_18XLARGE"
},
{
"value": "ml.g5.xlarge",
"name": "ML_G5_XLARGE"
},
{
"value": "ml.g5.2xlarge",
"name": "ML_G5_2XLARGE"
},
{
"value": "ml.g5.4xlarge",
"name": "ML_G5_4XLARGE"
},
{
"value": "ml.g5.8xlarge",
"name": "ML_G5_8XLARGE"
},
{
"value": "ml.g5.16xlarge",
"name": "ML_G5_16XLARGE"
},
{
"value": "ml.g5.12xlarge",
"name": "ML_G5_12XLARGE"
},
{
"value": "ml.g5.24xlarge",
"name": "ML_G5_24XLARGE"
},
{
"value": "ml.g5.48xlarge",
"name": "ML_G5_48XLARGE"
}
]
}
@ -40860,6 +41099,12 @@
"traits": {
"smithy.api#documentation": "<p>The display name of the pipeline execution.</p>"
}
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.</p>"
}
}
}
},
@ -40896,6 +41141,12 @@
"smithy.api#documentation": "<p>The JSON pipeline definition.</p>"
}
},
"PipelineDefinitionS3Location": {
"target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location",
"traits": {
"smithy.api#documentation": "<p>The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.</p>"
}
},
"PipelineDescription": {
"target": "com.amazonaws.sagemaker#PipelineDescription",
"traits": {
@ -40907,6 +41158,12 @@
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>"
}
},
"ParallelismConfiguration": {
"target": "com.amazonaws.sagemaker#ParallelismConfiguration",
"traits": {
"smithy.api#documentation": "<p>If specified, it applies to all executions of this pipeline by default.</p>"
}
}
}
},
@ -41653,6 +41910,16 @@
}
}
},
"com.amazonaws.sagemaker#VersionId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^.+$"
}
},
"com.amazonaws.sagemaker#VersionedArnOrName": {
"type": "string",
"traits": {

34
aws/sdk/aws-models/savingsplans.json
View File

@ -31,6 +31,21 @@
"shapes": {
"com.amazonaws.savingsplans#AWSSavingsPlan": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "savingsplans",
"arnNamespace": "savingsplans",
"cloudFormationName": "Savingsplans",
"cloudTrailEventSource": "savingsplans.amazonaws.com",
"endpointPrefix": "savingsplans"
},
"aws.auth#sigv4": {
"name": "savingsplans"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>Savings Plans are a pricing model that offer significant savings on AWS usage (for\n example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD\n per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For\n more information, see the <a href=\"https://docs.aws.amazon.com/savingsplans/latest/userguide/\">AWS Savings Plans User Guide</a>.</p>",
"smithy.api#title": "AWS Savings Plans"
},
"version": "2019-06-28",
"operations": [
{
@ -60,22 +75,7 @@
{
"target": "com.amazonaws.savingsplans#UntagResource"
}
],
"traits": {
"aws.api#service": {
"sdkId": "savingsplans",
"arnNamespace": "savingsplans",
"cloudFormationName": "Savingsplans",
"cloudTrailEventSource": "savingsplans.amazonaws.com",
"endpointPrefix": "savingsplans"
},
"aws.auth#sigv4": {
"name": "savingsplans"
},
"aws.protocols#restJson1": {},
"smithy.api#documentation": "<p>Savings Plans are a pricing model that offer significant savings on AWS usage (for\n example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD\n per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For\n more information, see the <a href=\"https://docs.aws.amazon.com/savingsplans/latest/userguide/\">AWS Savings Plans User Guide</a>.</p>",
"smithy.api#title": "AWS Savings Plans"
}
]
},
"com.amazonaws.savingsplans#Amount": {
"type": "string"
@ -127,7 +127,7 @@
"commitment": {
"target": "com.amazonaws.savingsplans#Amount",
"traits": {
"smithy.api#documentation": "<p>The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more\n than three digits after the decimal point.</p>",
"smithy.api#documentation": "<p>The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more\n than five digits after the decimal point.</p>",
"smithy.api#required": {}
}
},

364
aws/sdk/aws-models/secretsmanager.json
View File

File diff suppressed because one or more lines are too long

1146
aws/sdk/aws-models/securityhub.json
View File

File diff suppressed because it is too large Load Diff

132
aws/sdk/aws-models/sms.json
View File

@ -31,6 +31,24 @@
"shapes": {
"com.amazonaws.sms#AWSServerMigrationService_V2016_10_24": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "SMS",
"arnNamespace": "sms",
"cloudFormationName": "SMS",
"cloudTrailEventSource": "sms.amazonaws.com",
"endpointPrefix": "sms"
},
"aws.auth#sigv4": {
"name": "sms"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<important>\n <p>\n <b>Product update</b>\n </p>\n <p>As of March 31, 2022, Amazon Web Services will discontinue Server Migration Service (Amazon Web Services SMS).\n Going forward, we recommend <a href=\"http://aws.amazon.com/application-migration-service\">Amazon Web Services Application Migration Service</a> (Amazon Web Services MGN) as the primary migration\n service for lift-and-shift migrations.</p>\n <p>You can initiate new migration jobs in Server Migration Service until January 1, 2022.\n Complete these active migration projects by March 31, 2022. For more information, see\n <a href=\"http://aws.amazon.com/application-migration-service/when-to-choose-aws-mgn/\">When\n to Choose AWS Application Migration Service</a>.</p>\n </important>\n \n <p>Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your\n on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following \n resources:</p>\n <ul>\n <li>\n <p>\n <a href=\"http://aws.amazon.com/server-migration-service/\">Server Migration Service\n product page</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/server-migration-service/latest/userguide/\">Server Migration Service User Guide</a>\n </p>\n </li>\n </ul>",
"smithy.api#title": "AWS Server Migration Service",
"smithy.api#xmlNamespace": {
"uri": "http://ec2.amazon.com/servermigration/2016-10-24/"
}
},
"version": "2016-10-24",
"operations": [
{
@ -138,25 +156,7 @@
{
"target": "com.amazonaws.sms#UpdateReplicationJob"
}
],
"traits": {
"aws.api#service": {
"sdkId": "SMS",
"arnNamespace": "sms",
"cloudFormationName": "SMS",
"cloudTrailEventSource": "sms.amazonaws.com",
"endpointPrefix": "sms"
},
"aws.auth#sigv4": {
"name": "sms"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<fullname>AWS Server Migration Service</fullname>\n <p>AWS Server Migration Service (AWS SMS) makes it easier and faster for you to migrate your\n on-premises workloads to AWS. To learn more about AWS SMS, see the following \n resources:</p>\n <ul>\n <li>\n <p>\n <a href=\"http://aws.amazon.com/server-migration-service/\">AWS Server Migration Service\n product page</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/server-migration-service/latest/userguide/\">AWS Server Migration Service User Guide</a>\n </p>\n </li>\n </ul>",
"smithy.api#title": "AWS Server Migration Service",
"smithy.api#xmlNamespace": {
"uri": "http://ec2.amazon.com/servermigration/2016-10-24/"
}
}
]
},
"com.amazonaws.sms#AmiId": {
"type": "string"
@ -492,7 +492,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of the service role in the customer's account used by AWS SMS.</p>"
"smithy.api#documentation": "<p>The name of the service role in the customer's account used by Server Migration Service.</p>"
}
},
"totalServerGroups": {
@ -789,7 +789,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of the service role in the customer's account to be used by AWS SMS.</p>"
"smithy.api#documentation": "<p>The name of the service role in the customer's account to be used by Server Migration Service.</p>"
}
},
"clientToken": {
@ -873,7 +873,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a replication job. The replication job schedules periodic replication runs\n to replicate your server to AWS. Each replication run creates an Amazon Machine Image\n (AMI).</p>"
"smithy.api#documentation": "<p>Creates a replication job. The replication job schedules periodic replication runs\n to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image\n (AMI).</p>"
}
},
"com.amazonaws.sms#CreateReplicationJobRequest": {
@ -914,7 +914,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of the IAM role to be used by the AWS SMS.</p>"
"smithy.api#documentation": "<p>The name of the IAM role to be used by the Server Migration Service.</p>"
}
},
"description": {
@ -980,7 +980,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified application. Optionally deletes the launched stack associated with\n the application and all AWS SMS replication jobs for servers in the application.</p>"
"smithy.api#documentation": "<p>Deletes the specified application. Optionally deletes the launched stack associated with\n the application and all Server Migration Service replication jobs for servers in the application.</p>"
}
},
"com.amazonaws.sms#DeleteAppLaunchConfiguration": {
@ -1169,7 +1169,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the specified replication job.</p>\n <p>After you delete a replication job, there are no further replication runs. AWS\n deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created\n by the replication runs are not deleted.</p>"
"smithy.api#documentation": "<p>Deletes the specified replication job.</p>\n <p>After you delete a replication job, there are no further replication runs. Amazon Web Services\n deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created\n by the replication runs are not deleted.</p>"
}
},
"com.amazonaws.sms#DeleteReplicationJobRequest": {
@ -1248,7 +1248,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Disassociates the specified connector from AWS SMS.</p>\n <p>After you disassociate a connector, it is no longer available to support\n replication jobs.</p>"
"smithy.api#documentation": "<p>Disassociates the specified connector from Server Migration Service.</p>\n <p>After you disassociate a connector, it is no longer available to support\n replication jobs.</p>"
}
},
"com.amazonaws.sms#DisassociateConnectorRequest": {
@ -1275,6 +1275,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "DryRunOperationException",
"httpResponseCode": 412
},
"smithy.api#documentation": "<p>The user has the required permissions, so the request would have succeeded, \n but a dry run was performed.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 412
@ -1402,7 +1406,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Generates an AWS CloudFormation template based on the current launch configuration and writes it to\n an Amazon S3 object in the customer’s Amazon S3 bucket.</p>"
"smithy.api#documentation": "<p>Generates an CloudFormation template based on the current launch configuration and writes it to\n an Amazon S3 object in the customer’s Amazon S3 bucket.</p>"
}
},
"com.amazonaws.sms#GenerateTemplateRequest": {
@ -1411,13 +1415,13 @@
"appId": {
"target": "com.amazonaws.sms#AppId",
"traits": {
"smithy.api#documentation": "<p>The ID of the application associated with the AWS CloudFormation template.</p>"
"smithy.api#documentation": "<p>The ID of the application associated with the CloudFormation template.</p>"
}
},
"templateFormat": {
"target": "com.amazonaws.sms#OutputFormat",
"traits": {
"smithy.api#documentation": "<p>The format for generating the AWS CloudFormation template.</p>"
"smithy.api#documentation": "<p>The format for generating the CloudFormation template.</p>"
}
}
}
@ -1514,7 +1518,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of the service role in the customer's account that AWS CloudFormation uses to launch the\n application.</p>"
"smithy.api#documentation": "<p>The name of the service role in the customer's account that CloudFormation uses to launch the\n application.</p>"
}
},
"autoLaunch": {
@ -1740,7 +1744,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Describes the connectors registered with the AWS SMS.</p>",
"smithy.api#documentation": "<p>Describes the connectors registered with the Server Migration Service.</p>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
@ -2038,7 +2042,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Allows application import from AWS Migration Hub.</p>"
"smithy.api#documentation": "<p>Allows application import from Migration Hub.</p>"
}
},
"com.amazonaws.sms#ImportAppCatalogRequest": {
@ -2047,7 +2051,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of the service role. If you omit this parameter, we create a service-linked role\n for AWS Migration Hub in your account. Otherwise, the role that you provide must have the <a href=\"https://docs.aws.amazon.com/migrationhub/latest/ug/new-customer-setup.html#sms-managed\">policy\n and trust policy</a> described in the <i>AWS Migration Hub User Guide</i>.</p>"
"smithy.api#documentation": "<p>The name of the service role. If you omit this parameter, we create a service-linked role\n for Migration Hub in your account. Otherwise, the role that you provide must have the <a href=\"https://docs.aws.amazon.com/migrationhub/latest/ug/new-customer-setup.html#sms-managed\">policy\n and trust policy</a> described in the <i>Migration Hub User Guide</i>.</p>"
}
}
}
@ -2099,7 +2103,7 @@
"com.amazonaws.sms#InstanceId": {
"type": "string",
"traits": {
"smithy.api#pattern": "(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)"
"smithy.api#pattern": "^(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)$"
}
},
"com.amazonaws.sms#InstanceType": {
@ -2113,6 +2117,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "InternalError",
"httpResponseCode": 500
},
"smithy.api#documentation": "<p>An internal error occurred.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500
@ -2126,6 +2134,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "InvalidParameter",
"httpResponseCode": 400
},
"smithy.api#documentation": "<p>A specified parameter is not valid.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
@ -2163,7 +2175,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Launches the specified application as a stack in AWS CloudFormation.</p>"
"smithy.api#documentation": "<p>Launches the specified application as a stack in CloudFormation.</p>"
}
},
"com.amazonaws.sms#LaunchAppRequest": {
@ -2317,6 +2329,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "MissingRequiredParameter",
"httpResponseCode": 400
},
"smithy.api#documentation": "<p>A required parameter is missing.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
@ -2333,6 +2349,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "NoConnectorsAvailable",
"httpResponseCode": 430
},
"smithy.api#documentation": "<p>There are no connectors available.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 430
@ -2400,7 +2420,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Provides information to AWS SMS about whether application validation is successful.</p>"
"smithy.api#documentation": "<p>Provides information to Server Migration Service about whether application validation is successful.</p>"
}
},
"com.amazonaws.sms#NotifyAppValidationOutputRequest": {
@ -2439,6 +2459,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "OperationNotPermitted",
"httpResponseCode": 403
},
"smithy.api#documentation": "<p>This operation is not allowed.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
@ -2500,7 +2524,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of service role in the customer's account that AWS CloudFormation uses to launch the\n application.</p>"
"smithy.api#documentation": "<p>The name of service role in the customer's account that CloudFormation uses to launch the\n application.</p>"
}
},
"autoLaunch": {
@ -2688,7 +2712,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of the IAM role to be used by AWS SMS.</p>"
"smithy.api#documentation": "<p>The name of the IAM role to be used by Server Migration Service.</p>"
}
},
"latestAmiId": {
@ -2752,6 +2776,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "ReplicationJobAlreadyExists",
"httpResponseCode": 400
},
"smithy.api#documentation": "<p>The specified replication job already exists.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
@ -2777,6 +2805,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "ReplicationJobNotFound",
"httpResponseCode": 404
},
"smithy.api#documentation": "<p>The specified replication job does not exist.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 404
@ -2915,6 +2947,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "ReplicationRunLimitExceeded",
"httpResponseCode": 429
},
"smithy.api#documentation": "<p>You have exceeded the number of on-demand replication runs you can request in a\n 24-hour period.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 429
@ -3090,7 +3126,7 @@
"command": {
"target": "com.amazonaws.sms#Command",
"traits": {
"smithy.api#documentation": "<p>The command to run the validation script</p>"
"smithy.api#documentation": "<p>The command to run the validation script.</p>"
}
},
"executionTimeoutSeconds": {
@ -3174,6 +3210,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "ServerCannotBeReplicated",
"httpResponseCode": 400
},
"smithy.api#documentation": "<p>The specified server cannot be replicated.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
@ -3343,7 +3383,7 @@
"logicalId": {
"target": "com.amazonaws.sms#LogicalId",
"traits": {
"smithy.api#documentation": "<p>The logical ID of the server in the AWS CloudFormation template.</p>"
"smithy.api#documentation": "<p>The logical ID of the server in the CloudFormation template.</p>"
}
},
"vpc": {
@ -3829,6 +3869,10 @@
"type": "structure",
"members": {},
"traits": {
"aws.protocols#awsQueryError": {
"code": "TemporarilyUnavailable",
"httpResponseCode": 503
},
"smithy.api#documentation": "<p>The service is temporarily unavailable.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 503
@ -3901,6 +3945,10 @@
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "UnauthorizedOperation",
"httpResponseCode": 403
},
"smithy.api#documentation": "<p>You lack permissions needed to perform this operation. Check your IAM policies,\n and ensure that you are using the correct access keys.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
@ -3959,7 +4007,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of the service role in the customer's account used by AWS SMS.</p>"
"smithy.api#documentation": "<p>The name of the service role in the customer's account used by Server Migration Service.</p>"
}
},
"serverGroups": {
@ -4068,7 +4116,7 @@
"roleName": {
"target": "com.amazonaws.sms#RoleName",
"traits": {
"smithy.api#documentation": "<p>The name of the IAM role to be used by AWS SMS.</p>"
"smithy.api#documentation": "<p>The name of the IAM role to be used by Server Migration Service.</p>"
}
},
"description": {

12
aws/sdk/aws-models/snowball.json
View File

@ -539,7 +539,10 @@
"type": "structure",
"members": {
"ConflictResource": {
"target": "com.amazonaws.snowball#String"
"target": "com.amazonaws.snowball#String",
"traits": {
"smithy.api#documentation": "<p>You get this resource when you call <code>CreateReturnShippingLabel</code> more than once when other requests are not completed. .</p>"
}
},
"Message": {
"target": "com.amazonaws.snowball#String"
@ -1343,6 +1346,10 @@
"com.amazonaws.snowball#GSTIN": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 15,
"max": 15
},
"smithy.api#pattern": "^\\d{2}[A-Z]{5}\\d{4}[A-Z]{1}[A-Z\\d]{1}[Z]{1}[A-Z\\d]{1}$"
}
},
@ -2783,7 +2790,8 @@
"smithy.api#length": {
"min": 1,
"max": 1024
}
},
"smithy.api#pattern": ".*"
}
},
"com.amazonaws.snowball#TGWOnDeviceServiceConfiguration": {

148
aws/sdk/aws-models/support.json
View File

@ -31,6 +31,24 @@
"shapes": {
"com.amazonaws.support#AWSSupport_20130415": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "Support",
"arnNamespace": "support",
"cloudFormationName": "Support",
"cloudTrailEventSource": "support.amazonaws.com",
"endpointPrefix": "support"
},
"aws.auth#sigv4": {
"name": "support"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<fullname>Amazon Web Services Support</fullname>\n <p>The <i>Amazon Web Services Support API Reference</i> is intended for programmers who need detailed\n information about the Amazon Web Services Support operations and data types. You can use the API to manage\n your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return\n results in JSON format.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>\n <p>The Amazon Web Services Support service also exposes a set of <a href=\"http://aws.amazon.com/premiumsupport/trustedadvisor/\">Trusted Advisor</a> features. You can\n retrieve a list of checks and their descriptions, get check results, specify checks to\n refresh, and get the refresh status of checks.</p>\n <p>The following list describes the Amazon Web Services Support case management operations:</p>\n <ul>\n <li>\n <p> Service names, issue categories, and available severity levels - The\n <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return Amazon Web Services service names,\n service codes, service categories, and problem severity levels. You use these\n values when you call the <a>CreateCase</a> operation.</p>\n </li>\n <li>\n <p> Case creation, case details, and case resolution - The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations\n create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.</p>\n </li>\n <li>\n <p> Case communication - The <a>DescribeCommunications</a>,\n <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications\n and attachments to Amazon Web Services Support cases.</p>\n </li>\n </ul>\n <p>The following list describes the operations available from the Amazon Web Services Support service for\n Trusted Advisor:</p>\n <ul>\n <li>\n <p>\n <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that\n run against your Amazon Web Services resources.</p>\n </li>\n <li>\n <p>Using the <code>checkId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the\n check that you specified.</p>\n </li>\n <li>\n <p>\n <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized\n results for one or more Trusted Advisor checks.</p>\n </li>\n <li>\n <p>\n <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a\n specified check.</p>\n </li>\n <li>\n <p>\n <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh\n status of one or more checks.</p>\n </li>\n </ul>\n <p>For authentication of requests, Amazon Web Services Support uses <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing\n Process</a>.</p>\n <p>See <a href=\"https://docs.aws.amazon.com/awssupport/latest/user/Welcome.html\">About the\n Amazon Web Services Support API</a> in the <i>Amazon Web Services Support User Guide</i> for\n information about how to use this service to create and manage your support cases, and\n how to call Trusted Advisor for results of checks on your resources.</p>",
"smithy.api#title": "AWS Support",
"smithy.api#xmlNamespace": {
"uri": "http://support.amazonaws.com/doc/2013-04-15/"
}
},
"version": "2013-04-15",
"operations": [
{
@ -75,25 +93,7 @@
{
"target": "com.amazonaws.support#ResolveCase"
}
],
"traits": {
"aws.api#service": {
"sdkId": "Support",
"arnNamespace": "support",
"cloudFormationName": "Support",
"cloudTrailEventSource": "support.amazonaws.com",
"endpointPrefix": "support"
},
"aws.auth#sigv4": {
"name": "support"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<fullname>AWS Support</fullname>\n <p>The <i>AWS Support API Reference</i> is intended for programmers who need detailed\n information about the AWS Support operations and data types. You can use the API to manage\n your support cases programmatically. The AWS Support API uses HTTP methods that return\n results in JSON format.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>\n <p>The AWS Support service also exposes a set of <a href=\"http://aws.amazon.com/premiumsupport/trustedadvisor/\">AWS Trusted Advisor</a> features. You can\n retrieve a list of checks and their descriptions, get check results, specify checks to\n refresh, and get the refresh status of checks.</p>\n <p>The following list describes the AWS Support case management operations:</p>\n <ul>\n <li>\n <p> Service names, issue categories, and available severity levels - The\n <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return AWS service names,\n service codes, service categories, and problem severity levels. You use these\n values when you call the <a>CreateCase</a> operation.</p>\n </li>\n <li>\n <p> Case creation, case details, and case resolution - The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations\n create AWS Support cases, retrieve information about cases, and resolve cases.</p>\n </li>\n <li>\n <p> Case communication - The <a>DescribeCommunications</a>,\n <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications\n and attachments to AWS Support cases.</p>\n </li>\n </ul>\n <p>The following list describes the operations available from the AWS Support service for\n Trusted Advisor:</p>\n <ul>\n <li>\n <p>\n <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that\n run against your AWS resources.</p>\n </li>\n <li>\n <p>Using the <code>checkId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the\n check that you specified.</p>\n </li>\n <li>\n <p>\n <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized\n results for one or more Trusted Advisor checks.</p>\n </li>\n <li>\n <p>\n <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a\n specified check.</p>\n </li>\n <li>\n <p>\n <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh\n status of one or more checks.</p>\n </li>\n </ul>\n <p>For authentication of requests, AWS Support uses <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing\n Process</a>.</p>\n <p>See <a href=\"https://docs.aws.amazon.com/awssupport/latest/user/Welcome.html\">About the\n AWS Support API</a> in the <i>AWS Support User Guide</i> for\n information about how to use this service to create and manage your support cases, and\n how to call Trusted Advisor for results of checks on your resources.</p>",
"smithy.api#title": "AWS Support",
"smithy.api#xmlNamespace": {
"uri": "http://support.amazonaws.com/doc/2013-04-15/"
}
}
]
},
"com.amazonaws.support#AddAttachmentsToSet": {
"type": "operation",
@ -121,7 +121,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Adds one or more attachments to an attachment set. </p>\n <p>An attachment set is a temporary container for attachments that you add to a case or\n case communication. The set is available for 1 hour after it's created. The\n <code>expiryTime</code> returned in the response is when the set expires. </p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Adds one or more attachments to an attachment set. </p>\n <p>An attachment set is a temporary container for attachments that you add to a case or\n case communication. The set is available for 1 hour after it's created. The\n <code>expiryTime</code> returned in the response is when the set expires. </p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#AddAttachmentsToSetRequest": {
@ -185,7 +185,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Adds additional customer communication to an AWS Support case. Use the <code>caseId</code>\n parameter to identify the case to which to add communication. You can list a set of\n email addresses to copy on the communication by using the <code>ccEmailAddresses</code>\n parameter. The <code>communicationBody</code> value contains the text of the\n communication.</p>\n \n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Adds additional customer communication to an Amazon Web Services Support case. Use the <code>caseId</code>\n parameter to identify the case to which to add communication. You can list a set of\n email addresses to copy on the communication by using the <code>ccEmailAddresses</code>\n parameter. The <code>communicationBody</code> value contains the text of the\n communication.</p>\n \n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#AddCommunicationToCaseRequest": {
@ -401,13 +401,13 @@
"displayId": {
"target": "com.amazonaws.support#DisplayId",
"traits": {
"smithy.api#documentation": "<p>The ID displayed for the case in the AWS Support Center. This is a numeric\n string.</p>"
"smithy.api#documentation": "<p>The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric\n string.</p>"
}
},
"subject": {
"target": "com.amazonaws.support#Subject",
"traits": {
"smithy.api#documentation": "<p>The subject line for the case in the AWS Support Center.</p>"
"smithy.api#documentation": "<p>The subject line for the case in the Amazon Web Services Support Center.</p>"
}
},
"status": {
@ -419,7 +419,7 @@
"serviceCode": {
"target": "com.amazonaws.support#ServiceCode",
"traits": {
"smithy.api#documentation": "<p>The code for the AWS service. You can get a list of codes and the corresponding\n service names by calling <a>DescribeServices</a>.</p>"
"smithy.api#documentation": "<p>The code for the Amazon Web Services service. You can get a list of codes and the corresponding\n service names by calling <a>DescribeServices</a>.</p>"
}
},
"categoryCode": {
@ -443,13 +443,13 @@
"timeCreated": {
"target": "com.amazonaws.support#TimeCreated",
"traits": {
"smithy.api#documentation": "<p>The time that the case was created in the AWS Support Center.</p>"
"smithy.api#documentation": "<p>The time that the case was created in the Amazon Web Services Support Center.</p>"
}
},
"recentCommunications": {
"target": "com.amazonaws.support#RecentCaseCommunications",
"traits": {
"smithy.api#documentation": "<p>The five most recent communications between you and AWS Support Center, including the\n IDs of any attachments to the communications. Also includes a <code>nextToken</code>\n that you can use to retrieve earlier communications.</p>"
"smithy.api#documentation": "<p>The five most recent communications between you and Amazon Web Services Support Center, including the\n IDs of any attachments to the communications. Also includes a <code>nextToken</code>\n that you can use to retrieve earlier communications.</p>"
}
},
"ccEmailAddresses": {
@ -461,12 +461,12 @@
"language": {
"target": "com.amazonaws.support#Language",
"traits": {
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A JSON-formatted object that contains the metadata for a support case. It is contained\n in the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p>\n <ul>\n <li>\n <p>\n <b>caseId</b> - The support case ID requested or\n returned in the call. The case ID is an alphanumeric string formatted as shown\n in this example:\n case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>.</p>\n </li>\n <li>\n <p>\n <b>categoryCode</b> - The category of problem for the\n support case. Corresponds to the <code>CategoryCode</code> values returned by a call to\n <a>DescribeServices</a>.</p>\n </li>\n <li>\n <p>\n <b>displayId</b> - The identifier for the case on pages\n in the AWS Support Center.</p>\n </li>\n <li>\n <p>\n <b>language</b> - The ISO 639-1 code for the language\n in which AWS provides support. AWS Support currently supports English (\"en\") and\n Japanese (\"ja\"). Language parameters must be passed explicitly for operations\n that take them.</p>\n </li>\n <li>\n <p>\n <b>nextToken</b> - A resumption point for\n pagination.</p>\n </li>\n <li>\n <p>\n <b>recentCommunications</b> - One or more <a>Communication</a> objects. Fields of these objects are\n <code>attachments</code>, <code>body</code>, <code>caseId</code>,\n <code>submittedBy</code>, and <code>timeCreated</code>.</p>\n </li>\n <li>\n <p>\n <b>serviceCode</b> - The identifier for the AWS service\n that corresponds to the service code defined in the call to <a>DescribeServices</a>.</p>\n </li>\n <li>\n <p>\n <b>severityCode</b> - The severity code assigned to the\n case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>. The possible values are:\n <code>low</code>, <code>normal</code>, <code>high</code>,\n <code>urgent</code>, and <code>critical</code>.</p>\n </li>\n <li>\n <p>\n <b>status</b> - The status of the case in the AWS Support Center. Valid values:</p>\n <ul>\n <li>\n <p>\n <code>opened</code>\n </p>\n </li>\n <li>\n <p>\n <code>pending-customer-action</code>\n </p>\n </li>\n <li>\n <p>\n <code>reopened</code>\n </p>\n </li>\n <li>\n <p>\n <code>resolved</code>\n </p>\n </li>\n <li>\n <p>\n <code>unassigned</code>\n </p>\n </li>\n <li>\n <p>\n <code>work-in-progress</code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <b>subject</b> - The subject line of the case.</p>\n </li>\n <li>\n <p>\n <b>submittedBy</b> - The email address of the account\n that submitted the case.</p>\n </li>\n <li>\n <p>\n <b>timeCreated</b> - The time the case was created, in\n ISO-8601 format.</p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>A JSON-formatted object that contains the metadata for a support case. It is contained\n in the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p>\n <ul>\n <li>\n <p>\n <b>caseId</b> - The support case ID requested or\n returned in the call. The case ID is an alphanumeric string formatted as shown\n in this example:\n case-<i>12345678910-2013-c4c1d2bf33c5cf47</i>.</p>\n </li>\n <li>\n <p>\n <b>categoryCode</b> - The category of problem for the\n support case. Corresponds to the <code>CategoryCode</code> values returned by a call to\n <a>DescribeServices</a>.</p>\n </li>\n <li>\n <p>\n <b>displayId</b> - The identifier for the case on pages\n in the Amazon Web Services Support Center.</p>\n </li>\n <li>\n <p>\n <b>language</b> - The ISO 639-1 code for the language\n in which Amazon Web Services provides support. Amazon Web Services Support currently supports English (\"en\") and\n Japanese (\"ja\"). Language parameters must be passed explicitly for operations\n that take them.</p>\n </li>\n <li>\n <p>\n <b>nextToken</b> - A resumption point for\n pagination.</p>\n </li>\n <li>\n <p>\n <b>recentCommunications</b> - One or more <a>Communication</a> objects. Fields of these objects are\n <code>attachments</code>, <code>body</code>, <code>caseId</code>,\n <code>submittedBy</code>, and <code>timeCreated</code>.</p>\n </li>\n <li>\n <p>\n <b>serviceCode</b> - The identifier for the Amazon Web Services service\n that corresponds to the service code defined in the call to <a>DescribeServices</a>.</p>\n </li>\n <li>\n <p>\n <b>severityCode</b> - The severity code assigned to the\n case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>. The possible values are:\n <code>low</code>, <code>normal</code>, <code>high</code>,\n <code>urgent</code>, and <code>critical</code>.</p>\n </li>\n <li>\n <p>\n <b>status</b> - The status of the case in the Amazon Web Services Support Center. Valid values:</p>\n <ul>\n <li>\n <p>\n <code>opened</code>\n </p>\n </li>\n <li>\n <p>\n <code>pending-customer-action</code>\n </p>\n </li>\n <li>\n <p>\n <code>reopened</code>\n </p>\n </li>\n <li>\n <p>\n <code>resolved</code>\n </p>\n </li>\n <li>\n <p>\n <code>unassigned</code>\n </p>\n </li>\n <li>\n <p>\n <code>work-in-progress</code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <b>subject</b> - The subject line of the case.</p>\n </li>\n <li>\n <p>\n <b>submittedBy</b> - The email address of the account\n that submitted the case.</p>\n </li>\n <li>\n <p>\n <b>timeCreated</b> - The time the case was created, in\n ISO-8601 format.</p>\n </li>\n </ul>"
}
},
"com.amazonaws.support#CaseId": {
@ -525,7 +525,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>A JSON-formatted name/value pair that represents the category name and category code\n of the problem, selected from the <a>DescribeServices</a> response for each\n AWS service.</p>"
"smithy.api#documentation": "<p>A JSON-formatted name/value pair that represents the category name and category code\n of the problem, selected from the <a>DescribeServices</a> response for each\n Amazon Web Services service.</p>"
}
},
"com.amazonaws.support#CategoryCode": {
@ -561,13 +561,13 @@
"body": {
"target": "com.amazonaws.support#CommunicationBody",
"traits": {
"smithy.api#documentation": "<p>The text of the communication between the customer and AWS Support.</p>"
"smithy.api#documentation": "<p>The text of the communication between the customer and Amazon Web Services Support.</p>"
}
},
"submittedBy": {
"target": "com.amazonaws.support#SubmittedBy",
"traits": {
"smithy.api#documentation": "<p>The identity of the account that submitted, or responded to, the support case.\n Customer entries include the role or IAM user as well as the email address. For example,\n \"AdminRole (Role) <janedoe@example.com>. Entries from the AWS Support team display\n \"Amazon Web Services,\" and don't show an email address.\n </p>"
"smithy.api#documentation": "<p>The identity of the account that submitted, or responded to, the support case.\n Customer entries include the role or IAM user as well as the email address. For example,\n \"AdminRole (Role) <janedoe@example.com>. Entries from the Amazon Web Services Support team display\n \"Amazon Web Services,\" and don't show an email address.\n </p>"
}
},
"timeCreated": {
@ -619,7 +619,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a case in the AWS Support Center. This operation is similar to how you create a case\n in the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create\n Case</a> page.</p>\n <p>The AWS Support API doesn't support requesting service limit increases. You can submit a\n service limit increase in the following ways: </p>\n <ul>\n <li>\n <p>Submit a request from the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</p>\n </li>\n <li>\n <p>Use the Service Quotas <a href=\"https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html\">RequestServiceQuotaIncrease</a> operation.</p>\n </li>\n </ul>\n <p>A successful <code>CreateCase</code> request returns an AWS Support case number. You can use\n the <a>DescribeCases</a> operation and specify the case number to get\n existing AWS Support cases. After you create a case, use the <a>AddCommunicationToCase</a> operation to add additional communication or\n attachments to an existing case.</p>\n <p>The <code>caseId</code> is separate from the <code>displayId</code> that appears in\n the <a href=\"https://console.aws.amazon.com/support\">AWS Support Center</a>. Use the <a>DescribeCases</a> operation to get the <code>displayId</code>.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case\n in the Amazon Web Services Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create\n Case</a> page.</p>\n <p>The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a\n service limit increase in the following ways: </p>\n <ul>\n <li>\n <p>Submit a request from the Amazon Web Services Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</p>\n </li>\n <li>\n <p>Use the Service Quotas <a href=\"https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html\">RequestServiceQuotaIncrease</a> operation.</p>\n </li>\n </ul>\n <p>A successful <code>CreateCase</code> request returns an Amazon Web Services Support case number. You can use\n the <a>DescribeCases</a> operation and specify the case number to get\n existing Amazon Web Services Support cases. After you create a case, use the <a>AddCommunicationToCase</a> operation to add additional communication or\n attachments to an existing case.</p>\n <p>The <code>caseId</code> is separate from the <code>displayId</code> that appears in\n the <a href=\"https://console.aws.amazon.com/support\">Amazon Web Services Support Center</a>. Use the <a>DescribeCases</a> operation to get the <code>displayId</code>.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#CreateCaseRequest": {
@ -628,45 +628,45 @@
"subject": {
"target": "com.amazonaws.support#Subject",
"traits": {
"smithy.api#documentation": "<p>The title of the support case. The title appears in the <b>Subject</b> field on the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</p>",
"smithy.api#documentation": "<p>The title of the support case. The title appears in the <b>Subject</b> field on the Amazon Web Services Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</p>",
"smithy.api#required": {}
}
},
"serviceCode": {
"target": "com.amazonaws.support#ServiceCode",
"traits": {
"smithy.api#documentation": "<p>The code for the AWS service. You can use the <a>DescribeServices</a>\n operation to get the possible <code>serviceCode</code> values.</p>"
"smithy.api#documentation": "<p>The code for the Amazon Web Services service. You can use the <a>DescribeServices</a>\n operation to get the possible <code>serviceCode</code> values.</p>"
}
},
"severityCode": {
"target": "com.amazonaws.support#SeverityCode",
"traits": {
"smithy.api#documentation": "<p>A value that indicates the urgency of the case. This value determines the response\n time according to your service level agreement with AWS Support. You can use the <a>DescribeSeverityLevels</a> operation to get the possible values for\n <code>severityCode</code>. </p>\n <p>For more information, see <a>SeverityLevel</a> and <a href=\"https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity\">Choosing a\n Severity</a> in the <i>AWS Support User Guide</i>.</p>\n <note>\n <p>The availability of severity levels depends on the support plan for the AWS\n account.</p>\n </note>"
"smithy.api#documentation": "<p>A value that indicates the urgency of the case. This value determines the response\n time according to your service level agreement with Amazon Web Services Support. You can use the <a>DescribeSeverityLevels</a> operation to get the possible values for\n <code>severityCode</code>. </p>\n <p>For more information, see <a>SeverityLevel</a> and <a href=\"https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity\">Choosing a\n Severity</a> in the <i>Amazon Web Services Support User Guide</i>.</p>\n <note>\n <p>The availability of severity levels depends on the support plan for the\n Amazon Web Services account.</p>\n </note>"
}
},
"categoryCode": {
"target": "com.amazonaws.support#CategoryCode",
"traits": {
"smithy.api#documentation": "<p>The category of problem for the support case. You also use the <a>DescribeServices</a> operation to get the category code for a service. Each\n AWS service defines its own set of category codes.</p>"
"smithy.api#documentation": "<p>The category of problem for the support case. You also use the <a>DescribeServices</a> operation to get the category code for a service. Each\n Amazon Web Services service defines its own set of category codes.</p>"
}
},
"communicationBody": {
"target": "com.amazonaws.support#CommunicationBody",
"traits": {
"smithy.api#documentation": "<p>The communication body text that describes the issue. This text appears in the\n <b>Description</b> field on the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</p>",
"smithy.api#documentation": "<p>The communication body text that describes the issue. This text appears in the\n <b>Description</b> field on the Amazon Web Services Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page.</p>",
"smithy.api#required": {}
}
},
"ccEmailAddresses": {
"target": "com.amazonaws.support#CcEmailAddressList",
"traits": {
"smithy.api#documentation": "<p>A list of email addresses that AWS Support copies on case correspondence. AWS Support\n identifies the account that creates the case when you specify your AWS credentials in an\n HTTP POST method or use the <a href=\"http://aws.amazon.com/tools/\">AWS SDKs</a>.\n </p>"
"smithy.api#documentation": "<p>A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support\n identifies the account that creates the case when you specify your Amazon Web Services credentials in an\n HTTP POST method or use the <a href=\"http://aws.amazon.com/tools/\">Amazon Web Services SDKs</a>.\n </p>"
}
},
"language": {
"target": "com.amazonaws.support#Language",
"traits": {
"smithy.api#documentation": "<p>The language in which AWS Support handles the case. You must specify the ISO 639-1\n code for the <code>language</code> parameter if you want support in that language.\n Currently, English (\"en\") and Japanese (\"ja\") are supported.</p>"
"smithy.api#documentation": "<p>The language in which Amazon Web Services Support handles the case. You must specify the ISO 639-1\n code for the <code>language</code> parameter if you want support in that language.\n Currently, English (\"en\") and Japanese (\"ja\") are supported.</p>"
}
},
"issueType": {
@ -720,7 +720,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the attachment that has the specified ID. Attachments can include screenshots,\n error logs, or other files that describe your issue. Attachment IDs are generated by the\n case management system when you add an attachment to a case or case communication.\n Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are\n returned by the <a>DescribeCommunications</a> operation.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Returns the attachment that has the specified ID. Attachments can include screenshots,\n error logs, or other files that describe your issue. Attachment IDs are generated by the\n case management system when you add an attachment to a case or case communication.\n Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are\n returned by the <a>DescribeCommunications</a> operation.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#DescribeAttachmentLimitExceeded": {
@ -781,7 +781,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns a list of cases that you specify by passing one or more case IDs. You can use\n the <code>afterTime</code> and <code>beforeTime</code> parameters to filter the cases by\n date. You can set values for the <code>includeResolvedCases</code> and\n <code>includeCommunications</code> parameters to specify how much information to\n return.</p>\n <p>The response returns the following in JSON format:</p>\n <ul>\n <li>\n <p>One or more <a href=\"https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html\">CaseDetails</a> data types.</p>\n </li>\n <li>\n <p>One or more <code>nextToken</code> values, which specify where to paginate the\n returned records represented by the <code>CaseDetails</code> objects.</p>\n </li>\n </ul>\n <p>Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request might return an error.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>",
"smithy.api#documentation": "<p>Returns a list of cases that you specify by passing one or more case IDs. You can use\n the <code>afterTime</code> and <code>beforeTime</code> parameters to filter the cases by\n date. You can set values for the <code>includeResolvedCases</code> and\n <code>includeCommunications</code> parameters to specify how much information to\n return.</p>\n <p>The response returns the following in JSON format:</p>\n <ul>\n <li>\n <p>One or more <a href=\"https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html\">CaseDetails</a> data types.</p>\n </li>\n <li>\n <p>One or more <code>nextToken</code> values, which specify where to paginate the\n returned records represented by the <code>CaseDetails</code> objects.</p>\n </li>\n </ul>\n <p>Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request might return an error.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
@ -802,7 +802,7 @@
"displayId": {
"target": "com.amazonaws.support#DisplayId",
"traits": {
"smithy.api#documentation": "<p>The ID displayed for a case in the AWS Support Center user interface.</p>"
"smithy.api#documentation": "<p>The ID displayed for a case in the Amazon Web Services Support Center user interface.</p>"
}
},
"afterTime": {
@ -838,7 +838,7 @@
"language": {
"target": "com.amazonaws.support#Language",
"traits": {
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
}
},
"includeCommunications": {
@ -886,7 +886,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns communications and attachments for one or more support cases. Use the\n <code>afterTime</code> and <code>beforeTime</code> parameters to filter by date. You\n can use the <code>caseId</code> parameter to restrict the results to a specific\n case.</p>\n <p>Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request for data might cause an error.</p>\n <p>You can use the <code>maxResults</code> and <code>nextToken</code> parameters to\n control the pagination of the results. Set <code>maxResults</code> to the number of\n cases that you want to display on each page, and use <code>nextToken</code> to specify\n the resumption of pagination.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>",
"smithy.api#documentation": "<p>Returns communications and attachments for one or more support cases. Use the\n <code>afterTime</code> and <code>beforeTime</code> parameters to filter by date. You\n can use the <code>caseId</code> parameter to restrict the results to a specific\n case.</p>\n <p>Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request for data might cause an error.</p>\n <p>You can use the <code>maxResults</code> and <code>nextToken</code> parameters to\n control the pagination of the results. Set <code>maxResults</code> to the number of\n cases that you want to display on each page, and use <code>nextToken</code> to specify\n the resumption of pagination.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>",
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
@ -965,7 +965,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the current list of AWS services and a list of service categories for each\n service. You then use service names and categories in your <a>CreateCase</a>\n requests. Each AWS service has its own set of categories.</p>\n <p>The service codes and category codes correspond to the values that appear in the\n <b>Service</b> and <b>Category</b> lists on the AWS Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page. The values in those fields\n don't necessarily match the service codes and categories returned by the\n <code>DescribeServices</code> operation. Always use the service codes and categories\n that the <code>DescribeServices</code> operation returns, so that you have the most\n recent set of service and category codes.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Returns the current list of Amazon Web Services services and a list of service categories for each\n service. You then use service names and categories in your <a>CreateCase</a>\n requests. Each Amazon Web Services service has its own set of categories.</p>\n <p>The service codes and category codes correspond to the values that appear in the\n <b>Service</b> and <b>Category</b> lists on the Amazon Web Services Support Center <a href=\"https://console.aws.amazon.com/support/home#/case/create\">Create Case</a> page. The values in those fields\n don't necessarily match the service codes and categories returned by the\n <code>DescribeServices</code> operation. Always use the service codes and categories\n that the <code>DescribeServices</code> operation returns, so that you have the most\n recent set of service and category codes.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#DescribeServicesRequest": {
@ -974,13 +974,13 @@
"serviceCodeList": {
"target": "com.amazonaws.support#ServiceCodeList",
"traits": {
"smithy.api#documentation": "<p>A JSON-formatted list of service codes available for AWS services.</p>"
"smithy.api#documentation": "<p>A JSON-formatted list of service codes available for Amazon Web Services services.</p>"
}
},
"language": {
"target": "com.amazonaws.support#Language",
"traits": {
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
}
}
}
@ -991,12 +991,12 @@
"services": {
"target": "com.amazonaws.support#ServiceList",
"traits": {
"smithy.api#documentation": "<p>A JSON-formatted list of AWS services.</p>"
"smithy.api#documentation": "<p>A JSON-formatted list of Amazon Web Services services.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The list of AWS services returned by the <a>DescribeServices</a>\n operation.</p>"
"smithy.api#documentation": "<p>The list of Amazon Web Services services returned by the <a>DescribeServices</a>\n operation.</p>"
}
},
"com.amazonaws.support#DescribeSeverityLevels": {
@ -1013,7 +1013,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the list of severity levels that you can assign to a support case. The severity\n level for a case is also a field in the <a>CaseDetails</a> data type that you\n include for a <a>CreateCase</a> request.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Returns the list of severity levels that you can assign to a support case. The severity\n level for a case is also a field in the <a>CaseDetails</a> data type that you\n include for a <a>CreateCase</a> request.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#DescribeSeverityLevelsRequest": {
@ -1022,7 +1022,7 @@
"language": {
"target": "com.amazonaws.support#Language",
"traits": {
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
}
}
}
@ -1033,7 +1033,7 @@
"severityLevels": {
"target": "com.amazonaws.support#SeverityLevelsList",
"traits": {
"smithy.api#documentation": "<p>The available severity levels for the support case. Available severity levels are\n defined by your service level agreement with AWS.</p>"
"smithy.api#documentation": "<p>The available severity levels for the support case. Available severity levels are\n defined by your service level agreement with Amazon Web Services.</p>"
}
}
},
@ -1055,7 +1055,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the refresh status of the AWS Trusted Advisor checks that have the specified check\n IDs. You can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a> operation.</p>\n <p>Some checks are refreshed automatically, and you can't return their refresh statuses\n by using the <code>DescribeTrustedAdvisorCheckRefreshStatuses</code> operation. If you\n call this operation for these checks, you might see an\n <code>InvalidParameterValue</code> error.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Returns the refresh status of the Trusted Advisor checks that have the specified check\n IDs. You can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a> operation.</p>\n <p>Some checks are refreshed automatically, and you can't return their refresh statuses\n by using the <code>DescribeTrustedAdvisorCheckRefreshStatuses</code> operation. If you\n call this operation for these checks, you might see an\n <code>InvalidParameterValue</code> error.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#DescribeTrustedAdvisorCheckRefreshStatusesRequest": {
@ -1099,7 +1099,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the results of the AWS Trusted Advisor check that has the specified check ID. You\n can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a>\n operation.</p>\n <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which\n contains these three objects:</p>\n <ul>\n <li>\n <p>\n <a>TrustedAdvisorCategorySpecificSummary</a>\n </p>\n </li>\n <li>\n <p>\n <a>TrustedAdvisorResourceDetail</a>\n </p>\n </li>\n <li>\n <p>\n <a>TrustedAdvisorResourcesSummary</a>\n </p>\n </li>\n </ul>\n <p>In addition, the response contains these fields:</p>\n <ul>\n <li>\n <p>\n <b>status</b> - The alert status of the check\n can be <code>ok</code> (green), <code>warning</code> (yellow),\n <code>error</code> (red), or <code>not_available</code>.</p>\n </li>\n <li>\n <p>\n <b>timestamp</b> - The time of the last refresh\n of the check.</p>\n </li>\n <li>\n <p>\n <b>checkId</b> - The unique identifier for the\n check.</p>\n </li>\n </ul>\n \n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Returns the results of the Trusted Advisor check that has the specified check ID. You\n can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a>\n operation.</p>\n <p>The response contains a <a>TrustedAdvisorCheckResult</a> object, which\n contains these three objects:</p>\n <ul>\n <li>\n <p>\n <a>TrustedAdvisorCategorySpecificSummary</a>\n </p>\n </li>\n <li>\n <p>\n <a>TrustedAdvisorResourceDetail</a>\n </p>\n </li>\n <li>\n <p>\n <a>TrustedAdvisorResourcesSummary</a>\n </p>\n </li>\n </ul>\n <p>In addition, the response contains these fields:</p>\n <ul>\n <li>\n <p>\n <b>status</b> - The alert status of the check\n can be <code>ok</code> (green), <code>warning</code> (yellow),\n <code>error</code> (red), or <code>not_available</code>.</p>\n </li>\n <li>\n <p>\n <b>timestamp</b> - The time of the last refresh\n of the check.</p>\n </li>\n <li>\n <p>\n <b>checkId</b> - The unique identifier for the\n check.</p>\n </li>\n </ul>\n \n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#DescribeTrustedAdvisorCheckResultRequest": {
@ -1115,7 +1115,7 @@
"language": {
"target": "com.amazonaws.support#String",
"traits": {
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>"
}
}
},
@ -1151,7 +1151,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you\n specified. You can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a> operation.</p>\n <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a>\n objects.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Returns the results for the Trusted Advisor check summaries for the check IDs that you\n specified. You can get the check IDs by calling the <a>DescribeTrustedAdvisorChecks</a> operation.</p>\n <p>The response contains an array of <a>TrustedAdvisorCheckSummary</a>\n objects.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#DescribeTrustedAdvisorCheckSummariesRequest": {
@ -1195,7 +1195,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns information about all available AWS Trusted Advisor checks, including the name, ID,\n category, description, and metadata. You must specify a language code. The AWS Support API\n currently supports English (\"en\") and Japanese (\"ja\"). The response contains a <a>TrustedAdvisorCheckDescription</a> object for each check. You must set the\n AWS Region to us-east-1.</p>\n \n \n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n <li>\n <p>The names and descriptions for Trusted Advisor checks are subject to change. We recommend\n that you specify the check ID in your code to uniquely identify a check.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Returns information about all available Trusted Advisor checks, including the name, ID,\n category, description, and metadata. You must specify a language code. The Amazon Web Services Support API\n currently supports English (\"en\") and Japanese (\"ja\"). The response contains a <a>TrustedAdvisorCheckDescription</a> object for each check. You must set the\n Amazon Web Services Region to us-east-1.</p>\n \n \n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n <li>\n <p>The names and descriptions for Trusted Advisor checks are subject to change. We recommend\n that you specify the check ID in your code to uniquely identify a check.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#DescribeTrustedAdvisorChecksRequest": {
@ -1204,7 +1204,7 @@
"language": {
"target": "com.amazonaws.support#String",
"traits": {
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>",
"smithy.api#documentation": "<p>The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.</p>",
"smithy.api#required": {}
}
}
@ -1320,7 +1320,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the\n check IDs by calling the <a>DescribeTrustedAdvisorChecks</a>\n operation.</p>\n <note>\n <p>Some checks are refreshed automatically. If you call the\n <code>RefreshTrustedAdvisorCheck</code> operation to refresh them, you might see\n the <code>InvalidParameterValue</code> error.</p>\n </note>\n <p>The response contains a <a>TrustedAdvisorCheckRefreshStatus</a>\n object.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Refreshes the Trusted Advisor check that you specify using the check ID. You can get the\n check IDs by calling the <a>DescribeTrustedAdvisorChecks</a>\n operation.</p>\n <note>\n <p>Some checks are refreshed automatically. If you call the\n <code>RefreshTrustedAdvisorCheck</code> operation to refresh them, you might see\n the <code>InvalidParameterValue</code> error.</p>\n </note>\n <p>The response contains a <a>TrustedAdvisorCheckRefreshStatus</a>\n object.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#RefreshTrustedAdvisorCheckRequest": {
@ -1370,7 +1370,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Resolves a support case. This operation takes a <code>caseId</code> and returns the\n initial and final state of the case.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business or Enterprise Support plan to use the AWS Support\n API. </p>\n </li>\n <li>\n <p>If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>.</p>\n </li>\n </ul>\n </note>"
"smithy.api#documentation": "<p>Resolves a support case. This operation takes a <code>caseId</code> and returns the\n initial and final state of the case.</p>\n <note>\n <ul>\n <li>\n <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API. </p>\n </li>\n <li>\n <p>If you call the Amazon Web Services Support API from an account that does not have a\n Business, Enterprise On-Ramp, or Enterprise Support plan, the\n <code>SubscriptionRequiredException</code> error message appears. For\n information about changing your support plan, see <a href=\"http://aws.amazon.com/premiumsupport/\">Amazon Web Services Support</a>.</p>\n </li>\n </ul>\n </note>"
}
},
"com.amazonaws.support#ResolveCaseRequest": {
@ -1413,30 +1413,30 @@
"code": {
"target": "com.amazonaws.support#ServiceCode",
"traits": {
"smithy.api#documentation": "<p>The code for an AWS service returned by the <a>DescribeServices</a>\n response. The <code>name</code> element contains the corresponding friendly name.</p>"
"smithy.api#documentation": "<p>The code for an Amazon Web Services service returned by the <a>DescribeServices</a>\n response. The <code>name</code> element contains the corresponding friendly name.</p>"
}
},
"name": {
"target": "com.amazonaws.support#ServiceName",
"traits": {
"smithy.api#documentation": "<p>The friendly name for an AWS service. The <code>code</code> element contains the\n corresponding code.</p>"
"smithy.api#documentation": "<p>The friendly name for an Amazon Web Services service. The <code>code</code> element contains the\n corresponding code.</p>"
}
},
"categories": {
"target": "com.amazonaws.support#CategoryList",
"traits": {
"smithy.api#documentation": "<p>A list of categories that describe the type of support issue a case describes.\n Categories consist of a category name and a category code. Category names and codes are\n passed to AWS Support when you call <a>CreateCase</a>.</p>"
"smithy.api#documentation": "<p>A list of categories that describe the type of support issue a case describes.\n Categories consist of a category name and a category code. Category names and codes are\n passed to Amazon Web Services Support when you call <a>CreateCase</a>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about an AWS service returned by the <a>DescribeServices</a>\n operation.</p>"
"smithy.api#documentation": "<p>Information about an Amazon Web Services service returned by the <a>DescribeServices</a>\n operation.</p>"
}
},
"com.amazonaws.support#ServiceCode": {
"type": "string",
"traits": {
"smithy.api#pattern": "[0-9a-z\\-_]+"
"smithy.api#pattern": "^[0-9a-z\\-_]+$"
}
},
"com.amazonaws.support#ServiceCodeList": {
@ -1475,12 +1475,12 @@
"name": {
"target": "com.amazonaws.support#SeverityLevelName",
"traits": {
"smithy.api#documentation": "<p>The name of the severity level that corresponds to the severity level code.</p>\n <note>\n <p>The values returned by the API are different from the values that appear in the\n AWS Support Center. For example, the API uses the code <code>low</code>, but the name\n appears as General guidance in Support Center. </p>\n <p>The following are the API code names and how they appear in the console:</p>\n <ul>\n <li>\n <p>\n <code>low</code> - General guidance</p>\n </li>\n <li>\n <p>\n <code>normal</code> - System impaired</p>\n </li>\n <li>\n <p>\n <code>high</code> - Production system impaired</p>\n </li>\n <li>\n <p>\n <code>urgent</code> - Production system down</p>\n </li>\n <li>\n <p>\n <code>critical</code> - Business-critical system down</p>\n </li>\n </ul>\n </note>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity\">Choosing a\n severity</a> in the <i>AWS Support User Guide</i>.</p>"
"smithy.api#documentation": "<p>The name of the severity level that corresponds to the severity level code.</p>\n <note>\n <p>The values returned by the API are different from the values that appear in the\n Amazon Web Services Support Center. For example, the API uses the code <code>low</code>, but the name\n appears as General guidance in Support Center. </p>\n <p>The following are the API code names and how they appear in the console:</p>\n <ul>\n <li>\n <p>\n <code>low</code> - General guidance</p>\n </li>\n <li>\n <p>\n <code>normal</code> - System impaired</p>\n </li>\n <li>\n <p>\n <code>high</code> - Production system impaired</p>\n </li>\n <li>\n <p>\n <code>urgent</code> - Production system down</p>\n </li>\n <li>\n <p>\n <code>critical</code> - Business-critical system down</p>\n </li>\n </ul>\n </note>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity\">Choosing a\n severity</a> in the <i>Amazon Web Services Support User Guide</i>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A code and name pair that represents the severity level of a support case. The\n available values depend on the support plan for the account. For more information, see\n <a href=\"https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity\">Choosing a\n severity</a> in the <i>AWS Support User Guide</i>.</p>"
"smithy.api#documentation": "<p>A code and name pair that represents the severity level of a support case. The\n available values depend on the support plan for the account. For more information, see\n <a href=\"https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity\">Choosing a\n severity</a> in the <i>Amazon Web Services Support User Guide</i>.</p>"
}
},
"com.amazonaws.support#SeverityLevelCode": {
@ -1752,7 +1752,7 @@
"region": {
"target": "com.amazonaws.support#String",
"traits": {
"smithy.api#documentation": "<p>The AWS Region in which the identified resource is located.</p>"
"smithy.api#documentation": "<p>The Amazon Web Services Region in which the identified resource is located.</p>"
}
},
"resourceId": {
@ -1765,7 +1765,7 @@
"isSuppressed": {
"target": "com.amazonaws.support#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the AWS resource was ignored by Trusted Advisor because it was\n marked as suppressed by the user.</p>"
"smithy.api#documentation": "<p>Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was\n marked as suppressed by the user.</p>"
}
},
"metadata": {
@ -1792,34 +1792,34 @@
"resourcesProcessed": {
"target": "com.amazonaws.support#Long",
"traits": {
"smithy.api#documentation": "<p>The number of AWS resources that were analyzed by the Trusted Advisor check.</p>",
"smithy.api#documentation": "<p>The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.</p>",
"smithy.api#required": {}
}
},
"resourcesFlagged": {
"target": "com.amazonaws.support#Long",
"traits": {
"smithy.api#documentation": "<p>The number of AWS resources that were flagged (listed) by the Trusted Advisor\n check.</p>",
"smithy.api#documentation": "<p>The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor\n check.</p>",
"smithy.api#required": {}
}
},
"resourcesIgnored": {
"target": "com.amazonaws.support#Long",
"traits": {
"smithy.api#documentation": "<p>The number of AWS resources ignored by Trusted Advisor because information was\n unavailable.</p>",
"smithy.api#documentation": "<p>The number of Amazon Web Services resources ignored by Trusted Advisor because information was\n unavailable.</p>",
"smithy.api#required": {}
}
},
"resourcesSuppressed": {
"target": "com.amazonaws.support#Long",
"traits": {
"smithy.api#documentation": "<p>The number of AWS resources ignored by Trusted Advisor because they were marked as\n suppressed by the user.</p>",
"smithy.api#documentation": "<p>The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as\n suppressed by the user.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details about AWS resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>.</p>"
"smithy.api#documentation": "<p>Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>.</p>"
}
}
}

45
aws/sdk/aws-models/transfer.json
View File

@ -301,7 +301,7 @@
"IdentityProviderType": {
"target": "com.amazonaws.transfer#IdentityProviderType",
"traits": {
"smithy.api#documentation": "<p>Specifies the mode of authentication for a server. The default value is\n <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.</p>\n <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The\n <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>LAMBDA</code> value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>"
"smithy.api#documentation": "<p>Specifies the mode of authentication for a server. The default value is\n <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.</p>\n <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The\n <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>AWS_LAMBDA</code> value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>"
}
},
"LoggingRole": {
@ -316,6 +316,12 @@
"smithy.api#documentation": "<p>Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:</p>\n\n <ul>\n <li>\n <p>\n <code>SFTP</code> (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH</p>\n </li>\n <li>\n <p>\n <code>FTPS</code> (File Transfer Protocol Secure): File transfer with TLS\n encryption</p>\n </li>\n <li>\n <p>\n <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p>\n </li>\n </ul>\n\n <note>\n <p>If you select <code>FTPS</code>, you must choose a certificate stored in Amazon Web Services Certificate\n Manager (ACM) which is used to identify your server when clients connect to it over\n FTPS.</p>\n\n <p>If <code>Protocol</code> includes either <code>FTP</code> or <code>FTPS</code>, then the\n <code>EndpointType</code> must be <code>VPC</code> and the\n <code>IdentityProviderType</code> must be <code>AWS_DIRECTORY_SERVICE</code> or <code>API_GATEWAY</code>.</p>\n\n <p>If <code>Protocol</code> includes <code>FTP</code>, then\n <code>AddressAllocationIds</code> cannot be associated.</p>\n\n <p>If <code>Protocol</code> is set only to <code>SFTP</code>, the <code>EndpointType</code>\n can be set to <code>PUBLIC</code> and the <code>IdentityProviderType</code> can be set to\n <code>SERVICE_MANAGED</code>.</p>\n </note>"
}
},
"ProtocolDetails": {
"target": "com.amazonaws.transfer#ProtocolDetails",
"traits": {
"smithy.api#documentation": "<p>The protocol settings that are configured for your server.</p>\n <p>\n Use the <code>PassiveIp</code> parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n </p>\n <p>Use the <code>TlsSessionResumptionMode</code> parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.</p>"
}
},
"SecurityPolicyName": {
"target": "com.amazonaws.transfer#SecurityPolicyName",
"traits": {
@ -427,7 +433,7 @@
"SshPublicKeyBody": {
"target": "com.amazonaws.transfer#SshPublicKeyBody",
"traits": {
"smithy.api#documentation": "<p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.</p>"
"smithy.api#documentation": "<p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.</p>\n <note>\n <p>\n Currently, Transfer Family does not accept elliptical curve keys (keys beginning with <code>ecdsa</code>).\n </p>\n </note>"
}
},
"Tags": {
@ -1370,7 +1376,7 @@
"IdentityProviderType": {
"target": "com.amazonaws.transfer#IdentityProviderType",
"traits": {
"smithy.api#documentation": "<p>Specifies the mode of authentication for a server. The default value is\n <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.</p>\n <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The\n <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>LAMBDA</code> value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>"
"smithy.api#documentation": "<p>Specifies the mode of authentication for a server. The default value is\n <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.</p>\n <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The\n <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>AWS_LAMBDA</code> value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>"
}
},
"LoggingRole": {
@ -1925,7 +1931,7 @@
"DirectoryId": {
"target": "com.amazonaws.transfer#DirectoryId",
"traits": {
"smithy.api#documentation": "<p>The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.</p>"
"smithy.api#documentation": "<p>The identifier of the Amazon Web Services Directory Service directory that you want to stop sharing.</p>"
}
},
"Function": {
@ -2738,7 +2744,7 @@
"IdentityProviderType": {
"target": "com.amazonaws.transfer#IdentityProviderType",
"traits": {
"smithy.api#documentation": "<p>Specifies the mode of authentication for a server. The default value is\n <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.</p>\n <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The\n <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>LAMBDA</code> value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>"
"smithy.api#documentation": "<p>Specifies the mode of authentication for a server. The default value is\n <code>SERVICE_MANAGED</code>, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.</p>\n <p>Use <code>AWS_DIRECTORY_SERVICE</code> to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The\n <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the <code>IdentityProviderDetails</code> parameter.</p>\n <p>Use the <code>AWS_LAMBDA</code> value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the <code>Function</code> parameter for the <code>IdentityProviderDetails</code> data type.</p>"
}
},
"EndpointType": {
@ -3057,10 +3063,16 @@
"traits": {
"smithy.api#documentation": "<p>\n Indicates passive mode, for FTP and FTPS protocols.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n For example:\n </p>\n <p>\n <code>\n aws transfer update-server --protocol-details PassiveIp=<i>0.0.0.0</i>\n </code>\n </p>\n <p>Replace <code>\n <i>0.0.0.0</i>\n </code> in the example above with the actual IP address you want to use.</p>\n <note>\n <p>\n If you change the <code>PassiveIp</code> value, you must stop and then restart your Transfer server for the change to take effect. For details on using Passive IP (PASV) in a NAT environment, see <a href=\"http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/\">Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family</a>.\n </p>\n </note>"
}
},
"TlsSessionResumptionMode": {
"target": "com.amazonaws.transfer#TlsSessionResumptionMode",
"traits": {
"smithy.api#documentation": "<p>A property used with Transfer servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret\n key between the control and data connection for an FTPS session. <code>TlsSessionResumptionMode</code> determines whether or not the server resumes recent,\n negotiated sessions through a unique session ID. This property is available during <code>CreateServer</code> and <code>UpdateServer</code> calls.\n If a <code>TlsSessionResumptionMode</code> value is not specified during CreateServer, it is set to <code>ENFORCED</code> by default.</p>\n <ul>\n <li>\n <p>\n <code>DISABLED</code>: the server does not process TLS session resumption client requests and creates a new TLS session for each request. </p>\n </li>\n <li>\n <p>\n <code>ENABLED</code>: the server processes and accepts clients that are performing TLS session resumption.\n The server doesn't reject client data connections that do not perform the TLS session resumption client processing.</p>\n </li>\n <li>\n <p>\n <code>ENFORCED</code>: the server processes and accepts clients that are performing TLS session resumption.\n The server rejects client data connections that do not perform the TLS session resumption client processing.\n Before you set the value to <code>ENFORCED</code>, test your clients.</p>\n <note>\n <p>Not all FTPS clients perform TLS session resumption. So, if you choose to enforce\n TLS session resumption, you prevent any connections from FTPS clients that don't perform\n the protocol negotiation. To determine whether or not you can use the\n <code>ENFORCED</code> value, you need to test your clients.</p>\n </note>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>\n The protocol settings that are configured for your server.\n </p>\n <note>\n <p>\n This type is only valid in the <code>UpdateServer</code> API.\n </p>\n </note>"
"smithy.api#documentation": "<p>\n The protocol settings that are configured for your server.\n </p>"
}
},
"com.amazonaws.transfer#Protocols": {
@ -3924,6 +3936,25 @@
"smithy.api#httpError": 429
}
},
"com.amazonaws.transfer#TlsSessionResumptionMode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "DISABLED",
"name": "DISABLED"
},
{
"value": "ENABLED",
"name": "ENABLED"
},
{
"value": "ENFORCED",
"name": "ENFORCED"
}
]
}
},
"com.amazonaws.transfer#TransferService": {
"type": "service",
"traits": {
@ -4233,7 +4264,7 @@
"ProtocolDetails": {
"target": "com.amazonaws.transfer#ProtocolDetails",
"traits": {
"smithy.api#documentation": "<p>\n The protocol settings that are configured for your server.\n </p>\n <p>\n Use the <code>PassiveIp</code> parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n </p>"
"smithy.api#documentation": "<p>\n The protocol settings that are configured for your server.\n </p>\n <p>\n Use the <code>PassiveIp</code> parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n </p>\n <p>Use the <code>TlsSessionResumptionMode</code> parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.</p>"
}
},
"EndpointDetails": {

204
aws/sdk/aws-models/workmail.json
View File

@ -1054,6 +1054,46 @@
"type": "structure",
"members": {}
},
"com.amazonaws.workmail#DeleteEmailMonitoringConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.workmail#DeleteEmailMonitoringConfigurationRequest"
},
"output": {
"target": "com.amazonaws.workmail#DeleteEmailMonitoringConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.workmail#InvalidParameterException"
},
{
"target": "com.amazonaws.workmail#OrganizationNotFoundException"
},
{
"target": "com.amazonaws.workmail#OrganizationStateException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the email monitoring configuration for a specified organization.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.workmail#DeleteEmailMonitoringConfigurationRequest": {
"type": "structure",
"members": {
"OrganizationId": {
"target": "com.amazonaws.workmail#OrganizationId",
"traits": {
"smithy.api#documentation": "<p>The ID of the organization from which the email monitoring configuration is deleted.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.workmail#DeleteEmailMonitoringConfigurationResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.workmail#DeleteGroup": {
"type": "operation",
"input": {
@ -1604,6 +1644,62 @@
"type": "structure",
"members": {}
},
"com.amazonaws.workmail#DescribeEmailMonitoringConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.workmail#DescribeEmailMonitoringConfigurationRequest"
},
"output": {
"target": "com.amazonaws.workmail#DescribeEmailMonitoringConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.workmail#InvalidParameterException"
},
{
"target": "com.amazonaws.workmail#OrganizationNotFoundException"
},
{
"target": "com.amazonaws.workmail#OrganizationStateException"
},
{
"target": "com.amazonaws.workmail#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Describes the current email monitoring configuration for a specified organization.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.workmail#DescribeEmailMonitoringConfigurationRequest": {
"type": "structure",
"members": {
"OrganizationId": {
"target": "com.amazonaws.workmail#OrganizationId",
"traits": {
"smithy.api#documentation": "<p>The ID of the organization for which the email monitoring configuration is described.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.workmail#DescribeEmailMonitoringConfigurationResponse": {
"type": "structure",
"members": {
"RoleArn": {
"target": "com.amazonaws.workmail#RoleArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.</p>"
}
},
"LogGroupArn": {
"target": "com.amazonaws.workmail#LogGroupArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.</p>"
}
}
}
},
"com.amazonaws.workmail#DescribeGroup": {
"type": "operation",
"input": {
@ -4269,6 +4365,16 @@
}
}
},
"com.amazonaws.workmail#LogGroupArn": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 47,
"max": 562
},
"smithy.api#pattern": "^arn:aws:logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([\\.\\-_/#A-Za-z0-9]+):\\*$"
}
},
"com.amazonaws.workmail#MailDomainInUseException": {
"type": "structure",
"members": {
@ -5062,6 +5168,63 @@
"type": "structure",
"members": {}
},
"com.amazonaws.workmail#PutEmailMonitoringConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.workmail#PutEmailMonitoringConfigurationRequest"
},
"output": {
"target": "com.amazonaws.workmail#PutEmailMonitoringConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.workmail#InvalidParameterException"
},
{
"target": "com.amazonaws.workmail#OrganizationNotFoundException"
},
{
"target": "com.amazonaws.workmail#OrganizationStateException"
},
{
"target": "com.amazonaws.workmail#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates or updates the email monitoring configuration for a specified organization.</p>",
"smithy.api#idempotent": {}
}
},
"com.amazonaws.workmail#PutEmailMonitoringConfigurationRequest": {
"type": "structure",
"members": {
"OrganizationId": {
"target": "com.amazonaws.workmail#OrganizationId",
"traits": {
"smithy.api#documentation": "<p>The ID of the organization for which the email monitoring configuration is set.</p>",
"smithy.api#required": {}
}
},
"RoleArn": {
"target": "com.amazonaws.workmail#RoleArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.</p>",
"smithy.api#required": {}
}
},
"LogGroupArn": {
"target": "com.amazonaws.workmail#LogGroupArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.workmail#PutEmailMonitoringConfigurationResponse": {
"type": "structure",
"members": {}
},
"com.amazonaws.workmail#PutInboundDmarcSettings": {
"type": "operation",
"input": {
@ -6515,6 +6678,21 @@
},
"com.amazonaws.workmail#WorkMailService": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "WorkMail",
"arnNamespace": "workmail",
"cloudFormationName": "WorkMail",
"cloudTrailEventSource": "workmail.amazonaws.com",
"endpointPrefix": "workmail"
},
"aws.auth#sigv4": {
"name": "workmail"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<p>Amazon WorkMail is a secure, managed business email and calendaring service with support for\n existing desktop and mobile email clients. You can access your email, contacts, and\n calendars using Microsoft Outlook, your browser, or other native iOS and Android email\n applications. You can integrate WorkMail with your existing corporate directory and control\n both the keys that encrypt your data and the location in which your data is\n stored.</p>\n <p>The WorkMail API is designed for the following scenarios:</p>\n <ul>\n <li>\n <p>Listing and describing organizations</p>\n </li>\n </ul>\n <ul>\n <li>\n <p>Managing users</p>\n </li>\n </ul>\n <ul>\n <li>\n <p>Managing groups</p>\n </li>\n </ul>\n <ul>\n <li>\n <p>Managing resources</p>\n </li>\n </ul>\n <p>All WorkMail API operations are Amazon-authenticated and certificate-signed. They not\n only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management\n users and roles to help facilitate access, trust, and permission policies. By creating a\n role and allowing an IAM user to access the WorkMail site, the IAM user gains full\n administrative visibility into the entire WorkMail organization (or as set in the IAM\n policy). This includes, but is not limited to, the ability to create, update, and delete\n users, groups, and resources. This allows developers to perform the scenarios listed above,\n as well as give users the ability to grant access on a selective basis using the IAM\n model.</p>",
"smithy.api#title": "Amazon WorkMail"
},
"version": "2017-10-01",
"operations": [
{
@ -6550,6 +6728,9 @@
{
"target": "com.amazonaws.workmail#DeleteAlias"
},
{
"target": "com.amazonaws.workmail#DeleteEmailMonitoringConfiguration"
},
{
"target": "com.amazonaws.workmail#DeleteGroup"
},
@ -6580,6 +6761,9 @@
{
"target": "com.amazonaws.workmail#DeregisterMailDomain"
},
{
"target": "com.amazonaws.workmail#DescribeEmailMonitoringConfiguration"
},
{
"target": "com.amazonaws.workmail#DescribeGroup"
},
@ -6667,6 +6851,9 @@
{
"target": "com.amazonaws.workmail#PutAccessControlRule"
},
{
"target": "com.amazonaws.workmail#PutEmailMonitoringConfiguration"
},
{
"target": "com.amazonaws.workmail#PutInboundDmarcSettings"
},
@ -6712,22 +6899,7 @@
{
"target": "com.amazonaws.workmail#UpdateResource"
}
],
"traits": {
"aws.api#service": {
"sdkId": "WorkMail",
"arnNamespace": "workmail",
"cloudFormationName": "WorkMail",
"cloudTrailEventSource": "workmail.amazonaws.com",
"endpointPrefix": "workmail"
},
"aws.auth#sigv4": {
"name": "workmail"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<p>Amazon WorkMail is a secure, managed business email and calendaring service with support for\n existing desktop and mobile email clients. You can access your email, contacts, and\n calendars using Microsoft Outlook, your browser, or other native iOS and Android email\n applications. You can integrate WorkMail with your existing corporate directory and control\n both the keys that encrypt your data and the location in which your data is\n stored.</p>\n <p>The WorkMail API is designed for the following scenarios:</p>\n <ul>\n <li>\n <p>Listing and describing organizations</p>\n </li>\n </ul>\n <ul>\n <li>\n <p>Managing users</p>\n </li>\n </ul>\n <ul>\n <li>\n <p>Managing groups</p>\n </li>\n </ul>\n <ul>\n <li>\n <p>Managing resources</p>\n </li>\n </ul>\n <p>All WorkMail API operations are Amazon-authenticated and certificate-signed. They not\n only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management\n users and roles to help facilitate access, trust, and permission policies. By creating a\n role and allowing an IAM user to access the WorkMail site, the IAM user gains full\n administrative visibility into the entire WorkMail organization (or as set in the IAM\n policy). This includes, but is not limited to, the ability to create, update, and delete\n users, groups, and resources. This allows developers to perform the scenarios listed above,\n as well as give users the ability to grant access on a selective basis using the IAM\n model.</p>",
"smithy.api#title": "Amazon WorkMail"
}
]
}
}
}

4
gradle.properties
View File

@ -5,10 +5,10 @@
# Version number to use for the generated SDK
# Note: these must always be full 3-segment semver versions
aws.sdk.version=0.3.0
aws.sdk.version=0.4.0
# Version number to use for the generated runtime crates
smithy.rs.runtime.crate.version=0.33.1
smithy.rs.runtime.crate.version=0.34.0
kotlin.code.style=official