diff --git a/CHANGELOG.md b/CHANGELOG.md index 684c761a50..00b7c139ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,20 @@ +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` 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 `` tags with no `href` attribute to `
` 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:**
diff --git a/CHANGELOG.next.toml b/CHANGELOG.next.toml
index c8f15b1863..72d79628e7 100644
--- a/CHANGELOG.next.toml
+++ b/CHANGELOG.next.toml
@@ -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 `` tags with no `href` attribute to `
` 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` 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` 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"
diff --git a/aws/SDK_CHANGELOG.md b/aws/SDK_CHANGELOG.md
index dcb5549f1b..d412e7c708 100644
--- a/aws/SDK_CHANGELOG.md
+++ b/aws/SDK_CHANGELOG.md
@@ -1,4 +1,36 @@
 
+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` 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:**
diff --git a/aws/sdk/aws-models/amplifyuibuilder.json b/aws/sdk/aws-models/amplifyuibuilder.json
new file mode 100644
index 0000000000..9b80275040
--- /dev/null
+++ b/aws/sdk/aws-models/amplifyuibuilder.json
@@ -0,0 +1,2408 @@
+{
+    "smithy": "1.0",
+    "shapes": {
+        "com.amazonaws.amplifyuibuilder#AmplifyUIBuilder": {
+            "type": "service",
+            "traits": {
+                "aws.api#service": {
+                    "sdkId": "AmplifyUIBuilder",
+                    "arnNamespace": "amplifyuibuilder",
+                    "cloudFormationName": "AmplifyUIBuilder",
+                    "cloudTrailEventSource": "amplifyuibuilder.amazonaws.com",
+                    "endpointPrefix": "amplifyuibuilder"
+                },
+                "aws.auth#sigv4": {
+                    "name": "amplifyuibuilder"
+                },
+                "aws.protocols#restJson1": {},
+                "smithy.api#cors": {},
+                "smithy.api#documentation": "

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

\n

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

\n

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

", + "smithy.api#title": "AWS Amplify UI Builder" + }, + "version": "2021-08-11", + "operations": [ + { + "target": "com.amazonaws.amplifyuibuilder#ExchangeCodeForToken" + }, + { + "target": "com.amazonaws.amplifyuibuilder#RefreshToken" + } + ], + "resources": [ + { + "target": "com.amazonaws.amplifyuibuilder#ComponentResource" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ThemeResource" + } + ] + }, + "com.amazonaws.amplifyuibuilder#Component": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

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

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

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

The unique ID of the component in its original source system, such as Figma.

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

The unique ID of the component.

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

The name of the component.

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

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

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

Describes the component's properties.

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

A list of the component's ComponentChild instances.

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

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

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

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

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

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

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

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

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

The time that the component was created.

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

The time that the component was modified.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "tags": { + "target": "com.amazonaws.amplifyuibuilder#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

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

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

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

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.amplifyuibuilder#ComponentResource" + } + ] + } + }, + "com.amazonaws.amplifyuibuilder#ComponentBindingProperties": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#ComponentBindingPropertiesValue" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentBindingPropertiesValue": { + "type": "structure", + "members": { + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The property type.

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

Describes the properties to customize with data at runtime.

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

The default value of the property.

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

Represents the data binding configuration for a component at runtime. You can use\n ComponentBindingPropertiesValue to add exposed properties to a component to\n allow different values to be entered when a component is reused in different places in an\n app.

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

An Amplify DataStore model.

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

The field to bind the data to.

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

A list of predicates for binding a component's properties to data.

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

An authenticated user attribute.

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

An Amazon S3 bucket.

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

The storage key for an Amazon S3 bucket.

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

The default value to assign to the property.

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

Represents the data binding configuration for a specific property using data stored in\n Amazon Web Services. For Amazon Web Services connected properties, you can bind a property to\n data stored in an Amazon S3 bucket, an Amplify DataStore model or an\n authenticated user attribute.

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

The type of the child component.

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

The name of the child component.

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

Describes the properties of the child component.

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

The list of ComponentChild instances for this component.

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

A nested UI configuration within a parent Component.

" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentChildList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#ComponentChild" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentCollectionProperties": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#ComponentDataConfiguration" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentConditionProperty": { + "type": "structure", + "members": { + "property": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the conditional property.

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

The name of a field. Specify this when the property is a data model.

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

The operator to use to perform the evaluation, such as eq to represent\n equals.

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

The value of the property to evaluate.

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

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

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

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

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

Represents a conditional expression to set a component property. Use\n ComponentConditionProperty to set a property to different values conditionally,\n based on the value of another property.

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

The name of the data model to use to bind data to a component.

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

Describes how to sort the component's properties.

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

Represents the conditional logic to use when binding data to a component. Use this\n property to retrieve only a subset of the data in a collection.

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

A list of IDs to use to bind data to a component. Use this property to bind specifically\n chosen data, rather than data retrieved from a query.

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

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

" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#Component" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.amplifyuibuilder#ComponentOverrides": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#ComponentOverridesValue" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentOverridesValue": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentProperties": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentProperty": { + "type": "structure", + "members": { + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value to assign to the component property.

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

The information to bind the component property to data at runtime.

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

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

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

The default value to assign to the component property.

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

The data model to use to assign a value to the component property.

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

The information to bind the component property to form data.

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

An event that occurs in your app. Use this for workflow data binding.

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

An authenticated user attribute to use to assign a value to the component property.

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

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

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

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

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

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

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

The component type.

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

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

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

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

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

The component property to bind to the data field.

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

The data field to bind the property to.

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

Associates a component property to a binding property. This enables exposed properties on\n the top level component to propagate data to the component's property values.

" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentPropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#ComponentProperty" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentResource": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.amplifyuibuilder#Uuid" + }, + "appId": { + "target": "smithy.api#String" + }, + "environmentName": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.amplifyuibuilder#CreateComponent" + }, + "read": { + "target": "com.amazonaws.amplifyuibuilder#GetComponent" + }, + "update": { + "target": "com.amazonaws.amplifyuibuilder#UpdateComponent" + }, + "delete": { + "target": "com.amazonaws.amplifyuibuilder#DeleteComponent" + }, + "list": { + "target": "com.amazonaws.amplifyuibuilder#ListComponents" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.amplifyuibuilder#ExportComponents" + } + ], + "traits": { + "aws.api#arn": { + "template": "app/{appId}/environment/{environmentName}/components/{id}", + "absolute": false, + "noAccount": false, + "noRegion": false + }, + "aws.cloudformation#cfnResource": { + "additionalSchemas": [ + "com.amazonaws.amplifyuibuilder#Component" + ], + "name": "Component" + } + } + }, + "com.amazonaws.amplifyuibuilder#ComponentSummary": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

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

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

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

The unique ID of the component.

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

The name of the component.

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

The component type.

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

Contains a summary of a component. This is a read-only data type that is returned by\n ListComponents.

" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#ComponentSummary" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.amplifyuibuilder#ComponentVariant": { + "type": "structure", + "members": { + "variantValues": { + "target": "com.amazonaws.amplifyuibuilder#ComponentVariantValues", + "traits": { + "smithy.api#documentation": "

The combination of variants that comprise this variant.

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

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

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

Describes the style configuration of a unique variation of a main component.

" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentVariantValues": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.amplifyuibuilder#ComponentVariants": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#ComponentVariant" + } + }, + "com.amazonaws.amplifyuibuilder#CreateComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#CreateComponentRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#CreateComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceConflictException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new component for an Amplify app.

", + "smithy.api#http": { + "method": "POST", + "uri": "/app/{appId}/environment/{environmentName}/components", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amplifyuibuilder#CreateComponentData": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.amplifyuibuilder#ComponentName", + "traits": { + "smithy.api#documentation": "

The name of the component

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

The unique ID of the component in its original source system, such as Figma.

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

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

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

Describes the component's properties.

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

A list of child components that are instances of the main component.

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

A list of the unique variants of this component.

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

Describes the component properties that can be overriden to customize an instance of the\n component.

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

The data binding information for the component's properties.

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

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

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

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

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

Represents all of the information that is required to create a component.

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

The unique ID of the Amplify app to associate with the component.

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

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

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The unique client token.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "componentToCreate": { + "target": "com.amazonaws.amplifyuibuilder#CreateComponentData", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Represents the configuration of the component to create.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#CreateComponentResponse": { + "type": "structure", + "members": { + "entity": { + "target": "com.amazonaws.amplifyuibuilder#Component", + "traits": { + "smithy.api#documentation": "

Describes the configuration of the new component.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#CreateTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#CreateThemeRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#CreateThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceConflictException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "POST", + "uri": "/app/{appId}/environment/{environmentName}/themes", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amplifyuibuilder#CreateThemeData": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.amplifyuibuilder#ThemeName", + "traits": { + "smithy.api#documentation": "

The name of the theme.

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

A list of key-value pairs that defines the properties of the theme.

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

Describes the properties that can be overriden to customize an instance of the\n theme.

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

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

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

Represents all of the information that is required to create a theme.

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

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

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

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

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The unique client token.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "themeToCreate": { + "target": "com.amazonaws.amplifyuibuilder#CreateThemeData", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Represents the configuration of the theme to create.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#CreateThemeResponse": { + "type": "structure", + "members": { + "entity": { + "target": "com.amazonaws.amplifyuibuilder#Theme", + "traits": { + "smithy.api#documentation": "

Describes the configuration of the new theme.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#DeleteComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#DeleteComponentRequest" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a component from an Amplify app.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/app/{appId}/environment/{environmentName}/components/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amplifyuibuilder#DeleteComponentRequest": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

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

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

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

The unique ID of the component to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#DeleteTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#DeleteThemeRequest" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a theme from an Amplify app.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/app/{appId}/environment/{environmentName}/themes/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amplifyuibuilder#DeleteThemeRequest": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

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

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

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

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

The unique ID of the theme to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ExchangeCodeForToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#ExchangeCodeForTokenRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#ExchangeCodeForTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Exchanges an access code for a token.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tokens/{provider}", + "code": 200 + } + } + }, + "com.amazonaws.amplifyuibuilder#ExchangeCodeForTokenRequest": { + "type": "structure", + "members": { + "provider": { + "target": "com.amazonaws.amplifyuibuilder#TokenProviders", + "traits": { + "smithy.api#documentation": "

The third-party provider for the token. The only valid value is figma.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "request": { + "target": "com.amazonaws.amplifyuibuilder#ExchangeCodeForTokenRequestBody", + "traits": { + "smithy.api#documentation": "

Describes the configuration of the request.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ExchangeCodeForTokenRequestBody": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The access code to send in the request.

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

The location of the application that will receive the access code.

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

Describes the configuration of a request to exchange an access code for a token.

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

The access token.

", + "smithy.api#required": {}, + "smithy.api#sensitive": {} + } + }, + "expiresIn": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The date and time when the new access token expires.

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

The token to use to refresh a previously issued access token that might have\n expired.

", + "smithy.api#required": {}, + "smithy.api#sensitive": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ExportComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#ExportComponentsRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#ExportComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "GET", + "uri": "/export/app/{appId}/environment/{environmentName}/components", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amplifyuibuilder#ExportComponentsRequest": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the Amplify app to export components to.

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

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

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ExportComponentsResponse": { + "type": "structure", + "members": { + "entities": { + "target": "com.amazonaws.amplifyuibuilder#ComponentList", + "traits": { + "smithy.api#documentation": "

Represents the configuration of the exported components.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ExportThemes": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#ExportThemesRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#ExportThemesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "GET", + "uri": "/export/app/{appId}/environment/{environmentName}/themes", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amplifyuibuilder#ExportThemesRequest": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the Amplify app to export the themes to.

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

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

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ExportThemesResponse": { + "type": "structure", + "members": { + "entities": { + "target": "com.amazonaws.amplifyuibuilder#ThemeList", + "traits": { + "smithy.api#documentation": "

Represents the configuration of the exported themes.

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

The name of the component to retrieve a value from.

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

The property to retrieve a value from.

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

Describes how to bind a component property to form data.

" + } + }, + "com.amazonaws.amplifyuibuilder#FormBindings": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#FormBindingElement" + } + }, + "com.amazonaws.amplifyuibuilder#GetComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#GetComponentRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#GetComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an existing component for an Amplify app.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app/{appId}/environment/{environmentName}/components/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amplifyuibuilder#GetComponentRequest": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the Amplify app.

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

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

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

The unique ID of the component.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#GetComponentResponse": { + "type": "structure", + "members": { + "component": { + "target": "com.amazonaws.amplifyuibuilder#Component", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Represents the configuration settings for the component.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#GetTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#GetThemeRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#GetThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an existing theme for an Amplify app.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app/{appId}/environment/{environmentName}/themes/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amplifyuibuilder#GetThemeRequest": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the Amplify app.

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

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

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

The unique ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#GetThemeResponse": { + "type": "structure", + "members": { + "theme": { + "target": "com.amazonaws.amplifyuibuilder#Theme", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Represents the configuration settings for the theme.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#IdentifierList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.amplifyuibuilder#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

An internal error has occurred. Please retry your request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.amplifyuibuilder#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

An invalid or out-of-range value was supplied for the input parameter.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.amplifyuibuilder#ListComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#ListComponentsRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#ListComponentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "GET", + "uri": "/app/{appId}/environment/{environmentName}/components", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "entities", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amplifyuibuilder#ListComponentsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.amplifyuibuilder#ListComponentsRequest": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID for the Amplify app.

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

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

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

The token to request the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.amplifyuibuilder#ListComponentsLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of components to retrieve.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ListComponentsResponse": { + "type": "structure", + "members": { + "entities": { + "target": "com.amazonaws.amplifyuibuilder#ComponentSummaryList", + "traits": { + "smithy.api#documentation": "

The list of components for the Amplify app.

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

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

" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ListThemes": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#ListThemesRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#ListThemesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#http": { + "method": "GET", + "uri": "/app/{appId}/environment/{environmentName}/themes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "entities", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amplifyuibuilder#ListThemesLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.amplifyuibuilder#ListThemesRequest": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID for the Amplify app.

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

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

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

The token to request the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.amplifyuibuilder#ListThemesLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of theme results to return in the response.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#ListThemesResponse": { + "type": "structure", + "members": { + "entities": { + "target": "com.amazonaws.amplifyuibuilder#ThemeSummaryList", + "traits": { + "smithy.api#documentation": "

The list of themes for the Amplify app.

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

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

" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#Predicate": { + "type": "structure", + "members": { + "or": { + "target": "com.amazonaws.amplifyuibuilder#PredicateList", + "traits": { + "smithy.api#documentation": "

A list of predicates to combine logically.

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

A list of predicates to combine logically.

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

The field to query.

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

The operator to use to perform the evaluation.

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

The value to use when performing the evaluation.

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

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

" + } + }, + "com.amazonaws.amplifyuibuilder#PredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#Predicate" + } + }, + "com.amazonaws.amplifyuibuilder#RefreshToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#RefreshTokenRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#RefreshTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Refreshes a previously issued access token that might have expired.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tokens/{provider}/refresh", + "code": 200 + } + } + }, + "com.amazonaws.amplifyuibuilder#RefreshTokenRequest": { + "type": "structure", + "members": { + "provider": { + "target": "com.amazonaws.amplifyuibuilder#TokenProviders", + "traits": { + "smithy.api#documentation": "

The third-party provider for the token. The only valid value is figma.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "refreshTokenBody": { + "target": "com.amazonaws.amplifyuibuilder#RefreshTokenRequestBody", + "traits": { + "smithy.api#documentation": "

Information about the refresh token request.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#RefreshTokenRequestBody": { + "type": "structure", + "members": { + "token": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token to use to refresh a previously issued access token that might have\n expired.

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

Describes a refresh token.

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

The access token.

", + "smithy.api#required": {}, + "smithy.api#sensitive": {} + } + }, + "expiresIn": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The date and time when the new access token expires.

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

The resource specified in the request conflicts with an existing resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.amplifyuibuilder#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The requested resource does not exist, or access was denied.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.amplifyuibuilder#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

You exceeded your service quota. Service quotas, also referred to as limits, are the\n maximum number of service resources or operations for your Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.amplifyuibuilder#SortDirection": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC" + }, + { + "value": "DESC" + } + ] + } + }, + "com.amazonaws.amplifyuibuilder#SortProperty": { + "type": "structure", + "members": { + "field": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The field to perform the sort on.

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

The direction of the sort, either ascending or descending.

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

Describes how to sort the data that you bind to a component.

" + } + }, + "com.amazonaws.amplifyuibuilder#SortPropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#SortProperty" + } + }, + "com.amazonaws.amplifyuibuilder#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.amplifyuibuilder#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.amplifyuibuilder#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.amplifyuibuilder#TagKey" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#TagValue" + } + }, + "com.amazonaws.amplifyuibuilder#Theme": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID for the Amplify app associated with the theme.

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

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

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

The ID for the theme.

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

The name of the theme.

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

The time that the theme was created.

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

The time that the theme was modified.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "values": { + "target": "com.amazonaws.amplifyuibuilder#ThemeValuesList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that defines the properties of the theme.

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

Describes the properties that can be overriden to customize a theme.

" + } + }, + "tags": { + "target": "com.amazonaws.amplifyuibuilder#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

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

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

A theme is a collection of style settings that apply globally to the components associated\n with an Amplify application.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.amplifyuibuilder#ThemeResource" + } + ] + } + }, + "com.amazonaws.amplifyuibuilder#ThemeList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#Theme" + } + }, + "com.amazonaws.amplifyuibuilder#ThemeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.amplifyuibuilder#ThemeResource": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.amplifyuibuilder#Uuid" + }, + "appId": { + "target": "smithy.api#String" + }, + "environmentName": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.amplifyuibuilder#CreateTheme" + }, + "read": { + "target": "com.amazonaws.amplifyuibuilder#GetTheme" + }, + "update": { + "target": "com.amazonaws.amplifyuibuilder#UpdateTheme" + }, + "delete": { + "target": "com.amazonaws.amplifyuibuilder#DeleteTheme" + }, + "list": { + "target": "com.amazonaws.amplifyuibuilder#ListThemes" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.amplifyuibuilder#ExportThemes" + } + ], + "traits": { + "aws.api#arn": { + "template": "app/{appId}/environment/{environmentName}/themes/{id}", + "absolute": false, + "noAccount": false, + "noRegion": false + }, + "aws.cloudformation#cfnResource": { + "additionalSchemas": [ + "com.amazonaws.amplifyuibuilder#Theme" + ], + "name": "Theme" + } + } + }, + "com.amazonaws.amplifyuibuilder#ThemeSummary": { + "type": "structure", + "members": { + "appId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID for the app associated with the theme summary.

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

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

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

The ID of the theme.

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

The name of the theme.

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

Describes the basic information about a theme.

" + } + }, + "com.amazonaws.amplifyuibuilder#ThemeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#ThemeSummary" + } + }, + "com.amazonaws.amplifyuibuilder#ThemeValue": { + "type": "structure", + "members": { + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value of a theme property.

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

A list of key-value pairs that define the theme's properties.

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

Describes the configuration of a theme's properties.

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

The name of the property.

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

The value of the property.

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

A key-value pair that defines a property of a theme.

" + } + }, + "com.amazonaws.amplifyuibuilder#ThemeValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#ThemeValues" + } + }, + "com.amazonaws.amplifyuibuilder#TokenProviders": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "figma", + "name": "FIGMA", + "documentation": "The figma token provider." + } + ] + } + }, + "com.amazonaws.amplifyuibuilder#UpdateComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#UpdateComponentRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#UpdateComponentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing component.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/app/{appId}/environment/{environmentName}/components/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amplifyuibuilder#UpdateComponentData": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.amplifyuibuilder#Uuid", + "traits": { + "smithy.api#documentation": "

The unique ID of the component to update.

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

The name of the component to update.

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

The unique ID of the component in its original source system, such as Figma.

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

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

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

Describes the component's properties.

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

The components that are instances of the main component.

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

A list of the unique variants of the main component being updated.

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

Describes the properties that can be overriden to customize the component.

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

The data binding information for the component's properties.

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

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

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

Updates and saves all of the information about a component, based on component ID.

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

The unique ID for the Amplify app.

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

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

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

The unique ID for the component.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The unique client token.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "updatedComponent": { + "target": "com.amazonaws.amplifyuibuilder#UpdateComponentData", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The configuration of the updated component.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#UpdateComponentResponse": { + "type": "structure", + "members": { + "entity": { + "target": "com.amazonaws.amplifyuibuilder#Component", + "traits": { + "smithy.api#documentation": "

Describes the configuration of the updated component.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#UpdateTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#UpdateThemeRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#UpdateThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing theme.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/app/{appId}/environment/{environmentName}/themes/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.amplifyuibuilder#UpdateThemeData": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.amplifyuibuilder#Uuid", + "traits": { + "smithy.api#documentation": "

The unique ID of the theme to update.

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

The name of the theme to update.

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

A list of key-value pairs that define the theme's properties.

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

Describes the properties that can be overriden to customize the theme.

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

Saves the data binding information for a theme.

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

The unique ID for the Amplify app.

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

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

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

The unique ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The unique client token.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "updatedTheme": { + "target": "com.amazonaws.amplifyuibuilder#UpdateThemeData", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The configuration of the updated theme.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#UpdateThemeResponse": { + "type": "structure", + "members": { + "entity": { + "target": "com.amazonaws.amplifyuibuilder#Theme", + "traits": { + "smithy.api#documentation": "

Describes the configuration of the updated theme.

", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.amplifyuibuilder#Uuid": { + "type": "string" + } + } +} diff --git a/aws/sdk/aws-models/apigateway.json b/aws/sdk/aws-models/apigateway.json index 034e3db749..b7202b6fcb 100644 --- a/aws/sdk/aws-models/apigateway.json +++ b/aws/sdk/aws-models/apigateway.json @@ -8839,7 +8839,7 @@ "limit": { "target": "com.amazonaws.apigateway#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of requests that can be made in a given time period.

" + "smithy.api#documentation": "

The target maximum number of requests that can be made in a given time period.

" } }, "offset": { @@ -9755,13 +9755,13 @@ "burstLimit": { "target": "com.amazonaws.apigateway#Integer", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

" } }, "rateLimit": { "target": "com.amazonaws.apigateway#Double", "traits": { - "smithy.api#documentation": "

The API request steady-state rate limit.

" + "smithy.api#documentation": "

The API target request rate limit.

" } } }, @@ -11415,13 +11415,13 @@ "throttle": { "target": "com.amazonaws.apigateway#ThrottleSettings", "traits": { - "smithy.api#documentation": "

The request throttle limits of a usage plan.

" + "smithy.api#documentation": "

Map containing method level throttling information for API stage in a usage plan.

" } }, "quota": { "target": "com.amazonaws.apigateway#QuotaSettings", "traits": { - "smithy.api#documentation": "

The maximum number of permitted requests per a given unit time interval.

" + "smithy.api#documentation": "

The target maximum number of permitted requests per a given unit time interval.

" } }, "productCode": { @@ -11438,7 +11438,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

\n
\n

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.

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

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 AWS Budgets to monitor costs \n and AWS WAF to manage API requests.

\n
\n

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.

\n
\n " } }, "com.amazonaws.apigateway#UsagePlanKey": { diff --git a/aws/sdk/aws-models/appstream.json b/aws/sdk/aws-models/appstream.json index 8e1bc32d52..667c0ca134 100644 --- a/aws/sdk/aws-models/appstream.json +++ b/aws/sdk/aws-models/appstream.json @@ -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": "

Associates an application to entitle.

" + } + }, + "com.amazonaws.appstream#AssociateApplicationToEntitlementRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "

The name of the stack.

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

The name of the entitlement.

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

The identifier of the application.

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

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.

" + } + }, + "com.amazonaws.appstream#CreateEntitlementRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "

The name of the entitlement.

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

The name of the stack with which the entitlement is associated.

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

The description of the entitlement.

" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "

Specifies whether all or selected apps are entitled.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "

The attributes of the entitlement.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#CreateEntitlementResult": { + "type": "structure", + "members": { + "Entitlement": { + "target": "com.amazonaws.appstream#Entitlement", + "traits": { + "smithy.api#documentation": "

The entitlement.

" + } + } + } + }, "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": "

Deletes the specified entitlement.

" + } + }, + "com.amazonaws.appstream#DeleteEntitlementRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "

The name of the entitlement.

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

The name of the stack with which the entitlement is associated.

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

Retrieves a list that describes one of more entitlements.

" + } + }, + "com.amazonaws.appstream#DescribeEntitlementsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "

The name of the entitlement.

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

The name of the stack with which the entitlement is associated.

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

The pagination token used to retrieve the next page of results for this operation.

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

The maximum size of each page of results.

" + } + } + } + }, + "com.amazonaws.appstream#DescribeEntitlementsResult": { + "type": "structure", + "members": { + "Entitlements": { + "target": "com.amazonaws.appstream#EntitlementList", + "traits": { + "smithy.api#documentation": "

The entitlements.

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

The pagination token used to retrieve the next page of results for this\n operation.

" + } + } + } + }, "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": "

Deletes the specified application from the specified entitlement.

" + } + }, + "com.amazonaws.appstream#DisassociateApplicationFromEntitlementRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "

The name of the stack with which the entitlement is associated.

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

The name of the entitlement.

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

The identifier of the application to remove from the entitlement.

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

The identifier of the application.

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

The application associated to an entitlement. Access is controlled based on user attributes.

" + } + }, + "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": "

The name of the entitlement.

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

The name of the stack with which the entitlement is associated.

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

The description of the entitlement.

" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "

Specifies whether all or selected apps are entitled.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "

The attributes of the entitlement.

", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the entitlement was created.

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

The time when the entitlement was last modified.

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

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.

" + } + }, + "com.amazonaws.appstream#EntitlementAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The entitlement already exists.

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

A supported AWS IAM SAML PrincipalTag attribute that is matched to the\n associated value when a user identity federates into an Amazon AppStream 2.0 SAML\n application.

\n

The following are valid values:

\n
    \n
  • \n

    roles

    \n
  • \n
  • \n

    department

    \n
  • \n
  • \n

    organization

    \n
  • \n
  • \n

    groups

    \n
  • \n
  • \n

    title

    \n
  • \n
  • \n

    costCenter

    \n
  • \n
  • \n

    userType

    \n
  • \n
\n

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

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.

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

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.

" + } + }, + "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": "

The entitlement can't be found.

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

Retrieves a list of entitled applications.

" + } + }, + "com.amazonaws.appstream#ListEntitledApplicationsRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "

The name of the stack with which the entitlement is associated.

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

The name of the entitlement.

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

The pagination token used to retrieve the next page of results for this operation.

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

The maximum size of each page of results.

" + } + } + } + }, + "com.amazonaws.appstream#ListEntitledApplicationsResult": { + "type": "structure", + "members": { + "EntitledApplications": { + "target": "com.amazonaws.appstream#EntitledApplicationList", + "traits": { + "smithy.api#documentation": "

The entitled applications.

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

The pagination token used to retrieve the next page of results for this operation.

" + } + } + } + }, "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": "

Updates the specified entitlement.

" + } + }, + "com.amazonaws.appstream#UpdateEntitlementRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "

The name of the entitlement.

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

The name of the stack with which the entitlement is associated.

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

The description of the entitlement.

" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "

Specifies whether all or only selected apps are entitled.

" + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "

The attributes of the entitlement.

" + } + } + } + }, + "com.amazonaws.appstream#UpdateEntitlementResult": { + "type": "structure", + "members": { + "Entitlement": { + "target": "com.amazonaws.appstream#Entitlement", + "traits": { + "smithy.api#documentation": "

The entitlement.

" + } + } + } + }, "com.amazonaws.appstream#UpdateFleet": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/appsync.json b/aws/sdk/aws-models/appsync.json index c885c728bb..8be4c799ec 100644 --- a/aws/sdk/aws-models/appsync.json +++ b/aws/sdk/aws-models/appsync.json @@ -31,8 +31,29 @@ "shapes": { "com.amazonaws.appsync#AWSDeepdishControlPlaneService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "AppSync", + "arnNamespace": "appsync", + "cloudFormationName": "AppSync", + "cloudTrailEventSource": "appsync.amazonaws.com", + "endpointPrefix": "appsync" + }, + "aws.auth#sigv4": { + "name": "appsync" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

AppSync provides API actions for creating and interacting with data\n sources using GraphQL from your application.

", + "smithy.api#title": "AWS AppSync", + "smithy.api#xmlNamespace": { + "uri": "http://appsync.amazonaws.com" + } + }, "version": "2017-07-25", "operations": [ + { + "target": "com.amazonaws.appsync#AssociateApi" + }, { "target": "com.amazonaws.appsync#CreateApiCache" }, @@ -42,6 +63,9 @@ { "target": "com.amazonaws.appsync#CreateDataSource" }, + { + "target": "com.amazonaws.appsync#CreateDomainName" + }, { "target": "com.amazonaws.appsync#CreateFunction" }, @@ -63,6 +87,9 @@ { "target": "com.amazonaws.appsync#DeleteDataSource" }, + { + "target": "com.amazonaws.appsync#DeleteDomainName" + }, { "target": "com.amazonaws.appsync#DeleteFunction" }, @@ -75,15 +102,24 @@ { "target": "com.amazonaws.appsync#DeleteType" }, + { + "target": "com.amazonaws.appsync#DisassociateApi" + }, { "target": "com.amazonaws.appsync#FlushApiCache" }, + { + "target": "com.amazonaws.appsync#GetApiAssociation" + }, { "target": "com.amazonaws.appsync#GetApiCache" }, { "target": "com.amazonaws.appsync#GetDataSource" }, + { + "target": "com.amazonaws.appsync#GetDomainName" + }, { "target": "com.amazonaws.appsync#GetFunction" }, @@ -108,6 +144,9 @@ { "target": "com.amazonaws.appsync#ListDataSources" }, + { + "target": "com.amazonaws.appsync#ListDomainNames" + }, { "target": "com.amazonaws.appsync#ListFunctions" }, @@ -144,6 +183,9 @@ { "target": "com.amazonaws.appsync#UpdateDataSource" }, + { + "target": "com.amazonaws.appsync#UpdateDomainName" + }, { "target": "com.amazonaws.appsync#UpdateFunction" }, @@ -156,25 +198,7 @@ { "target": "com.amazonaws.appsync#UpdateType" } - ], - "traits": { - "aws.api#service": { - "sdkId": "AppSync", - "arnNamespace": "appsync", - "cloudFormationName": "AppSync", - "cloudTrailEventSource": "appsync.amazonaws.com", - "endpointPrefix": "appsync" - }, - "aws.auth#sigv4": { - "name": "appsync" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AppSync provides API actions for creating and interacting with data\n sources using GraphQL from your application.

", - "smithy.api#title": "AWS AppSync", - "smithy.api#xmlNamespace": { - "uri": "http://appsync.amazonaws.com" - } - } + ] }, "com.amazonaws.appsync#AccessDeniedException": { "type": "structure", @@ -184,7 +208,7 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have access to perform this operation on this resource.

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

You don't have access to perform this operation on this resource.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -195,13 +219,13 @@ "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { - "smithy.api#documentation": "

The authentication type: API key, Identity and Access Management, OIDC, Amazon Cognito user\n pools, or Amazon Web Services Lambda.

" + "smithy.api#documentation": "

The authentication type: API key, Identity and Access Management (IAM), OpenID\n Connect (OIDC), Amazon Cognito user pools, or Lambda.

" } }, "openIDConnectConfig": { "target": "com.amazonaws.appsync#OpenIDConnectConfig", "traits": { - "smithy.api#documentation": "

The OpenID Connect configuration.

" + "smithy.api#documentation": "

The OIDC configuration.

" } }, "userPoolConfig": { @@ -213,7 +237,7 @@ "lambdaAuthorizerConfig": { "target": "com.amazonaws.appsync#LambdaAuthorizerConfig", "traits": { - "smithy.api#documentation": "

Configuration for Amazon Web Services Lambda function authorization.

" + "smithy.api#documentation": "

Configuration for Lambda function authorization.

" } } }, @@ -227,13 +251,45 @@ "target": "com.amazonaws.appsync#AdditionalAuthenticationProvider" } }, + "com.amazonaws.appsync#ApiAssociation": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

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

The API ID.

" + } + }, + "associationStatus": { + "target": "com.amazonaws.appsync#AssociationStatus", + "traits": { + "smithy.api#documentation": "

Identifies the status of an association.

\n
    \n
  • \n

    \n PROCESSING: The API association is being\n created. You cannot modify association requests during processing.

    \n
  • \n
  • \n

    \n SUCCESS: The API association was successful.\n You can modify associations after success.

    \n
  • \n
  • \n

    \n FAILED: The API association has failed. You\n can modify associations after failure.

    \n
  • \n
" + } + }, + "deploymentDetail": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

Details about the last deployment status.

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

Describes an ApiAssociation object.

" + } + }, "com.amazonaws.appsync#ApiCache": { "type": "structure", "members": { "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

TTL in seconds for cache entries.

\n

Valid values are between 1 and 3600 seconds.

" + "smithy.api#documentation": "

TTL in seconds for cache entries.

\n

Valid values are 1–3,600 seconds.

" } }, "apiCachingBehavior": { @@ -245,13 +301,13 @@ "transitEncryptionEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

Transit encryption flag when connecting to cache. This setting cannot be updated after\n creation.

" + "smithy.api#documentation": "

Transit encryption flag when connecting to cache. You cannot update this setting after\n creation.

" } }, "atRestEncryptionEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

At rest encryption flag for cache. This setting cannot be updated after creation.

" + "smithy.api#documentation": "

At-rest encryption flag for cache. You cannot update this setting after creation.

" } }, "type": { @@ -409,7 +465,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an API key.

\n

Customers invoke AppSync GraphQL API operations with API keys as an\n identity mechanism. There are two key versions:

\n

\n da1: This version was introduced at launch in November\n 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB\n TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that\n date.

\n
    \n
  • \n

    \n ListApiKeys returns the expiration time in milliseconds.

    \n
  • \n
  • \n

    \n CreateApiKey returns the expiration time in\n milliseconds.

    \n
  • \n
  • \n

    \n UpdateApiKey is not available for this key version.

    \n
  • \n
  • \n

    \n DeleteApiKey deletes the item from the table.

    \n
  • \n
  • \n

    Expiration is stored in Amazon DynamoDB as milliseconds. This results in a bug\n where keys are not automatically deleted because DynamoDB expects the TTL to be\n stored in seconds. As a one-time action, we will delete these keys from the table\n after February 21, 2018.

    \n
  • \n
\n

\n da2: This version was introduced in February 2018 when\n AppSync added support to extend key expiration.

\n
    \n
  • \n

    \n ListApiKeys returns the expiration time and deletion time in\n seconds.

    \n
  • \n
  • \n

    \n CreateApiKey returns the expiration time and deletion time in\n seconds and accepts a user-provided expiration time in seconds.

    \n
  • \n
  • \n

    \n UpdateApiKey returns the expiration time and and deletion time in\n seconds and accepts a user-provided expiration time in seconds. Expired API keys are\n kept for 60 days after the expiration time. Key expiration time can be updated while\n the key is not deleted.

    \n
  • \n
  • \n

    \n DeleteApiKey deletes the item from the table.

    \n
  • \n
  • \n

    Expiration is stored in Amazon DynamoDB as seconds. After the expiration time,\n using the key to authenticate will fail. But the key can be reinstated before\n deletion.

    \n
  • \n
  • \n

    Deletion is stored in Amazon DynamoDB as seconds. The key will be deleted after\n deletion time.

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

Describes an API key.

\n

Customers invoke AppSync GraphQL API operations with API keys as an\n identity mechanism. There are two key versions:

\n

\n da1: We introduced this version at launch in November\n 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key\n expiration. These keys ceased to be valid after February 21, 2018, and they should no\n longer be used.

\n
    \n
  • \n

    \n ListApiKeys returns the expiration time in milliseconds.

    \n
  • \n
  • \n

    \n CreateApiKey returns the expiration time in\n milliseconds.

    \n
  • \n
  • \n

    \n UpdateApiKey is not available for this key version.

    \n
  • \n
  • \n

    \n DeleteApiKey deletes the item from the table.

    \n
  • \n
  • \n

    Expiration is stored in DynamoDB as milliseconds. This results in a\n bug where keys are not automatically deleted because DynamoDB expects the\n TTL to be stored in seconds. As a one-time action, we deleted these keys from the\n table on February 21, 2018.

    \n
  • \n
\n

\n da2: We introduced this version in February 2018 when\n AppSync added support to extend key expiration.

\n
    \n
  • \n

    \n ListApiKeys returns the expiration time and deletion time in\n seconds.

    \n
  • \n
  • \n

    \n CreateApiKey returns the expiration time and deletion time in\n seconds and accepts a user-provided expiration time in seconds.

    \n
  • \n
  • \n

    \n UpdateApiKey returns the expiration time and and deletion time in\n seconds and accepts a user-provided expiration time in seconds. Expired API keys are\n kept for 60 days after the expiration time. You can update the key expiration time as\n long as the key isn't deleted.

    \n
  • \n
  • \n

    \n DeleteApiKey deletes the item from the table.

    \n
  • \n
  • \n

    Expiration is stored in DynamoDB as seconds. After the expiration\n time, using the key to authenticate will fail. However, you can reinstate the key\n before deletion.

    \n
  • \n
  • \n

    Deletion is stored in DynamoDB as seconds. The key is deleted after\n deletion time.

    \n
  • \n
" } }, "com.amazonaws.appsync#ApiKeyLimitExceededException": { @@ -457,6 +513,87 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.appsync#AssociateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#AssociateApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#AssociateApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Maps an endpoint to your custom domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domainnames/{domainName}/apiassociation", + "code": 200 + } + } + }, + "com.amazonaws.appsync#AssociateApiRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appsync#AssociateApiResponse": { + "type": "structure", + "members": { + "apiAssociation": { + "target": "com.amazonaws.appsync#ApiAssociation", + "traits": { + "smithy.api#documentation": "

The ApiAssociation object.

" + } + } + } + }, + "com.amazonaws.appsync#AssociationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROCESSING", + "name": "Processing" + }, + { + "value": "FAILED", + "name": "Failed" + }, + { + "value": "SUCCESS", + "name": "Success" + } + ] + } + }, "com.amazonaws.appsync#AuthenticationType": { "type": "string", "traits": { @@ -490,19 +627,19 @@ "authorizationType": { "target": "com.amazonaws.appsync#AuthorizationType", "traits": { - "smithy.api#documentation": "

The authorization type required by the HTTP endpoint.

\n
    \n
  • \n

    \n AWS_IAM: The authorization type is\n Sigv4.

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

The authorization type that the HTTP endpoint requires.

\n
    \n
  • \n

    \n AWS_IAM: The authorization type is Signature\n Version 4 (SigV4).

    \n
  • \n
", "smithy.api#required": {} } }, "awsIamConfig": { "target": "com.amazonaws.appsync#AwsIamConfig", "traits": { - "smithy.api#documentation": "

The Identity and Access Management settings.

" + "smithy.api#documentation": "

The Identity and Access Management (IAM) settings.

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

The authorization config in case the HTTP endpoint requires authorization.

" + "smithy.api#documentation": "

The authorization configuration in case the HTTP endpoint requires authorization.

" } }, "com.amazonaws.appsync#AuthorizationType": { @@ -522,18 +659,18 @@ "signingRegion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The signing region for Identity and Access Management authorization.

" + "smithy.api#documentation": "

The signing Amazon Web Services Region for IAM authorization.

" } }, "signingServiceName": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The signing service name for Identity and Access Management authorization.

" + "smithy.api#documentation": "

The signing service name for IAM authorization.

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

The Identity and Access Management configuration.

" + "smithy.api#documentation": "

The Identity and Access Management (IAM) configuration.

" } }, "com.amazonaws.appsync#BadRequestException": { @@ -544,7 +681,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request is not well formed. For example, a value is invalid or a required field is\n missing. Check the field values, and then try again.

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

The request is not well formed. For example, a value is invalid or a required field is\n missing. Check the field values, and then try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -567,18 +704,18 @@ "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

The TTL in seconds for a resolver that has caching enabled.

\n

Valid values are between 1 and 3600 seconds.

" + "smithy.api#documentation": "

The TTL in seconds for a resolver that has caching activated.

\n

Valid values are 1–3,600 seconds.

" } }, "cachingKeys": { "target": "com.amazonaws.appsync#CachingKeys", "traits": { - "smithy.api#documentation": "

The caching keys for a resolver that has caching enabled.

\n

Valid values are entries from the $context.arguments,\n $context.source, and $context.identity maps.

" + "smithy.api#documentation": "

The caching keys for a resolver that has caching activated.

\n

Valid values are entries from the $context.arguments,\n $context.source, and $context.identity maps.

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

The caching configuration for a resolver that has caching enabled.

" + "smithy.api#documentation": "

The caching configuration for a resolver that has caching activated.

" } }, "com.amazonaws.appsync#CachingKeys": { @@ -587,6 +724,16 @@ "target": "com.amazonaws.appsync#String" } }, + "com.amazonaws.appsync#CertificateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$" + } + }, "com.amazonaws.appsync#CognitoUserPoolConfig": { "type": "structure", "members": { @@ -623,7 +770,7 @@ } }, "traits": { - "smithy.api#documentation": "

Another modification is in progress at this time and it must complete before you can\n make your change.

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

Another modification is in progress at this time and it must complete before you can\n make your change.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -706,7 +853,7 @@ "apiId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The GraphQL API Id.

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

The GraphQL API ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -714,20 +861,20 @@ "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

TTL in seconds for cache entries.

\n

Valid values are between 1 and 3600 seconds.

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

TTL in seconds for cache entries.

\n

Valid values are 1–3,600 seconds.

", "smithy.api#required": {} } }, "transitEncryptionEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

Transit encryption flag when connecting to cache. This setting cannot be updated after\n creation.

" + "smithy.api#documentation": "

Transit encryption flag when connecting to cache. You cannot update this setting after\n creation.

" } }, "atRestEncryptionEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

At rest encryption flag for cache. This setting cannot be updated after creation.

" + "smithy.api#documentation": "

At-rest encryption flag for cache. You cannot update this setting after creation.

" } }, "apiCachingBehavior": { @@ -795,7 +942,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a unique key that you can distribute to clients who are executing your\n API.

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

Creates a unique key that you can distribute to clients who invoke your API.

", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/apikeys", @@ -823,7 +970,7 @@ "expires": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

The time from creation time after which the API key expires. The date is represented as\n seconds since the epoch, rounded down to the nearest hour. The default value for this\n parameter is 7 days from creation time. For more information, see .

" + "smithy.api#documentation": "

From the creation time, the time after which the API key expires. The date is\n represented as seconds since the epoch, rounded down to the nearest hour. The default value\n for this parameter is 7 days from creation time. For more information, see .

" } } } @@ -907,7 +1054,7 @@ "serviceRoleArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Identity and Access Management service role ARN for the data source. The system assumes this\n role when accessing the data source.

" + "smithy.api#documentation": "

The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)\n for the data source. The system assumes this role when accessing the data source.

" } }, "dynamodbConfig": { @@ -919,7 +1066,7 @@ "lambdaConfig": { "target": "com.amazonaws.appsync#LambdaDataSourceConfig", "traits": { - "smithy.api#documentation": "

Amazon Web Services Lambda settings.

" + "smithy.api#documentation": "

Lambda settings.

" } }, "elasticsearchConfig": { @@ -959,6 +1106,70 @@ } } }, + "com.amazonaws.appsync#CreateDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#CreateDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.appsync#CreateDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom DomainName object.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domainnames", + "code": 200 + } + } + }, + "com.amazonaws.appsync#CreateDomainNameRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#required": {} + } + }, + "certificateArn": { + "target": "com.amazonaws.appsync#CertificateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager\n (ACM) certificate or an Identity and Access Management (IAM)\n server certificate.

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

A description of the DomainName.

" + } + } + } + }, + "com.amazonaws.appsync#CreateDomainNameResponse": { + "type": "structure", + "members": { + "domainNameConfig": { + "target": "com.amazonaws.appsync#DomainNameConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the DomainName.

" + } + } + } + }, "com.amazonaws.appsync#CreateFunction": { "type": "operation", "input": { @@ -982,7 +1193,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Function object.

\n

A function is a reusable entity. Multiple functions can be used to compose the resolver\n logic.

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

Creates a Function object.

\n

A function is a reusable entity. You can use multiple functions to compose the resolver\n logic.

", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/functions", @@ -1030,13 +1241,13 @@ "responseMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The Function response mapping template.

" + "smithy.api#documentation": "

The Function response mapping template.

" } }, "functionVersion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The version of the request mapping template. Currently the supported value\n is 2018-05-29.

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

The version of the request mapping template. Currently, the supported value\n is 2018-05-29.

", "smithy.api#required": {} } }, @@ -1112,7 +1323,7 @@ "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { - "smithy.api#documentation": "

The authentication type: API key, Identity and Access Management, OIDC, Amazon Cognito user\n pools, or Amazon Web Services Lambda.

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

The authentication type: API key, Identity and Access Management (IAM), OpenID\n Connect (OIDC), Amazon Cognito user pools, or Lambda.

", "smithy.api#required": {} } }, @@ -1125,7 +1336,7 @@ "openIDConnectConfig": { "target": "com.amazonaws.appsync#OpenIDConnectConfig", "traits": { - "smithy.api#documentation": "

The OpenID Connect configuration.

" + "smithy.api#documentation": "

The OIDC configuration.

" } }, "tags": { @@ -1143,13 +1354,13 @@ "xrayEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

A flag indicating whether to enable X-Ray tracing for the\n GraphqlApi.

" + "smithy.api#documentation": "

A flag indicating whether to use X-Ray tracing for the\n GraphqlApi.

" } }, "lambdaAuthorizerConfig": { "target": "com.amazonaws.appsync#LambdaAuthorizerConfig", "traits": { - "smithy.api#documentation": "

Configuration for Amazon Web Services Lambda function authorization.

" + "smithy.api#documentation": "

Configuration for Lambda function authorization.

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

Creates a Resolver object.

\n

A resolver converts incoming requests into a format that a data source can understand\n and converts the data source's responses into GraphQL.

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

Creates a Resolver object.

\n

A resolver converts incoming requests into a format that a data source can understand,\n and converts the data source's responses into GraphQL.

", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", @@ -1231,19 +1442,19 @@ "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The mapping template to be used for requests.

\n

A resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).

\n

VTL request mapping templates are optional when using a Lambda data source. For all\n other data sources, VTL request and response mapping templates are required.

" + "smithy.api#documentation": "

The mapping template to use for requests.

\n

A resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).

\n

VTL request mapping templates are optional when using an Lambda data\n source. For all other data sources, VTL request and response mapping templates are\n required.

" } }, "responseMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The mapping template to be used for responses from the data source.

" + "smithy.api#documentation": "

The mapping template to use for responses from the data source.

" } }, "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { - "smithy.api#documentation": "

The resolver type.

\n
    \n
  • \n

    \n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. A UNIT resolver enables you to execute a GraphQL query\n against a single data source.

    \n
  • \n
  • \n

    \n PIPELINE: A PIPELINE resolver type. A PIPELINE\n resolver enables you to execute a series of Function in a serial manner.\n You can use a pipeline resolver to execute a GraphQL query against multiple data\n sources.

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

The resolver type.

\n
    \n
  • \n

    \n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.

    \n
  • \n
  • \n

    \n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.

    \n
  • \n
" } }, "pipelineConfig": { @@ -1255,7 +1466,7 @@ "syncConfig": { "target": "com.amazonaws.appsync#SyncConfig", "traits": { - "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned datasource.

" + "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned data source.

" } }, "cachingConfig": { @@ -1355,7 +1566,7 @@ "dataSourceArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The data source ARN.

" + "smithy.api#documentation": "

The data source Amazon Resource Name (ARN).

" } }, "name": { @@ -1373,25 +1584,25 @@ "type": { "target": "com.amazonaws.appsync#DataSourceType", "traits": { - "smithy.api#documentation": "

The type of the data source.

\n
    \n
  • \n

    \n AWS_LAMBDA: The data source is an Amazon Web Services Lambda function.

    \n
  • \n
  • \n

    \n AMAZON_DYNAMODB: The data source is an Amazon\n DynamoDB table.

    \n
  • \n
  • \n

    \n AMAZON_ELASTICSEARCH: The data source is an\n Amazon OpenSearch Service domain.

    \n
  • \n
  • \n

    \n AMAZON_OPENSEARCH_SERVICE: The data source is\n an Amazon OpenSearch Service domain.

    \n
  • \n
  • \n

    \n NONE: There is no data source. This type is\n used when you wish to invoke a GraphQL operation without connecting to a data source,\n such as performing data transformation with resolvers or triggering a subscription to\n be invoked from a mutation.

    \n
  • \n
  • \n

    \n HTTP: The data source is an HTTP\n endpoint.

    \n
  • \n
  • \n

    \n RELATIONAL_DATABASE: The data source is a\n relational database.

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

The type of the data source.

\n
    \n
  • \n

    \n AWS_LAMBDA: The data source is an Lambda function.

    \n
  • \n
  • \n

    \n AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.

    \n
  • \n
  • \n

    \n AMAZON_ELASTICSEARCH: The data source is an\n Amazon OpenSearch Service domain.

    \n
  • \n
  • \n

    \n AMAZON_OPENSEARCH_SERVICE: The data source is\n an Amazon OpenSearch Service domain.

    \n
  • \n
  • \n

    \n NONE: There is no data source. Use this type\n when you want to invoke a GraphQL operation without connecting to a data source, such\n as when you're performing data transformation with resolvers or invoking a\n subscription from a mutation.

    \n
  • \n
  • \n

    \n HTTP: The data source is an HTTP\n endpoint.

    \n
  • \n
  • \n

    \n RELATIONAL_DATABASE: The data source is a\n relational database.

    \n
  • \n
" } }, "serviceRoleArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Identity and Access Management service role ARN for the data source. The system assumes this\n role when accessing the data source.

" + "smithy.api#documentation": "

The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)\n for the data source. The system assumes this role when accessing the data source.

" } }, "dynamodbConfig": { "target": "com.amazonaws.appsync#DynamodbDataSourceConfig", "traits": { - "smithy.api#documentation": "

Amazon DynamoDB settings.

" + "smithy.api#documentation": "

DynamoDB settings.

" } }, "lambdaConfig": { "target": "com.amazonaws.appsync#LambdaDataSourceConfig", "traits": { - "smithy.api#documentation": "

Amazon Web Services Lambda settings.

" + "smithy.api#documentation": "

Lambda settings.

" } }, "elasticsearchConfig": { @@ -1651,6 +1862,57 @@ "type": "structure", "members": {} }, + "com.amazonaws.appsync#DeleteDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom DomainName object.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/domainnames/{domainName}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#DeleteDomainNameRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appsync#DeleteDomainNameResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.appsync#DeleteFunction": { "type": "operation", "input": { @@ -1821,19 +2083,117 @@ } } }, - "com.amazonaws.appsync#DeleteResolverResponse": { - "type": "structure", - "members": {} + "com.amazonaws.appsync#DeleteResolverResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.appsync#DeleteType": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#DeleteTypeRequest" + }, + "output": { + "target": "com.amazonaws.appsync#DeleteTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Type object.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/apis/{apiId}/types/{typeName}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#DeleteTypeRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "

The API ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.appsync#ResourceName", + "traits": { + "smithy.api#documentation": "

The type name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appsync#DeleteTypeResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.appsync#DeltaSyncConfig": { + "type": "structure", + "members": { + "baseTableTTL": { + "target": "com.amazonaws.appsync#Long", + "traits": { + "smithy.api#documentation": "

The number of minutes that an Item is stored in the data source.

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

The Delta Sync table name.

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

The number of minutes that a Delta Sync log entry is stored in the Delta Sync\n table.

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

Describes a Delta Sync configuration.

" + } + }, + "com.amazonaws.appsync#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } }, - "com.amazonaws.appsync#DeleteType": { + "com.amazonaws.appsync#DisassociateApi": { "type": "operation", "input": { - "target": "com.amazonaws.appsync#DeleteTypeRequest" + "target": "com.amazonaws.appsync#DisassociateApiRequest" }, "output": { - "target": "com.amazonaws.appsync#DeleteTypeResponse" + "target": "com.amazonaws.appsync#DisassociateApiResponse" }, "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, { "target": "com.amazonaws.appsync#BadRequestException" }, @@ -1845,69 +2205,86 @@ }, { "target": "com.amazonaws.appsync#NotFoundException" - }, - { - "target": "com.amazonaws.appsync#UnauthorizedException" } ], "traits": { - "smithy.api#documentation": "

Deletes a Type object.

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

Removes an ApiAssociation object from a custom domain.

", "smithy.api#http": { "method": "DELETE", - "uri": "/v1/apis/{apiId}/types/{typeName}", + "uri": "/domainnames/{domainName}/apiassociation", "code": 200 } } }, - "com.amazonaws.appsync#DeleteTypeRequest": { + "com.amazonaws.appsync#DisassociateApiRequest": { "type": "structure", "members": { - "apiId": { - "target": "com.amazonaws.appsync#String", - "traits": { - "smithy.api#documentation": "

The API ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "typeName": { - "target": "com.amazonaws.appsync#ResourceName", + "domainName": { + "target": "com.amazonaws.appsync#DomainName", "traits": { - "smithy.api#documentation": "

The type name.

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

The domain name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.appsync#DeleteTypeResponse": { + "com.amazonaws.appsync#DisassociateApiResponse": { "type": "structure", "members": {} }, - "com.amazonaws.appsync#DeltaSyncConfig": { + "com.amazonaws.appsync#DomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^(\\*[\\w\\d-]*\\.)?([\\w\\d-]+\\.)+[\\w\\d-]+$" + } + }, + "com.amazonaws.appsync#DomainNameConfig": { "type": "structure", "members": { - "baseTableTTL": { - "target": "com.amazonaws.appsync#Long", + "domainName": { + "target": "com.amazonaws.appsync#DomainName", "traits": { - "smithy.api#documentation": "

The number of minutes an Item is stored in the datasource.

" + "smithy.api#documentation": "

The domain name.

" } }, - "deltaSyncTableName": { + "description": { + "target": "com.amazonaws.appsync#Description", + "traits": { + "smithy.api#documentation": "

A description of the DomainName configuration.

" + } + }, + "certificateArn": { + "target": "com.amazonaws.appsync#CertificateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager\n (ACM) certificate or an Identity and Access Management (IAM)\n server certificate.

" + } + }, + "appsyncDomainName": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Delta Sync table name.

" + "smithy.api#documentation": "

The domain name that AppSync provides.

" } }, - "deltaSyncTableTTL": { - "target": "com.amazonaws.appsync#Long", + "hostedZoneId": { + "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The number of minutes a Delta Sync log entry is stored in the Delta Sync table.

" + "smithy.api#documentation": "

The ID of your Amazon RouteΒ 53 hosted zone.

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

Describes a Delta Sync configuration.

" + "smithy.api#documentation": "

Describes a configuration for a custom domain.

" + } + }, + "com.amazonaws.appsync#DomainNameConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#DomainNameConfig" } }, "com.amazonaws.appsync#DynamodbDataSourceConfig": { @@ -1936,7 +2313,7 @@ "deltaSyncConfig": { "target": "com.amazonaws.appsync#DeltaSyncConfig", "traits": { - "smithy.api#documentation": "

The DeltaSyncConfig for a versioned datasource.

" + "smithy.api#documentation": "

The DeltaSyncConfig for a versioned data source.

" } }, "versioned": { @@ -2063,7 +2440,7 @@ "functionArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The ARN of the Function object.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Function object.

" } }, "name": { @@ -2099,7 +2476,7 @@ "functionVersion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The version of the request mapping template. Currently only the 2018-05-29 version of\n the template is supported.

" + "smithy.api#documentation": "

The version of the request mapping template. Currently, only the 2018-05-29 version of\n the template is supported.

" } }, "syncConfig": { @@ -2107,7 +2484,7 @@ } }, "traits": { - "smithy.api#documentation": "

A function is a reusable entity. Multiple functions can be used to compose the resolver\n logic.

" + "smithy.api#documentation": "

A function is a reusable entity. You can use multiple functions to compose the resolver\n logic.

" } }, "com.amazonaws.appsync#Functions": { @@ -2122,6 +2499,61 @@ "target": "com.amazonaws.appsync#String" } }, + "com.amazonaws.appsync#GetApiAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetApiAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetApiAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves an ApiAssociation object.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domainnames/{domainName}/apiassociation", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetApiAssociationRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appsync#GetApiAssociationResponse": { + "type": "structure", + "members": { + "apiAssociation": { + "target": "com.amazonaws.appsync#ApiAssociation", + "traits": { + "smithy.api#documentation": "

The ApiAssociation object.

" + } + } + } + }, "com.amazonaws.appsync#GetApiCache": { "type": "operation", "input": { @@ -2252,6 +2684,61 @@ } } }, + "com.amazonaws.appsync#GetDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a custom DomainName object.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domainnames/{domainName}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#GetDomainNameRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appsync#GetDomainNameResponse": { + "type": "structure", + "members": { + "domainNameConfig": { + "target": "com.amazonaws.appsync#DomainNameConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the DomainName.

" + } + } + } + }, "com.amazonaws.appsync#GetFunction": { "type": "operation", "input": { @@ -2699,7 +3186,7 @@ "arn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The ARN.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" } }, "uris": { @@ -2723,19 +3210,19 @@ "xrayEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

A flag representing whether X-Ray tracing is enabled for this\n GraphqlApi.

" + "smithy.api#documentation": "

A flag indicating whether to use X-Ray tracing for this\n GraphqlApi.

" } }, "wafWebAclArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The ARN of the WAF ACL associated with this GraphqlApi,\n if one exists.

" + "smithy.api#documentation": "

The ARN of the WAF access control list (ACL) associated with this\n GraphqlApi, if one exists.

" } }, "lambdaAuthorizerConfig": { "target": "com.amazonaws.appsync#LambdaAuthorizerConfig", "traits": { - "smithy.api#documentation": "

Configuration for Amazon Web Services Lambda function authorization.

" + "smithy.api#documentation": "

Configuration for Lambda function authorization.

" } } }, @@ -2755,13 +3242,13 @@ "endpoint": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The HTTP URL endpoint. You can either specify the domain name or IP, and port\n combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified,\n AppSync uses the default port 80 for the HTTP endpoint and port 443 for\n HTTPS endpoints.

" + "smithy.api#documentation": "

The HTTP URL endpoint. You can specify either the domain name or IP, and port\n combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port,\n AppSync uses the default port 80 for the HTTP endpoint and port 443 for\n HTTPS endpoints.

" } }, "authorizationConfig": { "target": "com.amazonaws.appsync#AuthorizationConfig", "traits": { - "smithy.api#documentation": "

The authorization config in case the HTTP endpoint requires authorization.

" + "smithy.api#documentation": "

The authorization configuration in case the HTTP endpoint requires authorization.

" } } }, @@ -2788,13 +3275,13 @@ "authorizerResultTtlInSeconds": { "target": "com.amazonaws.appsync#TTL", "traits": { - "smithy.api#documentation": "

The number of seconds a response should be cached for. The default is 5 minutes (300\n seconds). The Lambda function can override this by returning a ttlOverride key\n in its response. A value of 0 disables caching of responses.

" + "smithy.api#documentation": "

The number of seconds a response should be cached for. The default is 5 minutes (300\n seconds). The Lambda function can override this by returning a\n ttlOverride key in its response. A value of 0 disables caching of\n responses.

" } }, "authorizerUri": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The ARN of the Lambda function to be called for authorization. This may be a standard\n Lambda ARN, a version ARN (.../v3) or alias ARN.

\n

\n Note: This Lambda function must have the following resource-based\n policy assigned to it. When configuring Lambda authorizers in the Console, this is done for\n you. To do so with the Amazon Web Services CLI, run the following:

\n

\n aws lambda add-permission --function-name\n \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\"\n --principal appsync.amazonaws.com --action lambda:InvokeFunction\n

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

The Amazon Resource Name (ARN) of the Lambda function to be called for\n authorization. This can be a standard Lambda ARN, a version ARN\n (.../v3), or an alias ARN.

\n

\n Note: This Lambda function must have the\n following resource-based policy assigned to it. When configuring Lambda\n authorizers in the console, this is done for you. To use the Command Line Interface\n (CLI), run the following:

\n

\n aws lambda add-permission --function-name\n \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\"\n --principal appsync.amazonaws.com --action lambda:InvokeFunction\n

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

A LambdaAuthorizerConfig holds configuration on how to authorize AppSync\n API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync\n API may have only one Lambda authorizer configured at a time.

" + "smithy.api#documentation": "

A LambdaAuthorizerConfig specifies how to authorize AppSync\n API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a\n time.

" } }, "com.amazonaws.appsync#LambdaConflictHandlerConfig": { @@ -2815,12 +3302,12 @@ "lambdaConflictHandlerArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Arn for the Lambda function to use as the Conflict Handler.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Lambda function to use as the\n Conflict Handler.

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

The LambdaConflictHandlerConfig object when configuring LAMBDA as the\n Conflict Handler.

" + "smithy.api#documentation": "

The LambdaConflictHandlerConfig object when configuring LAMBDA\n as the Conflict Handler.

" } }, "com.amazonaws.appsync#LambdaDataSourceConfig": { @@ -2829,13 +3316,13 @@ "lambdaFunctionArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The ARN for the Lambda function.

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

The Amazon Resource Name (ARN) for the Lambda function.

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

Describes an Amazon Web Services Lambda data source configuration.

" + "smithy.api#documentation": "

Describes an Lambda data source configuration.

" } }, "com.amazonaws.appsync#LimitExceededException": { @@ -2896,14 +3383,14 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

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

An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

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

The maximum number of results that you want the request to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -2921,7 +3408,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier to be passed in the next request to this operation to return the next set\n of items in the list.

" + "smithy.api#documentation": "

An identifier to pass in the next request to this operation to return the next set of\n items in the list.

" } } } @@ -2971,14 +3458,14 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

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

An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

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

The maximum number of results that you want the request to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -2996,7 +3483,71 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier to be passed in the next request to this operation to return the next set\n of items in the list.

" + "smithy.api#documentation": "

An identifier to pass in the next request to this operation to return the next set of\n items in the list.

" + } + } + } + }, + "com.amazonaws.appsync#ListDomainNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListDomainNamesRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListDomainNamesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists multiple custom domain names.

", + "smithy.api#http": { + "method": "GET", + "uri": "/domainnames", + "code": 200 + } + } + }, + "com.amazonaws.appsync#ListDomainNamesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "

The API token.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results that you want the request to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.appsync#ListDomainNamesResponse": { + "type": "structure", + "members": { + "domainNameConfigs": { + "target": "com.amazonaws.appsync#DomainNameConfigs", + "traits": { + "smithy.api#documentation": "

Lists configurations for multiple domain names.

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

The API token.

" } } } @@ -3046,14 +3597,14 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

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

An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

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

The maximum number of results that you want the request to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -3071,7 +3622,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.

" } } } @@ -3110,14 +3661,14 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

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

An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

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

The maximum number of results that you want the request to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -3135,7 +3686,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier to be passed in the next request to this operation to return the next set\n of items in the list.

" + "smithy.api#documentation": "

An identifier to pass in the next request to this operation to return the next set of\n items in the list.

" } } } @@ -3216,7 +3767,7 @@ "functionId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The Function ID.

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

The function ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3231,7 +3782,7 @@ "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

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

The maximum number of results that you want the request to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -3249,7 +3800,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier that can be used to return the next set of items in the list.

" + "smithy.api#documentation": "

An identifier that you can use to return the next set of items in the list.

" } } } @@ -3276,14 +3827,14 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

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

An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

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

The maximum number of results that you want the request to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -3301,7 +3852,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier to be passed in the next request to this operation to return the next set\n of items in the list.

" + "smithy.api#documentation": "

An identifier to pass in the next request to this operation to return the next set of\n items in the list.

" } } } @@ -3349,7 +3900,7 @@ "resourceArn": { "target": "com.amazonaws.appsync#ResourceArn", "traits": { - "smithy.api#documentation": "

The GraphqlApi ARN.

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

The GraphqlApi Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3423,14 +3974,14 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

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

An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.appsync#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results you want the request to return.

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

The maximum number of results that you want the request to return.

", "smithy.api#httpQuery": "maxResults" } } @@ -3448,7 +3999,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "

An identifier to be passed in the next request to this operation to return the next set\n of items in the list.

" + "smithy.api#documentation": "

An identifier to pass in the next request to this operation to return the next set of\n items in the list.

" } } } @@ -3459,14 +4010,14 @@ "fieldLogLevel": { "target": "com.amazonaws.appsync#FieldLogLevel", "traits": { - "smithy.api#documentation": "

The field logging level. Values can be NONE, ERROR, or ALL.

\n
    \n
  • \n

    \n NONE: No field-level logs are\n captured.

    \n
  • \n
  • \n

    \n ERROR: Logs the following information only for\n the fields that are in error:

    \n
      \n
    • \n

      The error section in the server response.

      \n
    • \n
    • \n

      Field-level errors.

      \n
    • \n
    • \n

      The generated request/response functions that got resolved for error\n fields.

      \n
    • \n
    \n
  • \n
  • \n

    \n ALL: The following information is logged for\n all fields in the query:

    \n
      \n
    • \n

      Field-level tracing information.

      \n
    • \n
    • \n

      The generated request/response functions that got resolved for each\n field.

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

The field logging level. Values can be NONE, ERROR, or ALL.

\n
    \n
  • \n

    \n NONE: No field-level logs are\n captured.

    \n
  • \n
  • \n

    \n ERROR: Logs the following information only for\n the fields that are in error:

    \n
      \n
    • \n

      The error section in the server response.

      \n
    • \n
    • \n

      Field-level errors.

      \n
    • \n
    • \n

      The generated request/response functions that got resolved for error\n fields.

      \n
    • \n
    \n
  • \n
  • \n

    \n ALL: The following information is logged for\n all fields in the query:

    \n
      \n
    • \n

      Field-level tracing information.

      \n
    • \n
    • \n

      The generated request/response functions that got resolved for each\n field.

      \n
    • \n
    \n
  • \n
", "smithy.api#required": {} } }, "cloudWatchLogsRoleArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The service role that AppSync will assume to publish to Amazon\n CloudWatch logs in your account.

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

The service role that AppSync assumes to publish to CloudWatch\n logs in your account.

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

The CloudWatch Logs configuration.

" + "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration.

" } }, "com.amazonaws.appsync#Long": { @@ -3530,31 +4081,31 @@ "issuer": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The issuer for the OpenID Connect configuration. The issuer returned by discovery must\n exactly match the value of iss in the ID token.

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

The issuer for the OIDC configuration. The issuer returned by discovery must exactly\n match the value of iss in the ID token.

", "smithy.api#required": {} } }, "clientId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The client identifier of the Relying party at the OpenID identity provider. This\n identifier is typically obtained when the Relying party is registered with the OpenID\n identity provider. You can specify a regular expression so the AppSync can\n validate against multiple client identifiers at a time.

" + "smithy.api#documentation": "

The client identifier of the relying party at the OpenID identity provider. This\n identifier is typically obtained when the relying party is registered with the OpenID\n identity provider. You can specify a regular expression so that AppSync can\n validate against multiple client identifiers at a time.

" } }, "iatTTL": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

The number of milliseconds a token is valid after being issued to a user.

" + "smithy.api#documentation": "

The number of milliseconds that a token is valid after it's issued to a user.

" } }, "authTTL": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

The number of milliseconds a token is valid after being authenticated.

" + "smithy.api#documentation": "

The number of milliseconds that a token is valid after being authenticated.

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

Describes an OpenID Connect configuration.

" + "smithy.api#documentation": "

Describes an OpenID Connect (OIDC) configuration.

" } }, "com.amazonaws.appsync#OpenSearchServiceDataSourceConfig": { @@ -3624,13 +4175,13 @@ "awsRegion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Amazon Web Services Region for RDS HTTP endpoint.

" + "smithy.api#documentation": "

Amazon Web Services Region for Amazon RDS HTTP endpoint.

" } }, "dbClusterIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Amazon RDS cluster ARN.

" + "smithy.api#documentation": "

Amazon RDS cluster Amazon Resource Name (ARN).

" } }, "databaseName": { @@ -3648,12 +4199,12 @@ "awsSecretStoreArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

Amazon Web Services secret store ARN for database credentials.

" + "smithy.api#documentation": "

Amazon Web Services secret store Amazon Resource Name (ARN) for database\n credentials.

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

The Amazon RDS HTTP endpoint configuration.

" + "smithy.api#documentation": "

The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.

" } }, "com.amazonaws.appsync#RelationalDatabaseDataSourceConfig": { @@ -3662,7 +4213,7 @@ "relationalDatabaseSourceType": { "target": "com.amazonaws.appsync#RelationalDatabaseSourceType", "traits": { - "smithy.api#documentation": "

Source type for the relational database.

\n
    \n
  • \n

    \n RDS_HTTP_ENDPOINT: The relational database\n source type is an Amazon RDS HTTP endpoint.

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

Source type for the relational database.

\n
    \n
  • \n

    \n RDS_HTTP_ENDPOINT: The relational database\n source type is an Amazon Relational Database Service (Amazon RDS) HTTP\n endpoint.

    \n
  • \n
" } }, "rdsHttpEndpointConfig": { @@ -3711,7 +4262,7 @@ "resolverArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The resolver ARN.

" + "smithy.api#documentation": "

The resolver Amazon Resource Name (ARN).

" } }, "requestMappingTemplate": { @@ -3729,7 +4280,7 @@ "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { - "smithy.api#documentation": "

The resolver type.

\n
    \n
  • \n

    \n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. A UNIT resolver enables you to execute a GraphQL query\n against a single data source.

    \n
  • \n
  • \n

    \n PIPELINE: A PIPELINE resolver type. A PIPELINE\n resolver enables you to execute a series of Function in a serial manner.\n You can use a pipeline resolver to execute a GraphQL query against multiple data\n sources.

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

The resolver type.

\n
    \n
  • \n

    \n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.

    \n
  • \n
  • \n

    \n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.

    \n
  • \n
" } }, "pipelineConfig": { @@ -3741,7 +4292,7 @@ "syncConfig": { "target": "com.amazonaws.appsync#SyncConfig", "traits": { - "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned datasource.

" + "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned data source.

" } }, "cachingConfig": { @@ -3901,24 +4452,24 @@ "conflictHandler": { "target": "com.amazonaws.appsync#ConflictHandlerType", "traits": { - "smithy.api#documentation": "

The Conflict Resolution strategy to perform in the event of a conflict.

\n
    \n
  • \n

    \n OPTIMISTIC_CONCURRENCY: Resolve conflicts by\n rejecting mutations when versions do not match the latest version at the\n server.

    \n
  • \n
  • \n

    \n AUTOMERGE: Resolve conflicts with the\n Automerge conflict resolution strategy.

    \n
  • \n
  • \n

    \n LAMBDA: Resolve conflicts with a Lambda\n function supplied in the LambdaConflictHandlerConfig.

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

The Conflict Resolution strategy to perform in the event of a conflict.

\n
    \n
  • \n

    \n OPTIMISTIC_CONCURRENCY: Resolve conflicts by\n rejecting mutations when versions don't match the latest version at the\n server.

    \n
  • \n
  • \n

    \n AUTOMERGE: Resolve conflicts with the\n Automerge conflict resolution strategy.

    \n
  • \n
  • \n

    \n LAMBDA: Resolve conflicts with an Lambda function supplied in the\n LambdaConflictHandlerConfig.

    \n
  • \n
" } }, "conflictDetection": { "target": "com.amazonaws.appsync#ConflictDetectionType", "traits": { - "smithy.api#documentation": "

The Conflict Detection strategy to use.

\n
    \n
  • \n

    \n VERSION: Detect conflicts based on object\n versions for this resolver.

    \n
  • \n
  • \n

    \n NONE: Do not detect conflicts when executing\n this resolver.

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

The Conflict Detection strategy to use.

\n
    \n
  • \n

    \n VERSION: Detect conflicts based on object\n versions for this resolver.

    \n
  • \n
  • \n

    \n NONE: Do not detect conflicts when invoking\n this resolver.

    \n
  • \n
" } }, "lambdaConflictHandlerConfig": { "target": "com.amazonaws.appsync#LambdaConflictHandlerConfig", "traits": { - "smithy.api#documentation": "

The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict\n Handler.

" + "smithy.api#documentation": "

The LambdaConflictHandlerConfig when configuring LAMBDA as the\n Conflict Handler.

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

Describes a Sync configuration for a resolver.

\n

Contains information on which Conflict Detection as well as Resolution strategy should\n be performed when the resolver is invoked.

" + "smithy.api#documentation": "

Describes a Sync configuration for a resolver.

\n

Specifies which Conflict Detection strategy and Resolution strategy to use when the\n resolver is invoked.

" } }, "com.amazonaws.appsync#TTL": { @@ -4012,7 +4563,7 @@ "resourceArn": { "target": "com.amazonaws.appsync#ResourceArn", "traits": { - "smithy.api#documentation": "

The GraphqlApi ARN.

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

The GraphqlApi Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4058,7 +4609,7 @@ "arn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The type ARN.

" + "smithy.api#documentation": "

The type Amazon Resource Name (ARN).

" } }, "definition": { @@ -4107,7 +4658,7 @@ } }, "traits": { - "smithy.api#documentation": "

You are not authorized to perform this operation.

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

You aren't authorized to perform this operation.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } @@ -4155,7 +4706,7 @@ "resourceArn": { "target": "com.amazonaws.appsync#ResourceArn", "traits": { - "smithy.api#documentation": "

The GraphqlApi ARN.

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

The GraphqlApi Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4214,7 +4765,7 @@ "apiId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The GraphQL API Id.

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

The GraphQL API ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4222,7 +4773,7 @@ "ttl": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

TTL in seconds for cache entries.

\n

Valid values are between 1 and 3600 seconds.

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

TTL in seconds for cache entries.

\n

Valid values are 1–3,600 seconds.

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

Updates an API key. The key can be updated while it is not deleted.

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

Updates an API key. You can update the key as long as it's not deleted.

", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/apikeys/{id}", @@ -4324,7 +4875,7 @@ "expires": { "target": "com.amazonaws.appsync#Long", "traits": { - "smithy.api#documentation": "

The time from update time after which the API key expires. The date is represented as\n seconds since the epoch. For more information, see .

" + "smithy.api#documentation": "

From the update time, the time after which the API key expires. The date is represented\n as seconds since the epoch. For more information, see .

" } } } @@ -4409,7 +4960,7 @@ "serviceRoleArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The new service role ARN for the data source.

" + "smithy.api#documentation": "

The new service role Amazon Resource Name (ARN) for the data source.

" } }, "dynamodbConfig": { @@ -4421,7 +4972,7 @@ "lambdaConfig": { "target": "com.amazonaws.appsync#LambdaDataSourceConfig", "traits": { - "smithy.api#documentation": "

The new Amazon Web Services Lambda configuration.

" + "smithy.api#documentation": "

The new Lambda configuration.

" } }, "elasticsearchConfig": { @@ -4461,6 +5012,70 @@ } } }, + "com.amazonaws.appsync#UpdateDomainName": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#UpdateDomainNameRequest" + }, + "output": { + "target": "com.amazonaws.appsync#UpdateDomainNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a custom DomainName object.

", + "smithy.api#http": { + "method": "POST", + "uri": "/domainnames/{domainName}", + "code": 200 + } + } + }, + "com.amazonaws.appsync#UpdateDomainNameRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.appsync#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appsync#Description", + "traits": { + "smithy.api#documentation": "

A description of the DomainName.

" + } + } + } + }, + "com.amazonaws.appsync#UpdateDomainNameResponse": { + "type": "structure", + "members": { + "domainNameConfig": { + "target": "com.amazonaws.appsync#DomainNameConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the DomainName.

" + } + } + } + }, "com.amazonaws.appsync#UpdateFunction": { "type": "operation", "input": { @@ -4540,13 +5155,13 @@ "responseMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The Function request mapping template.

" + "smithy.api#documentation": "

The Function request mapping template.

" } }, "functionVersion": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "

The version of the request mapping template. Currently the supported value\n is 2018-05-29.

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

The version of the request mapping template. Currently, the supported value\n is 2018-05-29.

", "smithy.api#required": {} } }, @@ -4636,7 +5251,7 @@ "userPoolConfig": { "target": "com.amazonaws.appsync#UserPoolConfig", "traits": { - "smithy.api#documentation": "

The new Amazon Cognito user pool configuration for the GraphqlApi\n object.

" + "smithy.api#documentation": "

The new Amazon Cognito user pool configuration for the ~GraphqlApi\n object.

" } }, "openIDConnectConfig": { @@ -4654,13 +5269,13 @@ "xrayEnabled": { "target": "com.amazonaws.appsync#Boolean", "traits": { - "smithy.api#documentation": "

A flag indicating whether to enable X-Ray tracing for the\n GraphqlApi.

" + "smithy.api#documentation": "

A flag indicating whether to use X-Ray tracing for the\n GraphqlApi.

" } }, "lambdaAuthorizerConfig": { "target": "com.amazonaws.appsync#LambdaAuthorizerConfig", "traits": { - "smithy.api#documentation": "

Configuration for Amazon Web Services Lambda function authorization.

" + "smithy.api#documentation": "

Configuration for Lambda function authorization.

" } } } @@ -4743,7 +5358,7 @@ "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "

The new request mapping template.

\n

A resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).

\n

VTL request mapping templates are optional when using a Lambda data source. For all\n other data sources, VTL request and response mapping templates are required.

" + "smithy.api#documentation": "

The new request mapping template.

\n

A resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).

\n

VTL request mapping templates are optional when using an Lambda data\n source. For all other data sources, VTL request and response mapping templates are\n required.

" } }, "responseMappingTemplate": { @@ -4755,7 +5370,7 @@ "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { - "smithy.api#documentation": "

The resolver type.

\n
    \n
  • \n

    \n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. A UNIT resolver enables you to execute a GraphQL query\n against a single data source.

    \n
  • \n
  • \n

    \n PIPELINE: A PIPELINE resolver type. A PIPELINE\n resolver enables you to execute a series of Function in a serial manner.\n You can use a pipeline resolver to execute a GraphQL query against multiple data\n sources.

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

The resolver type.

\n
    \n
  • \n

    \n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.

    \n
  • \n
  • \n

    \n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.

    \n
  • \n
" } }, "pipelineConfig": { @@ -4767,7 +5382,7 @@ "syncConfig": { "target": "com.amazonaws.appsync#SyncConfig", "traits": { - "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned datasource.

" + "smithy.api#documentation": "

The SyncConfig for a resolver attached to a versioned data source.

" } }, "cachingConfig": { @@ -4888,7 +5503,7 @@ "defaultAction": { "target": "com.amazonaws.appsync#DefaultAction", "traits": { - "smithy.api#documentation": "

The action that you want your GraphQL API to take when a request that uses Amazon\n Cognito user pool authentication doesn't match the Amazon Cognito user pool\n configuration.

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

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool\n configuration.

", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/chime-sdk-messaging.json b/aws/sdk/aws-models/chime-sdk-messaging.json index 3a7cd1cb33..812376a0e7 100644 --- a/aws/sdk/aws-models/chime-sdk-messaging.json +++ b/aws/sdk/aws-models/chime-sdk-messaging.json @@ -874,6 +874,18 @@ "traits": { "smithy.api#documentation": "

The message metadata.

" } + }, + "PushNotification": { + "target": "com.amazonaws.chimesdkmessaging#PushNotificationConfiguration", + "traits": { + "smithy.api#documentation": "

The push notification configuration of the message.

" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.chimesdkmessaging#MessageAttributeMap", + "traits": { + "smithy.api#documentation": "

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

" + } } }, "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": "

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 Amazon Chime SDK messaging\n

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

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 Amazon Chime SDK messaging\n

", - "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": "

The membership type of a user, DEFAULT or HIDDEN. Default\n members are always returned as part of ListChannelMemberships. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN. Otherwise hidden members are not returned.

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

The membership type of a user, DEFAULT or HIDDEN. Default\n members are returned as part of ListChannelMemberships if no type is specified. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN.

", "smithy.api#httpQuery": "type" } }, @@ -4475,22 +4487,19 @@ "Title": { "target": "com.amazonaws.chimesdkmessaging#PushNotificationTitle", "traits": { - "smithy.api#documentation": "

The title of the push notification.

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

The title of the push notification.

" } }, "Body": { "target": "com.amazonaws.chimesdkmessaging#PushNotificationBody", "traits": { - "smithy.api#documentation": "

The body of the push notification.

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

The body of the push notification.

" } }, "Type": { "target": "com.amazonaws.chimesdkmessaging#PushNotificationType", "traits": { - "smithy.api#documentation": "

Enum value that indicates the type of the push notification for a message.\n DEFAULT: Normal mobile push notification.\n VOIP: VOIP mobile push notification.

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

Enum value that indicates the type of the push notification for a message.\n DEFAULT: Normal mobile push notification.\n VOIP: VOIP mobile push notification.

" } } }, diff --git a/aws/sdk/aws-models/cloudtrail.json b/aws/sdk/aws-models/cloudtrail.json index 490e015b8a..f6f90077c1 100644 --- a/aws/sdk/aws-models/cloudtrail.json +++ b/aws/sdk/aws-models/cloudtrail.json @@ -41,6 +41,15 @@ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, @@ -84,7 +93,8 @@ "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList", "traits": { - "smithy.api#documentation": "

Contains a list of tags, up to a limit of 50

" + "smithy.api#documentation": "

Contains a list of tags, up to a limit of 50

", + "smithy.api#required": {} } } }, @@ -197,6 +207,86 @@ "com.amazonaws.cloudtrail#ByteBuffer": { "type": "blob" }, + "com.amazonaws.cloudtrail#CancelQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CancelQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CancelQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveQueryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#CancelQueryRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.

", + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery \n operation.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#CancelQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the canceled query.

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

Shows the status of a query after a CancelQuery request. Typically, the values shown are either \n RUNNING or CANCELLED.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.cloudtrail#CloudTrailARNInvalidException": { "type": "structure", "members": { @@ -282,30 +372,54 @@ { "target": "com.amazonaws.cloudtrail#AddTags" }, + { + "target": "com.amazonaws.cloudtrail#CancelQuery" + }, + { + "target": "com.amazonaws.cloudtrail#CreateEventDataStore" + }, { "target": "com.amazonaws.cloudtrail#CreateTrail" }, + { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStore" + }, { "target": "com.amazonaws.cloudtrail#DeleteTrail" }, + { + "target": "com.amazonaws.cloudtrail#DescribeQuery" + }, { "target": "com.amazonaws.cloudtrail#DescribeTrails" }, + { + "target": "com.amazonaws.cloudtrail#GetEventDataStore" + }, { "target": "com.amazonaws.cloudtrail#GetEventSelectors" }, { "target": "com.amazonaws.cloudtrail#GetInsightSelectors" }, + { + "target": "com.amazonaws.cloudtrail#GetQueryResults" + }, { "target": "com.amazonaws.cloudtrail#GetTrail" }, { "target": "com.amazonaws.cloudtrail#GetTrailStatus" }, + { + "target": "com.amazonaws.cloudtrail#ListEventDataStores" + }, { "target": "com.amazonaws.cloudtrail#ListPublicKeys" }, + { + "target": "com.amazonaws.cloudtrail#ListQueries" + }, { "target": "com.amazonaws.cloudtrail#ListTags" }, @@ -324,12 +438,21 @@ { "target": "com.amazonaws.cloudtrail#RemoveTags" }, + { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStore" + }, { "target": "com.amazonaws.cloudtrail#StartLogging" }, + { + "target": "com.amazonaws.cloudtrail#StartQuery" + }, { "target": "com.amazonaws.cloudtrail#StopLogging" }, + { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStore" + }, { "target": "com.amazonaws.cloudtrail#UpdateTrail" } @@ -375,6 +498,169 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.cloudtrail#CreateEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CreateEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CreateEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new event data store.

" + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStoreRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

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

The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event \n selectors, see Log events by using advanced event selectors in the CloudTrail \n User Guide.

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

Specifies whether the event data store includes events from all regions, or only from the region in which the event data store \n is created.

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

Specifies whether an event data store collects events logged for an organization in Organizations.

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

The retention period of the event data store, in days. You can set a retention period of up to 2555 days, \n the equivalent of seven years.

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

Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you \n cannot delete the event data store until termination protection is disabled.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + } + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

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

The name of the event data store.

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

The status of event data store creation.

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

The advanced event selectors that were used to select the events for the data store.

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

Indicates whether the event data store collects events from all regions, or only from the region in which it was created.

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

Indicates whether an event data store is collecting logged events for an organization in Organizations.

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

The retention period of an event data store, in days.

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

Indicates whether termination protection is enabled for the event data store.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when the event data store was created.

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

The timestamp that shows when an event data store was updated, if applicable. \n UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

" + } + } + } + }, "com.amazonaws.cloudtrail#CreateTrail": { "type": "operation", "input": { @@ -393,6 +679,9 @@ { "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, { "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" }, @@ -675,6 +964,60 @@ "com.amazonaws.cloudtrail#Date": { "type": "timestamp" }, + "com.amazonaws.cloudtrail#DeleteEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the event data store specified by EventDataStore, which accepts an event data store ARN. \n After you run DeleteEventDataStore, the event data store is automatically deleted after a wait period of \n seven days. TerminationProtectionEnabled must be set to False on the event data store; this \n operation cannot work if TerminationProtectionEnabled is True.

\n

After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, \n DescribeQuery, or GetQueryResults on queries that are using an event data store in a \n PENDING_DELETION state.

" + } + }, + "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.cloudtrail#DeleteTrail": { "type": "operation", "input": { @@ -736,26 +1079,116 @@ "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" } }, - "com.amazonaws.cloudtrail#DescribeTrails": { + "com.amazonaws.cloudtrail#DescribeQuery": { "type": "operation", "input": { - "target": "com.amazonaws.cloudtrail#DescribeTrailsRequest" + "target": "com.amazonaws.cloudtrail#DescribeQueryRequest" }, "output": { - "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" + "target": "com.amazonaws.cloudtrail#DescribeQueryResponse" }, "errors": [ { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query \n status. You must specify an ARN for EventDataStore, and a value for QueryID.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#DescribeQueryRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.

", + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The query ID.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#DescribeQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query.

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

The SQL code of a query.

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

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

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

Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time \n in milliseconds, and the query's creation time.

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

The error message returned if a query failed.

" + } + } + } + }, + "com.amazonaws.cloudtrail#DescribeTrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DescribeTrailsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { "smithy.api#documentation": "

Retrieves settings for one or more trails associated with the current region for your account.

", "smithy.api#idempotent": {} } @@ -795,7 +1228,14 @@ } }, "com.amazonaws.cloudtrail#ErrorMessage": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } }, "com.amazonaws.cloudtrail#Event": { "type": "structure", @@ -870,6 +1310,219 @@ ] } }, + "com.amazonaws.cloudtrail#EventDataStore": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

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

The name of the event data store.

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

Indicates whether the event data store is protected from termination.

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

The status of an event data store. Values are ENABLED and PENDING_DELETION.

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

The advanced event selectors that were used to select events for the data store.

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

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

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

Indicates that an event data store is collecting logged events for an organization.

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

The retention period, in days.

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

The timestamp of the event data store's creation.

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

The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

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

A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events \n that you have logged on your account from the last 90 to 2555 days \n (about three months to up to seven years). To select events for an event data store, \n use advanced event selectors.

" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreARNInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified event data store ARN is not valid or does not map to an event data store in your account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An event data store with that name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreMaxLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Your account has used the maximum number of event data stores.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified event data store was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "PENDING_DELETION", + "name": "PENDING_DELETION" + } + ] + } + }, + "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreTerminationProtectedException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store cannot be deleted because termination protection is enabled for it.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStores": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventDataStore" + } + }, "com.amazonaws.cloudtrail#EventSelector": { "type": "structure", "members": { @@ -920,6 +1573,113 @@ "target": "com.amazonaws.cloudtrail#String" } }, + "com.amazonaws.cloudtrail#GetEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store about which you want information.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#GetEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The event data store Amazon Resource Number (ARN).

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

The name of the event data store.

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

The status of an event data store. Values can be ENABLED and PENDING_DELETION.

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

The advanced event selectors used to select events for the data store.

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

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

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

Indicates whether an event data store is collecting logged events for an organization in Organizations.

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

The retention period of the event data store, in days.

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

Indicates that termination protection is enabled.

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

The timestamp of the event data store's creation.

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

Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

" + } + } + } + }, "com.amazonaws.cloudtrail#GetEventSelectors": { "type": "operation", "input": { @@ -1036,7 +1796,118 @@ "InsightSelectors": { "target": "com.amazonaws.cloudtrail#InsightSelectors", "traits": { - "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.

" + "smithy.api#documentation": "

A JSON string that contains the insight types you want to log on a trail. In this release, ApiErrorRateInsight and \n ApiCallRateInsight are supported as insight types.

" + } + } + } + }, + "com.amazonaws.cloudtrail#GetQueryResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetQueryResultsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetQueryResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery \n operation, and an ARN for EventDataStore.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken" + } + } + }, + "com.amazonaws.cloudtrail#GetQueryResultsRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store against which the query was run.

", + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query for which you want to get results.

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

A token you can use to get the next page of query results.

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

The maximum number of query results to display on a single page.

" + } + } + } + }, + "com.amazonaws.cloudtrail#GetQueryResultsResponse": { + "type": "structure", + "members": { + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

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

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

Shows the count of query results.

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

Contains the individual event results of the query.

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

A token you can use to get the next page of query results.

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

The error message returned if a query failed.

" } } } @@ -1240,6 +2111,46 @@ "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" } }, + "com.amazonaws.cloudtrail#InactiveEventDataStoreException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveEventDataStore", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store against which you ran your query is inactive.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InactiveQueryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveQuery", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InsightNotEnabledException": { "type": "structure", "members": { @@ -1266,7 +2177,7 @@ "InsightType": { "target": "com.amazonaws.cloudtrail#InsightType", "traits": { - "smithy.api#documentation": "

The type of Insights events to log on a trail. The valid Insights type in this release is ApiCallRateInsight.

" + "smithy.api#documentation": "

The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

" } } }, @@ -1375,6 +2286,12 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.cloudtrail#Integer": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException": { "type": "structure", "members": { @@ -1415,6 +2332,26 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#InvalidDateRangeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDateRange", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A date range for the query was specified that is not valid. For more information \n about writing a query, see Create \n or edit a query in the CloudTrail User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InvalidEventCategoryException": { "type": "structure", "members": { @@ -1435,6 +2372,26 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventDataStoreStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store is not in a status that supports the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InvalidEventSelectorsException": { "type": "structure", "members": { @@ -1595,6 +2552,66 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#InvalidParameterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameter", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request includes a parameter that is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidQueryStatementException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidQueryStatement", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information \n about writing a query, see Create \n or edit a query in the CloudTrail User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidQueryStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidQueryStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The query status is not valid for the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InvalidS3BucketNameException": { "type": "structure", "members": { @@ -1796,6 +2813,82 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#ListEventDataStores": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all event data stores in the account, in the current region.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of event data store results.

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

The maximum number of event data stores to display on a single page.

" + } + } + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresResponse": { + "type": "structure", + "members": { + "EventDataStores": { + "target": "com.amazonaws.cloudtrail#EventDataStores", + "traits": { + "smithy.api#documentation": "

Contains information about event data stores in the account, in the current region.

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

A token you can use to get the next page of results.

" + } + } + } + }, "com.amazonaws.cloudtrail#ListPublicKeys": { "type": "operation", "input": { @@ -1849,29 +2942,148 @@ "smithy.api#documentation": "

Reserved for future use.

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

Requests the public keys for a specified time range.

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

Requests the public keys for a specified time range.

" + } + }, + "com.amazonaws.cloudtrail#ListPublicKeysResponse": { + "type": "structure", + "members": { + "PublicKeyList": { + "target": "com.amazonaws.cloudtrail#PublicKeyList", + "traits": { + "smithy.api#documentation": "

Contains an array of PublicKey objects.

\n \n

The returned public keys may have validity time ranges that overlap.

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

Reserved for future use.

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + } + }, + "com.amazonaws.cloudtrail#ListQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidDateRangeException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListQueriesRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

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

A token you can use to get the next page of results.

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

The maximum number of queries to show on a page.

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

Use with EndTime to bound a ListQueries request, and limit its results to only those queries run \n within a specified time period.

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

Use with StartTime to bound a ListQueries request, and limit its results to only those queries run \n within a specified time period.

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

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

" + } + } } }, - "com.amazonaws.cloudtrail#ListPublicKeysResponse": { + "com.amazonaws.cloudtrail#ListQueriesResponse": { "type": "structure", "members": { - "PublicKeyList": { - "target": "com.amazonaws.cloudtrail#PublicKeyList", + "Queries": { + "target": "com.amazonaws.cloudtrail#Queries", "traits": { - "smithy.api#documentation": "

Contains an array of PublicKey objects.

\n \n

The returned public keys may have validity time ranges that overlap.

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

Lists matching query results, and shows query ID, status, and creation time of each query.

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

Reserved for future use.

" + "smithy.api#documentation": "

A token you can use to get the next page of results.

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

" } }, "com.amazonaws.cloudtrail#ListTags": { @@ -1886,6 +3098,12 @@ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTokenException" }, @@ -2010,6 +3228,12 @@ } } }, + "com.amazonaws.cloudtrail#Long": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.cloudtrail#LookupAttribute": { "type": "structure", "members": { @@ -2183,6 +3407,36 @@ "smithy.api#documentation": "

Contains a response to a LookupEvents action.

" } }, + "com.amazonaws.cloudtrail#MaxConcurrentQueriesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MaxConcurrentQueries", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

You are already running the maximum number of concurrent queries. Wait a minute for some queries to finish, and then \n run the query again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.cloudtrail#MaxQueryResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.cloudtrail#MaxResults": { "type": "integer", "traits": { @@ -2317,6 +3571,16 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.cloudtrail#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.cloudtrail#PublicKey": { "type": "structure", "members": { @@ -2485,7 +3749,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lets you enable Insights event logging by specifying the Insights\n selectors that you want to enable on an existing trail. You also use\n PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. \n The valid Insights event type in this release is ApiCallRateInsight.

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

Lets you enable Insights event logging by specifying the Insights\n selectors that you want to enable on an existing trail. You also use\n PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. \n The valid Insights event types in this release are ApiErrorRateInsight and ApiCallRateInsight.

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

A JSON string that contains the Insights types that you want to log on a trail. The valid Insights type in this release is ApiCallRateInsight.

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

A JSON string that contains the insight types you want to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

", "smithy.api#required": {} } } @@ -2520,9 +3784,177 @@ "InsightSelectors": { "target": "com.amazonaws.cloudtrail#InsightSelectors", "traits": { - "smithy.api#documentation": "

A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights type in this release is ApiCallRateInsight.

" + "smithy.api#documentation": "

A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights types in this release are \n ApiErrorRateInsight and ApiCallRateInsight.

" + } + } + } + }, + "com.amazonaws.cloudtrail#Queries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Query" + } + }, + "com.amazonaws.cloudtrail#Query": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of a query.

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

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

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

The creation time of a query.

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

A SQL string of criteria about events that you want to collect in an event data store.

" + } + }, + "com.amazonaws.cloudtrail#QueryIdNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QueryIdNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The query ID does not exist or does not map to a query.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#QueryResultColumn": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudtrail#QueryResultKey" + }, + "value": { + "target": "com.amazonaws.cloudtrail#QueryResultValue" + } + }, + "com.amazonaws.cloudtrail#QueryResultKey": { + "type": "string" + }, + "com.amazonaws.cloudtrail#QueryResultRow": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryResultColumn" + } + }, + "com.amazonaws.cloudtrail#QueryResultRows": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryResultRow" + } + }, + "com.amazonaws.cloudtrail#QueryResultValue": { + "type": "string" + }, + "com.amazonaws.cloudtrail#QueryStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#pattern": "^(?s)" + } + }, + "com.amazonaws.cloudtrail#QueryStatistics": { + "type": "structure", + "members": { + "ResultsCount": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "

The number of results returned.

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

The total number of results returned by a query.

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

Metadata about a query, such as the number of results.

" + } + }, + "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery": { + "type": "structure", + "members": { + "EventsMatched": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of events that matched a query.

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

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

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

The query's run time, in milliseconds.

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

The creation time of the query.

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

Gets metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time \n in milliseconds, and the query's creation time.

" + } + }, + "com.amazonaws.cloudtrail#QueryStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUEUED", + "name": "QUEUED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "FINISHED", + "name": "FINISHED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] } }, "com.amazonaws.cloudtrail#ReadWriteType": { @@ -2556,6 +3988,12 @@ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, @@ -2596,7 +4034,8 @@ "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList", "traits": { - "smithy.api#documentation": "

Specifies a list of tags to be removed.

" + "smithy.api#documentation": "

Specifies a list of tags to be removed.

", + "smithy.api#required": {} } } }, @@ -2666,50 +4105,187 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.cloudtrail#ResourceTag": { + "com.amazonaws.cloudtrail#ResourceTag": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the resource.

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

A list of tags.

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

A resource tag.

" + } + }, + "com.amazonaws.cloudtrail#ResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ResourceTag" + } + }, + "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified resource type is not supported by CloudTrail.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#RestoreEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. \n You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store \n can take several minutes, depending on the size of the event data store.

" + } + }, + "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.cloudtrail#String", + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the resource.

" + "smithy.api#documentation": "

The event data store ARN.

" } }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList", + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { - "smithy.api#documentation": "

A list of tags.

" + "smithy.api#documentation": "

The name of the event data store.

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

A resource tag.

" - } - }, - "com.amazonaws.cloudtrail#ResourceTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#ResourceTag" - } - }, - "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", "traits": { - "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + "smithy.api#documentation": "

The status of the event data store.

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

The advanced event selectors that were used to select events.

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

Indicates whether the event data store is collecting events from all regions, or only from the region in which the event data \n store was created.

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

Indicates whether an event data store is collecting logged events for an organization in Organizations.

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

The retention period, in days.

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

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

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

The timestamp of an event data store's creation.

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

The timestamp that shows when an event data store was updated, if applicable. \n UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

" } } - }, + } + }, + "com.amazonaws.cloudtrail#RetentionPeriod": { + "type": "integer", "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceTypeNotSupported", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This exception is thrown when the specified resource type is not supported by CloudTrail.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#box": {}, + "smithy.api#range": { + "min": 7, + "max": 2555 + } } }, "com.amazonaws.cloudtrail#S3BucketDoesNotExistException": { @@ -2810,6 +4386,68 @@ "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an error.

" } }, + "com.amazonaws.cloudtrail#StartQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" + }, + { + "target": "com.amazonaws.cloudtrail#MaxConcurrentQueriesException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a CloudTrail Lake query. The required QueryStatement \n parameter provides your SQL query, enclosed in single quotation marks.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#StartQueryRequest": { + "type": "structure", + "members": { + "QueryStatement": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "

The SQL code of your query.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#StartQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the started query.

" + } + } + } + }, "com.amazonaws.cloudtrail#StopLogging": { "type": "operation", "input": { @@ -2875,14 +4513,14 @@ "type": "structure", "members": { "Key": { - "target": "com.amazonaws.cloudtrail#String", + "target": "com.amazonaws.cloudtrail#TagKey", "traits": { "smithy.api#documentation": "

The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. \n The key must be unique for the resource to which it applies.

", "smithy.api#required": {} } }, "Value": { - "target": "com.amazonaws.cloudtrail#String", + "target": "com.amazonaws.cloudtrail#TagValue", "traits": { "smithy.api#documentation": "

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

" } @@ -2892,6 +4530,24 @@ "smithy.api#documentation": "

A custom key-value pair associated with a resource such as a CloudTrail trail.

" } }, + "com.amazonaws.cloudtrail#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudtrail#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.cloudtrail#TagsLimitExceededException": { "type": "structure", "members": { @@ -2918,7 +4574,17 @@ "target": "com.amazonaws.cloudtrail#Tag" }, "traits": { - "smithy.api#documentation": "

A list of tags.

" + "smithy.api#documentation": "

A list of tags.

", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.cloudtrail#TerminationProtectionEnabled": { + "type": "boolean", + "traits": { + "smithy.api#box": {} } }, "com.amazonaws.cloudtrail#Trail": { @@ -3130,6 +4796,16 @@ "target": "com.amazonaws.cloudtrail#TrailInfo" } }, + "com.amazonaws.cloudtrail#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9\\-]+$" + } + }, "com.amazonaws.cloudtrail#UnsupportedOperationException": { "type": "structure", "members": { @@ -3150,6 +4826,167 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#UpdateEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. \n Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. \n RetentionPeriod is in days, and valid values are integers between 90 and 2555. \n By default, TerminationProtection is enabled. AdvancedEventSelectors includes or excludes management \n and data events in your event data store; for more information about AdvancedEventSelectors, see \n PutEventSelectorsRequest$AdvancedEventSelectors.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store that you want to update.

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

The event data store name.

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

The advanced event selectors used to select events for the event data store.

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

Specifies whether an event data store collects events from all regions, or only from the region in which it was created.

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

Specifies whether an event data store collects events logged for an organization in Organizations.

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

The retention period, in days.

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

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

" + } + } + } + }, + "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

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

The name of the event data store.

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

The status of an event data store. Values can be ENABLED and PENDING_DELETION.

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

The advanced event selectors that are applied to the event data store.

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

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

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

Indicates whether an event data store is collecting logged events for an organization in Organizations.

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

The retention period, in days.

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

Indicates whether termination protection is enabled for the event data store.

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

The timestamp that shows when an event data store was first created.

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

The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

" + } + } + } + }, "com.amazonaws.cloudtrail#UpdateTrail": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/comprehendmedical.json b/aws/sdk/aws-models/comprehendmedical.json index b954de2780..12a8c69d09 100644 --- a/aws/sdk/aws-models/comprehendmedical.json +++ b/aws/sdk/aws-models/comprehendmedical.json @@ -44,13 +44,13 @@ "Score": { "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized\n as an attribute.

" + "smithy.api#documentation": "

The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized\n as an attribute.

" } }, "RelationshipScore": { "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this\n entity.

" + "smithy.api#documentation": "

The level of confidence that Comprehend Medical; has that this attribute is correctly related to this\n entity.

" } }, "RelationshipType": { @@ -138,6 +138,20 @@ } } }, + "com.amazonaws.comprehendmedical#Characters": { + "type": "structure", + "members": { + "OriginalTextCharacters": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

\n The number of characters present in the input text document as processed by Comprehend Medical.\n

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

\n The number of characters in the input text to be analyzed. \n

" + } + }, "com.amazonaws.comprehendmedical#ClientRequestTokenString": { "type": "string", "traits": { @@ -246,7 +260,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehendmedical#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.

" } }, "ManifestFilePath": { @@ -280,6 +294,21 @@ }, "com.amazonaws.comprehendmedical#ComprehendMedical_20181030": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "ComprehendMedical", + "arnNamespace": "comprehendmedical", + "cloudFormationName": "ComprehendMedical", + "cloudTrailEventSource": "comprehendmedical.amazonaws.com", + "endpointPrefix": "comprehendmedical" + }, + "aws.auth#sigv4": { + "name": "comprehendmedical" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions\n to gain insight in your documents.

", + "smithy.api#title": "AWS Comprehend Medical" + }, "version": "2018-10-30", "operations": [ { @@ -294,6 +323,9 @@ { "target": "com.amazonaws.comprehendmedical#DescribeRxNormInferenceJob" }, + { + "target": "com.amazonaws.comprehendmedical#DescribeSNOMEDCTInferenceJob" + }, { "target": "com.amazonaws.comprehendmedical#DetectEntities" }, @@ -309,6 +341,9 @@ { "target": "com.amazonaws.comprehendmedical#InferRxNorm" }, + { + "target": "com.amazonaws.comprehendmedical#InferSNOMEDCT" + }, { "target": "com.amazonaws.comprehendmedical#ListEntitiesDetectionV2Jobs" }, @@ -321,6 +356,9 @@ { "target": "com.amazonaws.comprehendmedical#ListRxNormInferenceJobs" }, + { + "target": "com.amazonaws.comprehendmedical#ListSNOMEDCTInferenceJobs" + }, { "target": "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2Job" }, @@ -333,6 +371,9 @@ { "target": "com.amazonaws.comprehendmedical#StartRxNormInferenceJob" }, + { + "target": "com.amazonaws.comprehendmedical#StartSNOMEDCTInferenceJob" + }, { "target": "com.amazonaws.comprehendmedical#StopEntitiesDetectionV2Job" }, @@ -344,23 +385,11 @@ }, { "target": "com.amazonaws.comprehendmedical#StopRxNormInferenceJob" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "ComprehendMedical", - "arnNamespace": "comprehendmedical", - "cloudFormationName": "ComprehendMedical", - "cloudTrailEventSource": "comprehendmedical.amazonaws.com", - "endpointPrefix": "comprehendmedical" - }, - "aws.auth#sigv4": { - "name": "comprehendmedical" }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions\n to gain insight in your documents.

", - "smithy.api#title": "AWS Comprehend Medical" - } + { + "target": "com.amazonaws.comprehendmedical#StopSNOMEDCTInferenceJob" + } + ] }, "com.amazonaws.comprehendmedical#DescribeEntitiesDetectionV2Job": { "type": "operation", @@ -394,7 +423,7 @@ "JobId": { "target": "com.amazonaws.comprehendmedical#JobId", "traits": { - "smithy.api#documentation": "

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

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

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

", "smithy.api#required": {} } } @@ -492,7 +521,7 @@ "JobId": { "target": "com.amazonaws.comprehendmedical#JobId", "traits": { - "smithy.api#documentation": "

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

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

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

", "smithy.api#required": {} } } @@ -558,6 +587,52 @@ } } }, + "com.amazonaws.comprehendmedical#DescribeSNOMEDCTInferenceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehendmedical#DescribeSNOMEDCTInferenceJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehendmedical#DescribeSNOMEDCTInferenceJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehendmedical#InternalServerException" + }, + { + "target": "com.amazonaws.comprehendmedical#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehendmedical#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehendmedical#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.\n

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

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

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehendmedical#DescribeSNOMEDCTInferenceJobResponse": { + "type": "structure", + "members": { + "ComprehendMedicalAsyncJobProperties": { + "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobProperties" + } + } + }, "com.amazonaws.comprehendmedical#DetectEntities": { "type": "operation", "input": { @@ -611,7 +686,7 @@ "Entities": { "target": "com.amazonaws.comprehendmedical#EntityList", "traits": { - "smithy.api#documentation": "

The collection of medical entities extracted from the input text and their associated\n information. For each entity, the response provides the entity text, the entity category,\n where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the\n detection and analysis. Attributes and traits of the entity are also returned.

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

The collection of medical entities extracted from the input text and their associated\n information. For each entity, the response provides the entity text, the entity category,\n where the entity text begins and ends, and the level of confidence that Comprehend Medical; has in the\n detection and analysis. Attributes and traits of the entity are also returned.

", "smithy.api#required": {} } }, @@ -761,7 +836,7 @@ "Entities": { "target": "com.amazonaws.comprehendmedical#EntityList", "traits": { - "smithy.api#documentation": "

The collection of PHI entities extracted from the input text and their associated\n information. For each entity, the response provides the entity text, the entity category,\n where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its\n detection.

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

The collection of PHI entities extracted from the input text and their associated\n information. For each entity, the response provides the entity text, the entity category,\n where the entity text begins and ends, and the level of confidence that Comprehend Medical; has in its\n detection.

", "smithy.api#required": {} } }, @@ -804,7 +879,7 @@ "Score": { "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

" + "smithy.api#documentation": "

The level of confidence that Comprehend Medical; has in the accuracy of the detection.

" } }, "Text": { @@ -856,6 +931,10 @@ "value": "NAME", "name": "NAME" }, + { + "value": "DX_NAME", + "name": "DX_NAME" + }, { "value": "DOSAGE", "name": "DOSAGE" @@ -908,6 +987,10 @@ "value": "TEST_UNITS", "name": "TEST_UNITS" }, + { + "value": "TEST_UNIT", + "name": "TEST_UNIT" + }, { "value": "PROCEDURE_NAME", "name": "PROCEDURE_NAME" @@ -928,6 +1011,10 @@ "value": "CONTACT_POINT", "name": "CONTACT_POINT" }, + { + "value": "PHONE_OR_FAX", + "name": "PHONE_OR_FAX" + }, { "value": "EMAIL", "name": "EMAIL" @@ -936,6 +1023,10 @@ "value": "IDENTIFIER", "name": "IDENTIFIER" }, + { + "value": "ID", + "name": "ID" + }, { "value": "URL", "name": "URL" @@ -1296,7 +1387,7 @@ "Score": { "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized\n as a trait.

" + "smithy.api#documentation": "

The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized\n as a trait.

" } } }, @@ -1340,7 +1431,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" } }, "com.amazonaws.comprehendmedical#InferICD10CM": { @@ -1479,6 +1570,86 @@ } } }, + "com.amazonaws.comprehendmedical#InferSNOMEDCT": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehendmedical#InferSNOMEDCTRequest" + }, + "output": { + "target": "com.amazonaws.comprehendmedical#InferSNOMEDCTResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehendmedical#InternalServerException" + }, + { + "target": "com.amazonaws.comprehendmedical#InvalidEncodingException" + }, + { + "target": "com.amazonaws.comprehendmedical#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehendmedical#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.comprehendmedical#TextSizeLimitExceededException" + }, + { + "target": "com.amazonaws.comprehendmedical#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

\n InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology

" + } + }, + "com.amazonaws.comprehendmedical#InferSNOMEDCTRequest": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.comprehendmedical#OntologyLinkingBoundedLengthString", + "traits": { + "smithy.api#documentation": "

\n The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters. \n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehendmedical#InferSNOMEDCTResponse": { + "type": "structure", + "members": { + "Entities": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTEntityList", + "traits": { + "smithy.api#documentation": "

\n The collection of medical concept entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned. \n

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

\n If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.\n

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

\n The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.\n

" + } + }, + "SNOMEDCTDetails": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTDetails", + "traits": { + "smithy.api#documentation": "

\n The details of the SNOMED-CT revision, including the edition, language, and version date. \n

" + } + }, + "Characters": { + "target": "com.amazonaws.comprehendmedical#Characters", + "traits": { + "smithy.api#documentation": "

\n The number of characters in the input request documentation. \n

" + } + } + } + }, "com.amazonaws.comprehendmedical#InputDataConfig": { "type": "structure", "members": { @@ -1885,6 +2056,69 @@ } } }, + "com.amazonaws.comprehendmedical#ListSNOMEDCTInferenceJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehendmedical#ListSNOMEDCTInferenceJobsRequest" + }, + "output": { + "target": "com.amazonaws.comprehendmedical#ListSNOMEDCTInferenceJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehendmedical#InternalServerException" + }, + { + "target": "com.amazonaws.comprehendmedical#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehendmedical#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehendmedical#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Gets a list of InferSNOMEDCT jobs a user has submitted.\n

" + } + }, + "com.amazonaws.comprehendmedical#ListSNOMEDCTInferenceJobsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobFilter" + }, + "NextToken": { + "target": "com.amazonaws.comprehendmedical#String", + "traits": { + "smithy.api#documentation": "

\n Identifies the next page of InferSNOMEDCT results to return.\n

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

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

" + } + } + } + }, + "com.amazonaws.comprehendmedical#ListSNOMEDCTInferenceJobsResponse": { + "type": "structure", + "members": { + "ComprehendMedicalAsyncJobPropertiesList": { + "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobPropertiesList", + "traits": { + "smithy.api#documentation": "

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

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

\n Identifies the next page of results to return.\n

" + } + } + } + }, "com.amazonaws.comprehendmedical#ManifestFilePath": { "type": "string", "traits": { @@ -1929,7 +2163,7 @@ "S3Key": { "target": "com.amazonaws.comprehendmedical#S3Key", "traits": { - "smithy.api#documentation": "

The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory\n using the job ID so that the output from one job does not overwrite the output of\n another.

" + "smithy.api#documentation": "

The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory\n using the job ID so that the output from one job does not overwrite the output of\n another.

" } } }, @@ -2005,6 +2239,10 @@ "value": "TEST_UNITS", "name": "TEST_UNITS" }, + { + "value": "TEST_UNIT", + "name": "TEST_UNIT" + }, { "value": "DIRECTION", "name": "DIRECTION" @@ -2315,44 +2553,409 @@ "smithy.api#pattern": ".*" } }, - "com.amazonaws.comprehendmedical#ServiceUnavailableException": { + "com.amazonaws.comprehendmedical#SNOMEDCTAttribute": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.comprehendmedical#String" - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.\n

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2Job": { - "type": "operation", - "input": { - "target": "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2JobRequest" - }, - "output": { - "target": "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2JobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.comprehendmedical#InternalServerException" + "Category": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTEntityCategory", + "traits": { + "smithy.api#documentation": "

\n The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.\n

" + } }, - { - "target": "com.amazonaws.comprehendmedical#InvalidRequestException" + "Type": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTAttributeType", + "traits": { + "smithy.api#documentation": "

\n The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.\n

" + } }, - { - "target": "com.amazonaws.comprehendmedical#ResourceNotFoundException" + "Score": { + "target": "com.amazonaws.comprehendmedical#Float", + "traits": { + "smithy.api#documentation": "

\n The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.\n

" + } }, - { - "target": "com.amazonaws.comprehendmedical#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

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

" - } + "RelationshipScore": { + "target": "com.amazonaws.comprehendmedical#Float", + "traits": { + "smithy.api#documentation": "

\n The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.\n

" + } + }, + "RelationshipType": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTRelationshipType", + "traits": { + "smithy.api#documentation": "

\n The type of relationship that exists between the entity and the related attribute. \n

" + } + }, + "Id": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

\n The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.\n

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

\n The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.\n

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

\n The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.\n

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

\n The segment of input text extracted as this attribute.\n

" + } + }, + "Traits": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTTraitList", + "traits": { + "smithy.api#documentation": "

\n Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.\n

" + } + }, + "SNOMEDCTConcepts": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTConceptList", + "traits": { + "smithy.api#documentation": "

\n The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.\n

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

\n The extracted attributes that relate to an entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.\n

" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTAttribute" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTAttributeType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACUITY", + "name": "ACUITY" + }, + { + "value": "QUALITY", + "name": "QUALITY" + }, + { + "value": "DIRECTION", + "name": "DIRECTION" + }, + { + "value": "SYSTEM_ORGAN_SITE", + "name": "SYSTEM_ORGAN_SITE" + }, + { + "value": "TEST_VALUE", + "name": "TEST_VALUE" + }, + { + "value": "TEST_UNIT", + "name": "TEST_UNIT" + } + ] + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTConcept": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.comprehendmedical#String", + "traits": { + "smithy.api#documentation": "

\n The description of the SNOMED-CT concept. \n

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

\n The numeric ID for the SNOMED-CT concept.\n

" + } + }, + "Score": { + "target": "com.amazonaws.comprehendmedical#Float", + "traits": { + "smithy.api#documentation": "

\n The level of confidence Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.\n

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

\n The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.\n

" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTConceptList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTConcept" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTDetails": { + "type": "structure", + "members": { + "Edition": { + "target": "com.amazonaws.comprehendmedical#String", + "traits": { + "smithy.api#documentation": "

\n The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions is the US edition. \n

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

\n The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical operations are US English (en).\n

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

\n The version date of the SNOMED-CT ontology used. \n

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

\n The information about the revision of the SNOMED-CT ontology in the response. Specifically, the details include the SNOMED-CT edition, language, and version date. \n

" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTEntity": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

\n The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.\n

" + } + }, + "Text": { + "target": "com.amazonaws.comprehendmedical#OntologyLinkingBoundedLengthString", + "traits": { + "smithy.api#documentation": "

\n The segment of input text extracted as this entity.\n

" + } + }, + "Category": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTEntityCategory", + "traits": { + "smithy.api#documentation": "

\n The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE. \n

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

\n Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. \n

" + } + }, + "Score": { + "target": "com.amazonaws.comprehendmedical#Float", + "traits": { + "smithy.api#documentation": "

\n The level of confidence that Comprehend Medical has in the accuracy of the detected entity.\n

" + } + }, + "BeginOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

\n The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.\n

" + } + }, + "EndOffset": { + "target": "com.amazonaws.comprehendmedical#Integer", + "traits": { + "smithy.api#documentation": "

\n The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.\n

" + } + }, + "Attributes": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTAttributeList", + "traits": { + "smithy.api#documentation": "

\n An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.\n

" + } + }, + "Traits": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTTraitList", + "traits": { + "smithy.api#documentation": "

\n Contextual information for the entity.\n

" + } + }, + "SNOMEDCTConcepts": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTConceptList", + "traits": { + "smithy.api#documentation": "

\n The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.\n

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

\n The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned. \n

" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTEntityCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MEDICAL_CONDITION", + "name": "MEDICAL_CONDITION" + }, + { + "value": "ANATOMY", + "name": "ANATOMY" + }, + { + "value": "TEST_TREATMENT_PROCEDURE", + "name": "TEST_TREATMENT_PROCEDURE" + } + ] + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTEntity" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTEntityType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DX_NAME", + "name": "DX_NAME" + }, + { + "value": "TEST_NAME", + "name": "TEST_NAME" + }, + { + "value": "PROCEDURE_NAME", + "name": "PROCEDURE_NAME" + }, + { + "value": "TREATMENT_NAME", + "name": "TREATMENT_NAME" + } + ] + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTRelationshipType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACUITY", + "name": "ACUITY" + }, + { + "value": "QUALITY", + "name": "QUALITY" + }, + { + "value": "TEST_VALUE", + "name": "TEST_VALUE" + }, + { + "value": "TEST_UNITS", + "name": "TEST_UNITS" + }, + { + "value": "DIRECTION", + "name": "DIRECTION" + }, + { + "value": "SYSTEM_ORGAN_SITE", + "name": "SYSTEM_ORGAN_SITE" + } + ] + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTTrait": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTTraitName", + "traits": { + "smithy.api#documentation": "

\n The name or contextual description of a detected trait.\n

" + } + }, + "Score": { + "target": "com.amazonaws.comprehendmedical#Float", + "traits": { + "smithy.api#documentation": "

\n The level of confidence that Comprehend Medical has in the accuracy of a detected trait.\n

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

\n Contextual information for an entity.\n

" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTTraitList": { + "type": "list", + "member": { + "target": "com.amazonaws.comprehendmedical#SNOMEDCTTrait" + } + }, + "com.amazonaws.comprehendmedical#SNOMEDCTTraitName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NEGATION", + "name": "NEGATION" + }, + { + "value": "DIAGNOSIS", + "name": "DIAGNOSIS" + }, + { + "value": "SIGN", + "name": "SIGN" + }, + { + "value": "SYMPTOM", + "name": "SYMPTOM" + } + ] + } + }, + "com.amazonaws.comprehendmedical#ServiceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.comprehendmedical#String" + } + }, + "traits": { + "smithy.api#documentation": "

The Comprehend Medical; service is temporarily unavailable. Please wait and then retry your request.\n

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2Job": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2JobRequest" + }, + "output": { + "target": "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2JobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehendmedical#InternalServerException" + }, + { + "target": "com.amazonaws.comprehendmedical#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehendmedical#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehendmedical#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

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

" + } }, "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2JobRequest": { "type": "structure", @@ -2360,21 +2963,21 @@ "InputDataConfig": { "target": "com.amazonaws.comprehendmedical#InputDataConfig", "traits": { - "smithy.api#documentation": "

Specifies the format and location of the input data for the job.

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

The input configuration that specifies the format and location of the input data for the job.

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

Specifies where to send the output files.

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

The output configuration that specifies where to send the output files.

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

", "smithy.api#required": {} } }, @@ -2387,7 +2990,7 @@ "ClientRequestToken": { "target": "com.amazonaws.comprehendmedical#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

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

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

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

", "smithy.api#idempotencyToken": {} } }, @@ -2400,7 +3003,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehendmedical#LanguageCode", "traits": { - "smithy.api#documentation": "

The language of the input documents. All documents must be in the same language.

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

The language of the input documents. All documents must be in the same language. Comprehend Medical; processes files in US English (en).

", "smithy.api#required": {} } } @@ -2463,7 +3066,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehendmedical#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

", "smithy.api#required": {} } }, @@ -2476,7 +3079,7 @@ "ClientRequestToken": { "target": "com.amazonaws.comprehendmedical#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

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

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

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

", "smithy.api#idempotencyToken": {} } }, @@ -2552,7 +3155,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehendmedical#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

", "smithy.api#required": {} } }, @@ -2565,7 +3168,7 @@ "ClientRequestToken": { "target": "com.amazonaws.comprehendmedical#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

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

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

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

", "smithy.api#idempotencyToken": {} } }, @@ -2641,7 +3244,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.comprehendmedical#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

", "smithy.api#required": {} } }, @@ -2654,7 +3257,7 @@ "ClientRequestToken": { "target": "com.amazonaws.comprehendmedical#ClientRequestTokenString", "traits": { - "smithy.api#documentation": "

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

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

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

", "smithy.api#idempotencyToken": {} } }, @@ -2684,6 +3287,93 @@ } } }, + "com.amazonaws.comprehendmedical#StartSNOMEDCTInferenceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehendmedical#StartSNOMEDCTInferenceJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehendmedical#StartSNOMEDCTInferenceJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehendmedical#InternalServerException" + }, + { + "target": "com.amazonaws.comprehendmedical#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehendmedical#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehendmedical#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.\n

" + } + }, + "com.amazonaws.comprehendmedical#StartSNOMEDCTInferenceJobRequest": { + "type": "structure", + "members": { + "InputDataConfig": { + "target": "com.amazonaws.comprehendmedical#InputDataConfig", + "traits": { + "smithy.api#required": {} + } + }, + "OutputDataConfig": { + "target": "com.amazonaws.comprehendmedical#OutputDataConfig", + "traits": { + "smithy.api#required": {} + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehendmedical#IamRoleArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. \n

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

\n The user generated name the asynchronous InferSNOMEDCT job.\n

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

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

", + "smithy.api#idempotencyToken": {} + } + }, + "KMSKey": { + "target": "com.amazonaws.comprehendmedical#KMSKey", + "traits": { + "smithy.api#documentation": "

\n An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.\n

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

\n The language of the input documents. All documents must be in the same language.\n

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

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

" + } + } + } + }, "com.amazonaws.comprehendmedical#StopEntitiesDetectionV2Job": { "type": "operation", "input": { @@ -2868,6 +3558,55 @@ } } }, + "com.amazonaws.comprehendmedical#StopSNOMEDCTInferenceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehendmedical#StopSNOMEDCTInferenceJobRequest" + }, + "output": { + "target": "com.amazonaws.comprehendmedical#StopSNOMEDCTInferenceJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehendmedical#InternalServerException" + }, + { + "target": "com.amazonaws.comprehendmedical#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehendmedical#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehendmedical#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Stops an InferSNOMEDCT inference job in progress.\n

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

\n The job id of the asynchronous InferSNOMEDCT job to be stopped.\n

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

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

" + } + } + } + }, "com.amazonaws.comprehendmedical#String": { "type": "string", "traits": { @@ -2917,7 +3656,7 @@ "Score": { "target": "com.amazonaws.comprehendmedical#Float", "traits": { - "smithy.api#documentation": "

The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.

" + "smithy.api#documentation": "

The level of confidence that Comprehend Medical; has in the accuracy of this trait.

" } } }, @@ -2937,7 +3676,7 @@ "Type": { "target": "com.amazonaws.comprehendmedical#EntityType", "traits": { - "smithy.api#documentation": "

The type of the attribute, could be one of the following values: \"MEDICATION\",\n \"MEDICAL_CONDITION\", \"ANATOMY\", \"TEST_AND_TREATMENT_PROCEDURE\" or\n \"PROTECTED_HEALTH_INFORMATION\".

" + "smithy.api#documentation": "

The type of the unmapped attribute, could be one of the following values: \"MEDICATION\",\n \"MEDICAL_CONDITION\", \"ANATOMY\", \"TEST_AND_TREATMENT_PROCEDURE\" or\n \"PROTECTED_HEALTH_INFORMATION\".

" } }, "Attribute": { @@ -2948,7 +3687,7 @@ } }, "traits": { - "smithy.api#documentation": "

An attribute that we extracted, but were unable to relate to an entity.

" + "smithy.api#documentation": "

An attribute that was extracted, but Comprehend Medical; was unable to relate to an entity.

" } }, "com.amazonaws.comprehendmedical#UnmappedAttributeList": { diff --git a/aws/sdk/aws-models/customer-profiles.json b/aws/sdk/aws-models/customer-profiles.json index bdeaf077d3..4bd8fecb0a 100644 --- a/aws/sdk/aws-models/customer-profiles.json +++ b/aws/sdk/aws-models/customer-profiles.json @@ -1320,7 +1320,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.

\n \n

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 Amazon Connect Customer Profiles cross-service confused deputy prevention.\n

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

Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.

\n \n

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 Amazon Connect Customer Profiles cross-service confused deputy prevention.

\n
" } }, "com.amazonaws.customerprofiles#ExportingLocation": { @@ -2001,8 +2001,7 @@ "ObjectTypeName": { "target": "com.amazonaws.customerprofiles#typeName", "traits": { - "smithy.api#documentation": "

The name of the profile object type.

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

The name of the profile object type.

" } }, "CreatedAt": { @@ -2024,6 +2023,12 @@ "traits": { "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } + }, + "ObjectTypeNames": { + "target": "com.amazonaws.customerprofiles#ObjectTypeNames", + "traits": { + "smithy.api#documentation": "

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

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

This API is in preview release for Amazon Connect and subject to change.

\n

Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.

\n

GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.

\n \n

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.

\n

After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.

\n
\n\n

Amazon Connect uses the following profile attributes to identify matches:

\n
    \n
  • \n

    PhoneNumber

    \n
  • \n
  • \n

    HomePhoneNumber

    \n
  • \n
  • \n

    BusinessPhoneNumber

    \n
  • \n
  • \n

    MobilePhoneNumber

    \n
  • \n
  • \n

    EmailAddress

    \n
  • \n
  • \n

    PersonalEmailAddress

    \n
  • \n
  • \n

    BusinessEmailAddress

    \n
  • \n
  • \n

    FullName

    \n
  • \n
  • \n

    BusinessName

    \n
  • \n
\n

For example, two or more profilesβ€”with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000β€”can be detected as belonging to the same customer John Doe and merged into a unified profile.

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

Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.

\n

GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.

\n \n

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.

\n

After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.

\n
\n\n

Amazon Connect uses the following profile attributes to identify matches:

\n
    \n
  • \n

    PhoneNumber

    \n
  • \n
  • \n

    HomePhoneNumber

    \n
  • \n
  • \n

    BusinessPhoneNumber

    \n
  • \n
  • \n

    MobilePhoneNumber

    \n
  • \n
  • \n

    EmailAddress

    \n
  • \n
  • \n

    PersonalEmailAddress

    \n
  • \n
  • \n

    BusinessEmailAddress

    \n
  • \n
  • \n

    FullName

    \n
  • \n
  • \n

    BusinessName

    \n
  • \n
\n

For example, two or more profilesβ€”with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000β€”can be detected as belonging to the same customer John Doe and merged into a unified profile.

", "smithy.api#http": { "method": "GET", "uri": "/domains/{DomainName}/matches", @@ -2867,8 +2872,7 @@ "ObjectTypeName": { "target": "com.amazonaws.customerprofiles#typeName", "traits": { - "smithy.api#documentation": "

The name of the profile object type.

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

The name of the profile object type.

" } }, "CreatedAt": { @@ -2890,6 +2894,12 @@ "traits": { "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } + }, + "ObjectTypeNames": { + "target": "com.amazonaws.customerprofiles#ObjectTypeNames", + "traits": { + "smithy.api#documentation": "

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

" + } } }, "traits": { @@ -3290,7 +3300,7 @@ "ObjectFilter": { "target": "com.amazonaws.customerprofiles#ObjectFilter", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

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

This API is in preview release for Amazon Connect and subject to change.

\n

Runs an AWS Lambda job that does the following:

\n
    \n
  1. \n

    All the profileKeys in the ProfileToBeMerged will be moved to the\n main profile.

    \n
  2. \n
  3. \n

    All the objects in the ProfileToBeMerged will be moved to the main\n profile.

    \n
  4. \n
  5. \n

    All the ProfileToBeMerged will be deleted at the end.

    \n
  6. \n
  7. \n

    All the profileKeys in the ProfileIdsToBeMerged will be moved to the\n main profile.

    \n
  8. \n
  9. \n

    Standard fields are merged as follows:

    \n
      \n
    1. \n

      Fields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.

      \n
    2. \n
    3. \n

      When there are conflicting fields:

      \n\n
        \n
      1. \n

        If no SourceProfileIds entry is specified, the main\n Profile value is always taken.

        \n
      2. \n
      3. \n

        If a SourceProfileIds entry is specified, the specified\n profileId is always taken, even if it is a NULL value.

        \n
      4. \n
      \n
    4. \n
    \n
  10. \n
\n

You can use MergeProfiles together with GetMatches, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).

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

Runs an AWS Lambda job that does the following:

\n
    \n
  1. \n

    All the profileKeys in the ProfileToBeMerged will be moved to the\n main profile.

    \n
  2. \n
  3. \n

    All the objects in the ProfileToBeMerged will be moved to the main\n profile.

    \n
  4. \n
  5. \n

    All the ProfileToBeMerged will be deleted at the end.

    \n
  6. \n
  7. \n

    All the profileKeys in the ProfileIdsToBeMerged will be moved to the\n main profile.

    \n
  8. \n
  9. \n

    Standard fields are merged as follows:

    \n
      \n
    1. \n

      Fields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.

      \n
    2. \n
    3. \n

      When there are conflicting fields:

      \n\n
        \n
      1. \n

        If no SourceProfileIds entry is specified, the main\n Profile value is always taken.

        \n
      2. \n
      3. \n

        If a SourceProfileIds entry is specified, the specified\n profileId is always taken, even if it is a NULL value.

        \n
      4. \n
      \n
    4. \n
    \n
  10. \n
\n

You can use MergeProfiles together with GetMatches, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).

", "smithy.api#http": { "method": "POST", "uri": "/domains/{DomainName}/profiles/objects/merge", @@ -3662,7 +3672,7 @@ "KeyName": { "target": "com.amazonaws.customerprofiles#name", "traits": { - "smithy.api#documentation": "

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.

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

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.

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

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.customerprofiles#ObjectTypeField": { @@ -3710,7 +3720,7 @@ "StandardIdentifiers": { "target": "com.amazonaws.customerprofiles#StandardIdentifierList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "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": "

The name of the profile object type.

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

The name of the profile object type.

" } }, "Tags": { @@ -4073,6 +4091,12 @@ "traits": { "smithy.api#documentation": "

The configuration that controls how Customer Profiles retrieves data from the\n source.

" } + }, + "ObjectTypeNames": { + "target": "com.amazonaws.customerprofiles#ObjectTypeNames", + "traits": { + "smithy.api#documentation": "

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

" + } } } }, @@ -4096,8 +4120,7 @@ "ObjectTypeName": { "target": "com.amazonaws.customerprofiles#typeName", "traits": { - "smithy.api#documentation": "

The name of the profile object type.

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

The name of the profile object type.

" } }, "CreatedAt": { @@ -4119,6 +4142,12 @@ "traits": { "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } + }, + "ObjectTypeNames": { + "target": "com.amazonaws.customerprofiles#ObjectTypeNames", + "traits": { + "smithy.api#documentation": "

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

" + } } } }, @@ -4281,7 +4310,7 @@ "SourceLastUpdatedTimestampFormat": { "target": "com.amazonaws.customerprofiles#string1To255", "traits": { - "smithy.api#documentation": "

The format of your sourceLastUpdatedTimestamp that was previously set up.\n

" + "smithy.api#documentation": "

The format of your sourceLastUpdatedTimestamp that was previously set up.\n

" } }, "Fields": { @@ -4796,7 +4825,7 @@ "KeyName": { "target": "com.amazonaws.customerprofiles#name", "traits": { - "smithy.api#documentation": "

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.

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

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.

", "smithy.api#required": {} } }, @@ -5068,6 +5097,10 @@ { "value": "NEW_ONLY", "name": "NEW_ONLY" + }, + { + "value": "ORDER", + "name": "ORDER" } ] } diff --git a/aws/sdk/aws-models/datasync.json b/aws/sdk/aws-models/datasync.json index 793683e68b..f8c9a4309b 100644 --- a/aws/sdk/aws-models/datasync.json +++ b/aws/sdk/aws-models/datasync.json @@ -318,6 +318,68 @@ "smithy.api#documentation": "

CreateLocationEfs

" } }, + "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": "

Creates an endpoint for an Amazon FSx for Lustre file system.

" + } + }, + "com.amazonaws.datasync#CreateLocationFsxLustreRequest": { + "type": "structure", + "members": { + "FsxFilesystemArn": { + "target": "com.amazonaws.datasync#FsxFilesystemArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the FSx for Lustre file system.

", + "smithy.api#required": {} + } + }, + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.

", + "smithy.api#required": {} + } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#FsxLustreSubdirectory", + "traits": { + "smithy.api#documentation": "

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.

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

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.

" + } + } + } + }, + "com.amazonaws.datasync#CreateLocationFsxLustreResponse": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's\n created.

" + } + } + } + }, "com.amazonaws.datasync#CreateLocationFsxWindows": { "type": "operation", "input": { @@ -344,7 +406,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#FsxWindowsSubdirectory", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "FsxFilesystemArn": { @@ -357,7 +419,7 @@ "SecurityGroupArns": { "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the security groups that are to use to configure the\n FSx for Windows File Server file system.

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

The Amazon Resource Names (ARNs) of the security groups that are used to configure the\n FSx for Windows File Server file system.

", "smithy.api#required": {} } }, @@ -1229,6 +1291,67 @@ "smithy.api#documentation": "

DescribeLocationEfsResponse

" } }, + "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": "

Returns metadata, such as the path information about an Amazon FSx for Lustre\n location.

" + } + }, + "com.amazonaws.datasync#DescribeLocationFsxLustreRequest": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.datasync#DescribeLocationFsxLustreResponse": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.

" + } + }, + "LocationUri": { + "target": "com.amazonaws.datasync#LocationUri", + "traits": { + "smithy.api#documentation": "

The URI of the FSx for Lustre location that was described.

" + } + }, + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Lustre file system.

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

The time that the FSx for Lustre location was created.

" + } + } + } + }, "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": "

Represents a list of URLs of a location. LocationUri returns an array that\n contains a list of locations when the ListLocations operation is\n called.

\n

Format: TYPE://GLOBAL_ID/SUBDIR.

\n

TYPE designates the type of location. Valid values: NFS | EFS | S3.

\n

GLOBAL_ID is the globally unique identifier of the resource that backs the location. An\n example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket\n name, such as myBucket. An example for NFS is a valid IPv4 address or a host name\n compliant with Domain Name Service (DNS).

\n

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.

\n

" + "smithy.api#documentation": "

Represents a list of URIs of a location. LocationUri returns an array that\n contains a list of locations when the ListLocations operation is\n called.

\n

Format: TYPE://GLOBAL_ID/SUBDIR.

\n

TYPE designates the type of location. Valid values: NFS | EFS | S3.

\n

GLOBAL_ID is the globally unique identifier of the resource that backs the location. An\n example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket\n name, such as myBucket. An example for NFS is a valid IPv4 address or a host name\n compliant with Domain Name Service (DNS).

\n

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.

\n

" } } }, @@ -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": { diff --git a/aws/sdk/aws-models/detective.json b/aws/sdk/aws-models/detective.json index 1a9e2eaa1a..a974a116bf 100644 --- a/aws/sdk/aws-models/detective.json +++ b/aws/sdk/aws-models/detective.json @@ -75,20 +75,20 @@ "AccountId": { "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "

The account identifier of the AWS account.

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

The account identifier of the Amazon Web Services account.

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

The AWS account root user email address for the AWS account.

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

The Amazon Web Services account root user email address for the Amazon Web Services\n account.

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

An AWS account that is the administrator account of or a member of a behavior\n graph.

" + "smithy.api#documentation": "

An Amazon Web Services account that is the administrator account of or a member of a\n behavior graph.

" } }, "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": "

The Amazon Web Services account identifier of the Detective administrator\n account for the organization.

" + } + }, + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "

The ARN of the organization behavior graph.

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

The date and time when the Detective administrator account was enabled. The\n value is an ISO8601 formatted string. For example,\n 2021-08-18T16:35:56.284Z.

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

Information about the Detective administrator account for an\n organization.

" + } + }, + "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": "

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.

\n

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.

\n

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.

\n

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.

\n

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.

\n

The administrator account for a behavior graph can use the Detective API to do\n the following:

\n
    \n
  • \n

    Enable and disable Detective. Enabling Detective creates a new\n behavior graph.

    \n
  • \n
  • \n

    View the list of member accounts in a behavior graph.

    \n
  • \n
  • \n

    Add member accounts to a behavior graph.

    \n
  • \n
  • \n

    Remove member accounts from a behavior graph.

    \n
  • \n
  • \n

    Apply tags to a behavior graph.

    \n
  • \n
\n

The organization management account can use the Detective API to select the\n delegated administrator for Detective.

\n

The Detective administrator account for an organization can use the Detective API to do the following:

\n
    \n
  • \n

    Perform all of the functions of an administrator account.

    \n
  • \n
  • \n

    Determine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.

    \n
  • \n
\n

An invited member account can use the Detective API to do the following:

\n
    \n
  • \n

    View the list of behavior graphs that they are invited to.

    \n
  • \n
  • \n

    Accept an invitation to contribute to a behavior graph.

    \n
  • \n
  • \n

    Decline an invitation to contribute to a behavior graph.

    \n
  • \n
  • \n

    Remove their account from a behavior graph.

    \n
  • \n
\n

All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.

\n \n

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.

\n
", + "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" - } - ], - "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": "

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.

\n

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.

\n

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.

\n

A Detective administrator account can use the Detective API to do the following:

\n
    \n
  • \n

    Enable and disable Detective. Enabling Detective creates a new behavior graph.

    \n
  • \n
  • \n

    View the list of member accounts in a behavior graph.

    \n
  • \n
  • \n

    Add member accounts to a behavior graph.

    \n
  • \n
  • \n

    Remove member accounts from a behavior graph.

    \n
  • \n
\n

A member account can use the Detective API to do the following:

\n
    \n
  • \n

    View the list of behavior graphs that they are invited to.

    \n
  • \n
  • \n

    Accept an invitation to contribute to a behavior graph.

    \n
  • \n
  • \n

    Decline an invitation to contribute to a behavior graph.

    \n
  • \n
  • \n

    Remove their account from a behavior graph.

    \n
  • \n
\n

All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.

\n \n

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.

\n
", - "smithy.api#title": "Amazon Detective" - } + { + "target": "com.amazonaws.detective#UpdateOrganizationConfiguration" + } + ] }, "com.amazonaws.detective#Boolean": { "type": "boolean" @@ -233,7 +280,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

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.

\n

The operation also enables Detective for the calling account in the currently selected\n Region. It returns the ARN of the new behavior graph.

\n

\n CreateGraph triggers a process to create the corresponding data tables for\n the new behavior graph.

\n

An account can only be the administrator account for one behavior graph within a Region.\n If the same account calls CreateGraph with the same administrator account, it\n always returns the same behavior graph ARN. It does not create a new behavior graph.

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

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.

\n

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.

\n

The operation also enables Detective for the calling account in the currently\n selected Region. It returns the ARN of the new behavior graph.

\n

\n CreateGraph triggers a process to create the corresponding data tables for\n the new behavior graph.

\n

An account can only be the administrator account for one behavior graph within a Region.\n If the same account calls CreateGraph with the same administrator account, it\n always returns the same behavior graph ARN. It does not create a new behavior graph.

", "smithy.api#http": { "method": "POST", "uri": "/graph", @@ -286,7 +333,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

\n CreateMembers 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.

\n

The request provides the behavior graph ARN and the list of accounts to invite.

\n

The response separates the requested accounts into two lists:

\n
    \n
  • \n

    The accounts that CreateMembers 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.

    \n
  • \n
  • \n

    The accounts that CreateMembers was unable to process. This list\n includes accounts that were already invited to be member accounts in the behavior\n graph.

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

\n CreateMembers is used to send invitations to accounts. For the organization\n behavior graph, the Detective administrator account uses\n CreateMembers to enable organization accounts as member accounts.

\n

For invited accounts, CreateMembers 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.

\n

\n CreateMembers 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.

\n

For organization accounts in the organization behavior graph, CreateMembers\n attempts to enable the accounts. The organization accounts do not receive\n invitations.

\n

The request provides the behavior graph ARN and the list of accounts to invite or to\n enable.

\n

The response separates the requested accounts into two lists:

\n
    \n
  • \n

    The accounts that CreateMembers 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.

    \n
  • \n
  • \n

    The accounts that CreateMembers was unable to process. This list\n includes accounts that were already invited to be member accounts in the behavior\n graph.

    \n
  • \n
", "smithy.api#http": { "method": "POST", "uri": "/graph/members", @@ -300,7 +347,7 @@ "GraphArn": { "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "

The ARN of the behavior graph to invite the member accounts to contribute their data\n to.

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

The ARN of the behavior graph.

", "smithy.api#required": {} } }, @@ -313,13 +360,13 @@ "DisableEmailNotification": { "target": "com.amazonaws.detective#Boolean", "traits": { - "smithy.api#documentation": "

if set to true, then the member accounts do not receive email\n notifications. By default, this is set to false, and the member accounts\n receive email notifications.

" + "smithy.api#documentation": "

if set to true, then the invited accounts do not receive email\n notifications. By default, this is set to false, and the invited accounts\n receive email notifications.

\n

Organization accounts in the organization behavior graph do not receive email\n notifications.

" } }, "Accounts": { "target": "com.amazonaws.detective#AccountList", "traits": { - "smithy.api#documentation": "

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.

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

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.

", "smithy.api#required": {} } } @@ -331,13 +378,13 @@ "Members": { "target": "com.amazonaws.detective#MemberDetailList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "UnprocessedAccounts": { "target": "com.amazonaws.detective#UnprocessedAccountList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

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

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.

\n

\n DeleteGraph can only be called by the administrator account for a behavior\n graph.

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

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.

\n

\n DeleteGraph can only be called by the administrator account for a behavior\n graph.

", "smithy.api#http": { "method": "POST", "uri": "/graph/removal", @@ -402,7 +449,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 DeleteMembers to delete their own account from the behavior graph. To\n disable a behavior graph, the administrator account uses the DeleteGraph API\n method.

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

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.

\n

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.

\n

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 ListMembers results for the organization behavior graph.

\n

An administrator account cannot use DeleteMembers to remove their own\n account from the behavior graph. To disable a behavior graph, the administrator account\n uses the DeleteGraph API method.

", "smithy.api#http": { "method": "POST", "uri": "/graph/members/removal", @@ -416,14 +463,14 @@ "GraphArn": { "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "

The ARN of the behavior graph to delete members from.

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

The ARN of the behavior graph to remove members from.

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

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.

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

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.

", "smithy.api#required": {} } } @@ -435,17 +482,90 @@ "AccountIds": { "target": "com.amazonaws.detective#AccountIdList", "traits": { - "smithy.api#documentation": "

The list of AWS account identifiers for the member accounts that Detective successfully\n deleted from the behavior graph.

" + "smithy.api#documentation": "

The list of Amazon Web Services account identifiers for the member accounts that Detective successfully removed from the behavior graph.

" } }, "UnprocessedAccounts": { "target": "com.amazonaws.detective#UnprocessedAccountList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" + } + } + } + }, + "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": "

Returns information about the configuration for the organization behavior graph.\n Currently indicates whether to automatically enable new organization accounts as member\n accounts.

\n

Can only be called by the Detective administrator account for the organization.

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

The ARN of the organization behavior graph.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.detective#DescribeOrganizationConfigurationResponse": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.detective#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to automatically enable new organization accounts as member accounts\n in the organization behavior graph.

" } } } }, + "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": "

Removes the Detective administrator account for the organization in the current\n Region. Deletes the behavior graph for that account.

\n

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.

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

Removes the member account from the specified behavior graph. This operation can only be\n called by a member account that has the ENABLED status.

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

Removes the member account from the specified behavior graph. This operation can only be\n called by an invited member account that has the ENABLED status.

\n

\n DisassociateMembership 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.

", "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": "

Designates the Detective administrator account for the organization in the\n current Region.

\n

If the account does not have Detective enabled, then enables Detective\n for that account and creates a new behavior graph.

\n

Can only be called by the organization management account.

\n

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.

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

The Amazon Web Services account identifier of the account to designate as the Detective administrator account for the organization.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.detective#ErrorMessage": { "type": "string" }, @@ -549,7 +706,7 @@ "AccountIds": { "target": "com.amazonaws.detective#AccountIdList", "traits": { - "smithy.api#documentation": "

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.

\n

You cannot use GetMembers to retrieve information about member accounts\n that were removed from the behavior graph.

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

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.

\n

You cannot use GetMembers to retrieve information about member accounts\n that were removed from the behavior graph.

", "smithy.api#required": {} } } @@ -561,7 +718,7 @@ "MemberDetails": { "target": "com.amazonaws.detective#MemberDetailList", "traits": { - "smithy.api#documentation": "

The member account details that Detective is returning in response to the request.

" + "smithy.api#documentation": "

The member account details that Detective is returning in response to the\n request.

" } }, "UnprocessedAccounts": { @@ -584,7 +741,7 @@ "CreatedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the behavior graph was created. The value is in milliseconds\n since the epoch.

" + "smithy.api#documentation": "

The date and time that the behavior graph was created. The value is an ISO8601 formatted\n string. For example, 2021-08-18T16:35:56.284Z.

" } } }, @@ -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": "

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.

\n

Open invitations are invitations that the member account has not responded to.

\n

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.

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

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.

\n

Open invitations are invitations that the member account has not responded to.

\n

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.

", "smithy.api#http": { "method": "POST", "uri": "/invitations/list", @@ -765,7 +937,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the list of member accounts for a behavior graph. Does not return member\n accounts that were removed from the behavior graph.

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

Retrieves the list of member accounts for a behavior graph.

\n

For invited accounts, the results do not include member accounts that were removed from\n the behavior graph.

\n

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.

", "smithy.api#http": { "method": "POST", "uri": "/graph/members/list", @@ -808,13 +980,80 @@ "MemberDetails": { "target": "com.amazonaws.detective#MemberDetailList", "traits": { - "smithy.api#documentation": "

The list of member accounts in the behavior graph.

\n

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.

" + "smithy.api#documentation": "

The list of member accounts in the behavior graph.

\n

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.

\n

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.

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

If there are more member accounts remaining in the results, then use this pagination\n token to request the next page of member accounts.

" + } + } + } + }, + "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": "

Returns information about the Detective administrator account for an\n organization. Can only be called by the organization management account.

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

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.

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

The maximum number of results to return.

" + } + } + } + }, + "com.amazonaws.detective#ListOrganizationAdminAccountsResponse": { + "type": "structure", + "members": { + "Administrators": { + "target": "com.amazonaws.detective#AdministratorList", + "traits": { + "smithy.api#documentation": "

The list of delegated administrator accounts.

" } }, "NextToken": { "target": "com.amazonaws.detective#PaginationToken", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } } @@ -877,19 +1116,19 @@ "AccountId": { "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account identifier for the member account.

" + "smithy.api#documentation": "

The Amazon Web Services account identifier for the member account.

" } }, "EmailAddress": { "target": "com.amazonaws.detective#EmailAddress", "traits": { - "smithy.api#documentation": "

The AWS account root user email address for the member account.

" + "smithy.api#documentation": "

The Amazon Web Services account root user email address for the member account.

" } }, "GraphArn": { "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "

The ARN of the behavior graph that the member account was invited to.

" + "smithy.api#documentation": "

The ARN of the behavior graph.

" } }, "MasterId": { @@ -898,37 +1137,37 @@ "smithy.api#deprecated": { "message": "This property is deprecated. Use AdministratorId instead." }, - "smithy.api#documentation": "

The AWS account identifier of the administrator account for the behavior graph.

" + "smithy.api#documentation": "

The Amazon Web Services account identifier of the administrator account for the behavior\n graph.

" } }, "AdministratorId": { "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account identifier of the administrator account for the behavior graph.

" + "smithy.api#documentation": "

The Amazon Web Services account identifier of the administrator account for the behavior\n graph.

" } }, "Status": { "target": "com.amazonaws.detective#MemberStatus", "traits": { - "smithy.api#documentation": "

The current membership status of the member account. The status can have one of the\n following values:

\n
    \n
  • \n

    \n INVITED - Indicates that the member was sent an invitation but has\n not yet responded.

    \n
  • \n
  • \n

    \n VERIFICATION_IN_PROGRESS - 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.

    \n
  • \n
  • \n

    \n VERIFICATION_FAILED - 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.

    \n
  • \n
  • \n

    \n ENABLED - Indicates that the member account accepted the invitation\n to contribute to the behavior graph.

    \n
  • \n
  • \n

    \n ACCEPTED_BUT_DISABLED - Indicates that the member account accepted\n the invitation but is prevented from contributing data to the behavior graph.\n DisabledReason provides the reason why the member account is not\n enabled.

    \n
  • \n
\n

Member accounts that declined an invitation or that were removed from the behavior graph\n are not included.

" + "smithy.api#documentation": "

The current membership status of the member account. The status can have one of the\n following values:

\n
    \n
  • \n

    \n INVITED - For invited accounts only. Indicates that the member was\n sent an invitation but has not yet responded.

    \n
  • \n
  • \n

    \n VERIFICATION_IN_PROGRESS - 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.

    \n

    For organization accounts in the organization behavior graph, indicates that\n Detective is verifying that the account belongs to the\n organization.

    \n
  • \n
  • \n

    \n VERIFICATION_FAILED - 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.

    \n
  • \n
  • \n

    \n ENABLED - 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.

    \n
  • \n
  • \n

    \n ACCEPTED_BUT_DISABLED - 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. DisabledReason provides the\n reason why the member account is not enabled.

    \n
  • \n
\n

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.

" } }, "DisabledReason": { "target": "com.amazonaws.detective#MemberDisabledReason", "traits": { - "smithy.api#documentation": "

For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that\n the member account is not enabled.

\n

The reason can have one of the following values:

\n
    \n
  • \n

    \n VOLUME_TOO_HIGH - Indicates that adding the member account would\n cause the data volume for the behavior graph to be too high.

    \n
  • \n
  • \n

    \n VOLUME_UNKNOWN - 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.

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

For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that\n the member account is not enabled.

\n

The reason can have one of the following values:

\n
    \n
  • \n

    \n VOLUME_TOO_HIGH - Indicates that adding the member account would\n cause the data volume for the behavior graph to be too high.

    \n
  • \n
  • \n

    \n VOLUME_UNKNOWN - 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.

    \n
  • \n
" } }, "InvitedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that Detective sent the invitation to the member account. The value is in\n milliseconds since the epoch.

" + "smithy.api#documentation": "

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 2021-08-18T16:35:56.284Z.

" } }, "UpdatedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the member account was last updated. The value is in milliseconds\n since the epoch.

" + "smithy.api#documentation": "

The date and time that the member account was last updated. The value is an ISO8601\n formatted string. For example, 2021-08-18T16:35:56.284Z.

" } }, "VolumeUsageInBytes": { @@ -940,7 +1179,7 @@ "VolumeUsageUpdatedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "

The data and time when the member account data volume was last updated.

" + "smithy.api#documentation": "

The data and time when the member account data volume was last updated. The value is an\n ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

" } }, "PercentOfGraphUtilization": { @@ -958,12 +1197,18 @@ "smithy.api#deprecated": { "message": "This property is deprecated. Use VolumeUsageUpdatedTime instead." }, - "smithy.api#documentation": "

The date and time when the graph utilization percentage was last updated.

" + "smithy.api#documentation": "

The date and time when the graph utilization percentage was last updated. The value is\n an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

" + } + }, + "InvitationType": { + "target": "com.amazonaws.detective#InvitationType", + "traits": { + "smithy.api#documentation": "

The type of behavior graph membership.

\n

For an organization account in the organization behavior graph, the type is\n ORGANIZATION.

\n

For an account that was invited to a behavior graph, the type is\n INVITATION.

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

Details about a member account that was invited to contribute to a behavior\n graph.

" + "smithy.api#documentation": "

Details about a member account in a behavior graph.

" } }, "com.amazonaws.detective#MemberDetailList": { @@ -1059,7 +1304,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 INVITED status.

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

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 INVITED\n status.

\n

\n RejectInvitation 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.

", "smithy.api#http": { "method": "POST", "uri": "/invitation/removal", @@ -1100,7 +1345,7 @@ } }, "traits": { - "smithy.api#documentation": "

This request cannot be completed for one of the following reasons.

\n
    \n
  • \n

    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.

    \n
  • \n
  • \n

    The request would cause the data rate for the behavior graph to exceed the maximum\n allowed.

    \n
  • \n
  • \n

    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.

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

This request cannot be completed for one of the following reasons.

\n
    \n
  • \n

    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.

    \n
  • \n
  • \n

    The request would cause the data rate for the behavior graph to exceed the maximum\n allowed.

    \n
  • \n
  • \n

    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.

    \n
  • \n
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -1128,7 +1373,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a request to enable data ingest for a member account that has a status of\n ACCEPTED_BUT_DISABLED.

\n

For valid member accounts, the status is updated as follows.

\n
    \n
  • \n

    If Detective enabled the member account, then the new status is\n ENABLED.

    \n
  • \n
  • \n

    If Detective cannot enable the member account, the status remains\n ACCEPTED_BUT_DISABLED.

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

Sends a request to enable data ingest for a member account that has a status of\n ACCEPTED_BUT_DISABLED.

\n

For valid member accounts, the status is updated as follows.

\n
    \n
  • \n

    If Detective enabled the member account, then the new status is\n ENABLED.

    \n
  • \n
  • \n

    If Detective cannot enable the member account, the status remains\n ACCEPTED_BUT_DISABLED.

    \n
  • \n
", "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": "

The request cannot be completed because too many other requests are occurring at the\n same time.

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

The AWS account identifier of the member account that was not processed.

" + "smithy.api#documentation": "

The Amazon Web Services account identifier of the member account that was not\n processed.

" } }, "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": "

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.

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

The ARN of the organization behavior graph.

", + "smithy.api#required": {} + } + }, + "AutoEnable": { + "target": "com.amazonaws.detective#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to automatically enable new organization accounts as member accounts\n in the organization behavior graph.

" + } + } + } + }, "com.amazonaws.detective#ValidationException": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/devops-guru.json b/aws/sdk/aws-models/devops-guru.json index cb3eb4d29e..74db84bada 100644 --- a/aws/sdk/aws-models/devops-guru.json +++ b/aws/sdk/aws-models/devops-guru.json @@ -1439,6 +1439,12 @@ "traits": { "smithy.api#documentation": "

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.

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

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.

\n \t

Each Amazon Web Services tag has two parts.

\n \t
    \n
  • \n \t\t\t

    A tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.

    \n \t\t
  • \n
  • \n \t\t\t

    An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.

    \n \t\t
  • \n
\n \t

Together these are known as key-value pairs.

\n \t \n\t\t

The string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.

\n\t
" + } } } }, @@ -3070,6 +3076,10 @@ { "value": "AWS_ACCOUNT", "name": "AWS_ACCOUNT" + }, + { + "value": "AWS_TAGS", + "name": "AWS_TAGS" } ] } diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index 585d0735a6..ccb5cebcf4 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -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": "

The ID of the Elastic Graphics accelerator.

", @@ -39138,7 +39167,7 @@ } }, "OfferingId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#OfferingId", "traits": { "aws.protocols#ec2QueryName": "OfferingId", "smithy.api#documentation": "

The ID of the offering.

", @@ -39282,7 +39311,7 @@ } }, "HostReservationId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#HostReservationId", "traits": { "aws.protocols#ec2QueryName": "HostReservationId", "smithy.api#documentation": "

The ID of the reservation that specifies the associated Dedicated Hosts.

", @@ -39306,7 +39335,7 @@ } }, "OfferingId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#OfferingId", "traits": { "aws.protocols#ec2QueryName": "OfferingId", "smithy.api#documentation": "

The ID of the reservation. This remains the same regardless of which Dedicated\n Hosts are associated with it.

", @@ -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": "

Modifies the payer responsibility for your VPC endpoint service.

" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

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 DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.ec2#VpcEndpointServiceId", + "traits": { + "smithy.api#documentation": "

The ID of the service.

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

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.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + } + }, "com.amazonaws.ec2#ModifyVpcEndpointServicePermissions": { "type": "operation", "input": { @@ -58161,6 +58240,17 @@ "smithy.api#documentation": "

Describes a path statement.

" } }, + "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": "

The ID of the reservation.

", @@ -67610,6 +67700,14 @@ "smithy.api#xmlName": "privateDnsNameConfiguration" } }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "aws.protocols#ec2QueryName": "PayerResponsibility", + "smithy.api#documentation": "

The payer responsibility.

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

The payer responsibility.

", + "smithy.api#xmlName": "payerResponsibility" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { diff --git a/aws/sdk/aws-models/ecs.json b/aws/sdk/aws-models/ecs.json index b51b101788..612e0d730f 100644 --- a/aws/sdk/aws-models/ecs.json +++ b/aws/sdk/aws-models/ecs.json @@ -285,7 +285,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the attachment. Valid values are PRECREATED,\n\t\t\t\tCREATED, ATTACHING, ATTACHED,\n\t\t\t\tDETACHING, DETACHED, and DELETED.

" + "smithy.api#documentation": "

The status of the attachment. Valid values are PRECREATED,\n\t\t\t\tCREATED, ATTACHING, ATTACHED,\n\t\t\t\tDETACHING, DETACHED, DELETED, and\n\t\t\t\tFAILED.

" } }, "details": { @@ -409,7 +409,7 @@ "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { - "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.

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

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.

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

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

\n\t\t

When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.

" + "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is disabled.

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

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.

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

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

\n\t\t

When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.

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

Starts a new task using the specified task definition.

\n\t\t

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n\t\t

The Amazon ECS API follows an eventual consistency model. This is because 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.

\n\t\t

To manage eventual consistency, you can do the following:

\n\t\t
    \n
  • \n\t\t\t\t

    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.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    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.

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

Starts a new task using the specified task definition.

\n\t\t

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n\t\t

The Amazon ECS API follows an eventual consistency model. This is because of the 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.

\n\t\t

To manage eventual consistency, you can do the following:

\n\t\t
    \n
  • \n\t\t\t\t

    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.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    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.

    \n\t\t\t
  • \n
" } }, "com.amazonaws.ecs#RunTaskRequest": { @@ -9097,7 +9097,7 @@ "containerInstances": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A list of container instance IDs or full ARN entries.

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

A list of up to 10 container instance IDs or full ARN entries.

", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/eks.json b/aws/sdk/aws-models/eks.json index 22aeb6d0c8..36f95d2ae1 100644 --- a/aws/sdk/aws-models/eks.json +++ b/aws/sdk/aws-models/eks.json @@ -74,7 +74,7 @@ "name": "eks" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on\n Amazon Web Services without needing to stand up or maintain your own Kubernetes control plane.\n Kubernetes is an open-source system for automating the deployment, scaling, and\n management of containerized applications.

\n

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use\n all the existing plugins and tooling from the Kubernetes community. Applications running\n on Amazon EKS are fully compatible with applications running on any standard Kubernetes\n environment, whether running in on-premises data centers or public clouds. This means\n that you can easily migrate any standard Kubernetes application to Amazon EKS without any\n code modification required.

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

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy\n for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain\n your own Kubernetes control plane. Kubernetes is an open-source system for automating\n the deployment, scaling, and management of containerized applications.

\n

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so\n you can use all the existing plugins and tooling from the Kubernetes community.\n Applications running on Amazon EKS are fully compatible with applications\n running on any standard Kubernetes environment, whether running in on-premises data\n centers or public clouds. This means that you can easily migrate any standard Kubernetes\n application to Amazon EKS without any code modification required.

", "smithy.api#title": "Amazon Elastic Kubernetes Service" }, "version": "2017-11-01", @@ -191,7 +191,7 @@ } }, "traits": { - "smithy.api#documentation": "

You don't have permissions to perform the requested operation. The user or role that\n is making the request must have at least one IAM permissions policy attached that\n grants the required permissions. For more information, see Access\n Management in the IAM User Guide.

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

You don't have permissions to perform the requested operation. The user or role that\n is making the request must have at least one IAM permissions policy\n attached that grants the required permissions. For more information, see Access\n Management in the IAM User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -250,7 +250,7 @@ "serviceAccountRoleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used\n by the add-on.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service\n account used by the add-on.

" } }, "tags": { @@ -610,12 +610,12 @@ "name": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group associated with an Amazon EKS managed node group.

" + "smithy.api#documentation": "

The name of the Auto Scaling group associated with an Amazon EKS managed node\n group.

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

An Auto Scaling group that is associated with an Amazon EKS managed node group.

" + "smithy.api#documentation": "

An Auto Scaling group that is associated with an Amazon EKS managed node\n group.

" } }, "com.amazonaws.eks#AutoScalingGroupList": { @@ -754,13 +754,13 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control\n plane to make calls to Amazon Web Services API operations on your behalf.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the\n Kubernetes control plane to make calls to Amazon Web Services API operations on your\n behalf.

" } }, "resourcesVpcConfig": { "target": "com.amazonaws.eks#VpcConfigResponse", "traits": { - "smithy.api#documentation": "

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have\n specific requirements to work properly with Kubernetes. For more information, see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide.

" + "smithy.api#documentation": "

The VPC configuration used by the cluster control plane. Amazon EKS VPC\n resources have specific requirements to work properly with Kubernetes. For more\n information, see Cluster VPC Considerations and Cluster Security\n Group Considerations in the Amazon EKS User Guide.

" } }, "kubernetesNetworkConfig": { @@ -802,7 +802,7 @@ "platformVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The platform version of your Amazon EKS cluster. For more information, see Platform\n Versions in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

The platform version of your Amazon EKS cluster. For more information, see\n Platform Versions in the \n Amazon EKS User Guide\n .

" } }, "tags": { @@ -950,7 +950,7 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is authorized to request the connector configuration.

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

The Amazon Resource Name (ARN) of the role that is authorized to request the connector\n configuration.

", "smithy.api#required": {} } }, @@ -984,7 +984,7 @@ "activationExpiry": { "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "

The expiration time of the connected cluster. The cluster's YAML file must be applied through the native \n provider.

" + "smithy.api#documentation": "

The expiration time of the connected cluster. The cluster's YAML file must be applied\n through the native provider.

" } }, "provider": { @@ -996,7 +996,7 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes\n cluster.

" } } }, @@ -1074,7 +1074,7 @@ "resolveConflicts": { "target": "com.amazonaws.eks#ResolveConflicts", "traits": { - "smithy.api#documentation": "

How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS\n add-on.

" + "smithy.api#documentation": "

How to resolve parameter value conflicts when migrating an existing add-on to an\n Amazon EKS add-on.

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

Creates an Amazon EKS control plane.

\n

The Amazon EKS control plane consists of control plane instances that run the Kubernetes\n software, such as etcd and the API server. The control plane runs in an\n account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server\n endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its\n own set of Amazon EC2 instances.

\n

The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC\n subnets to provide connectivity from the control plane instances to the nodes (for\n example, to support kubectl exec, logs, and proxy\n data flows).

\n

Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over\n the Kubernetes API server endpoint and a certificate file that is created for your\n cluster.

\n \n

In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster,\n you must configure your Kubernetes tooling to communicate with the API server and launch\n nodes into your cluster. For more information, see Managing Cluster\n Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.

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

Creates an Amazon EKS control plane.

\n

The Amazon EKS control plane consists of control plane instances that run the Kubernetes\n software, such as etcd and the API server. The control plane runs in an\n account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server\n endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its\n own set of Amazon EC2 instances.

\n

The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC\n subnets to provide connectivity from the control plane instances to the nodes (for\n example, to support kubectl exec, logs, and proxy\n data flows).

\n

Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over\n the Kubernetes API server endpoint and a certificate file that is created for your\n cluster.

\n \n

In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster,\n you must configure your Kubernetes tooling to communicate with the API server and launch\n nodes into your cluster. For more information, see Managing Cluster\n Authentication and Launching Amazon EKS nodes in the\n Amazon EKS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/clusters", @@ -1159,7 +1159,7 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control\n plane to make calls to Amazon Web Services API operations on your behalf. For more information, see\n Amazon EKS\n Service IAM Role in the \n Amazon EKS User Guide\n .

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

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the\n Kubernetes control plane to make calls to Amazon Web Services API operations on your\n behalf. For more information, see Amazon EKS Service IAM Role in the \n Amazon EKS User Guide\n .

", "smithy.api#required": {} } }, @@ -1179,7 +1179,7 @@ "logging": { "target": "com.amazonaws.eks#Logging", "traits": { - "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more\n information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see CloudWatch Pricing.

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

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to\n CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

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

Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate\n profile in a cluster to be able to run pods on Fargate.

\n

The Fargate profile allows an administrator to declare which pods run on Fargate and specify\n which pods run on which Fargate profile. This declaration is done through the profile’s\n selectors. Each profile can have up to five selectors that contain a namespace and\n labels. A namespace is required for every selector. The label field consists of multiple\n optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a\n to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is\n run on Fargate.

\n

When you create a Fargate profile, you must specify a pod execution role to use with the\n pods that are scheduled with the profile. This role is added to the cluster's Kubernetes\n Role Based Access\n Control (RBAC) for authorization so that the kubelet that is\n running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can\n appear in your cluster as a node. The pod execution role also provides IAM permissions\n to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more\n information, see Pod Execution Role in the Amazon EKS User Guide.

\n

Fargate profiles are immutable. However, you can create a new updated profile to replace\n an existing profile and then delete the original after the updated profile has finished\n creating.

\n

If any Fargate profiles in a cluster are in the DELETING status, you must\n wait for that Fargate profile to finish deleting before you can create any other profiles\n in that cluster.

\n

For more information, see Fargate Profile in the Amazon EKS User Guide.

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

Creates an Fargate profile for your Amazon EKS cluster. You\n must have at least one Fargate profile in a cluster to be able to run\n pods on Fargate.

\n

The Fargate profile allows an administrator to declare which pods run\n on Fargate and specify which pods run on which Fargate\n profile. This declaration is done through the profile’s selectors. Each profile can have\n up to five selectors that contain a namespace and labels. A namespace is required for\n every selector. The label field consists of multiple optional key-value pairs. Pods that\n match the selectors are scheduled on Fargate. If a to-be-scheduled pod\n matches any of the selectors in the Fargate profile, then that pod is run\n on Fargate.

\n

When you create a Fargate profile, you must specify a pod execution\n role to use with the pods that are scheduled with the profile. This role is added to the\n cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the\n kubelet that is running on the Fargate infrastructure\n can register with your Amazon EKS cluster so that it can appear in your cluster\n as a node. The pod execution role also provides IAM permissions to the\n Fargate infrastructure to allow read access to Amazon ECR\n image repositories. For more information, see Pod\n Execution Role in the Amazon EKS User Guide.

\n

Fargate profiles are immutable. However, you can create a new updated\n profile to replace an existing profile and then delete the original after the updated\n profile has finished creating.

\n

If any Fargate profiles in a cluster are in the DELETING\n status, you must wait for that Fargate profile to finish deleting before\n you can create any other profiles in that cluster.

\n

For more information, see Fargate Profile in the\n Amazon EKS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/fargate-profiles", @@ -1264,7 +1264,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster to apply the Fargate profile to.

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

The name of the Amazon EKS cluster to apply the Fargate profile\n to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1272,20 +1272,20 @@ "podExecutionRoleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in\n the Fargate profile. The pod execution role allows Fargate infrastructure to register with\n your cluster as a node, and it provides read access to Amazon ECR image repositories. For\n more information, see Pod Execution Role in the\n Amazon EKS User Guide.

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

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in\n the Fargate profile. The pod execution role allows Fargate\n infrastructure to register with your cluster as a node, and it provides read access to\n Amazon ECR image repositories. For more information, see Pod\n Execution Role in the Amazon EKS User Guide.

", "smithy.api#required": {} } }, "subnets": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The IDs of subnets to launch your pods into. At this time, pods running on Fargate are\n not assigned public IP addresses, so only private subnets (with no direct route to an\n Internet Gateway) are accepted for this parameter.

" + "smithy.api#documentation": "

The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with\n no direct route to an Internet Gateway) are accepted for this parameter.

" } }, "selectors": { "target": "com.amazonaws.eks#FargateProfileSelectors", "traits": { - "smithy.api#documentation": "

The selectors to match for pods to use this Fargate profile. Each selector must have an\n associated namespace. Optionally, you can also specify labels for a namespace. You may\n specify up to five selectors in a Fargate profile.

" + "smithy.api#documentation": "

The selectors to match for pods to use this Fargate profile. Each\n selector must have an associated namespace. Optionally, you can also specify labels for\n a namespace. You may specify up to five selectors in a Fargate\n profile.

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

Creates a managed node group for an Amazon EKS cluster. You can only create a node group\n for your cluster that is equal to the current Kubernetes version for the cluster. All\n node groups are created with the latest AMI release version for the respective minor\n Kubernetes version of the cluster, unless you deploy a custom AMI using a launch\n template. For more information about using launch templates, see Launch\n template support.

\n

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that\n are managed by Amazon Web Services for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS\n optimized Amazon Linux 2 AMI. For more information, see Managed\n Node Groups in the Amazon EKS User Guide.

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

Creates a managed node group for an Amazon EKS cluster. You can only create a\n node group for your cluster that is equal to the current Kubernetes version for the\n cluster. All node groups are created with the latest AMI release version for the\n respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using\n a launch template. For more information about using launch templates, see Launch\n template support.

\n

An Amazon EKS managed node group is an Amazon EC2\n Auto Scaling group and associated Amazon EC2 instances that are managed by\n Amazon Web Services for an Amazon EKS cluster. Each node group uses a version\n of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed\n Node Groups in the Amazon EKS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups", @@ -1400,7 +1400,7 @@ "amiType": { "target": "com.amazonaws.eks#AMITypes", "traits": { - "smithy.api#documentation": "

The AMI type for your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type. Non-GPU instances should use the\n AL2_x86_64 AMI type. Arm instances should use the\n AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 AMI.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI type for your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type. Non-GPU instances should use the\n AL2_x86_64 AMI type. Arm instances should use the\n AL2_ARM_64 AMI type. All types use the Amazon EKS optimized\n Amazon Linux 2 AMI. If you specify launchTemplate, and your launch template uses a custom AMI,\n then don't specify amiType, or the node group deployment\n will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "remoteAccess": { @@ -1412,7 +1412,7 @@ "nodeRole": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker\n node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive\n permissions for these API calls through an IAM instance profile and associated\n policies. Before you can launch nodes and register them into a cluster, you must create\n an IAM role for those nodes to use when they are launched. For more information, see\n Amazon EKS node IAM role in the \n Amazon EKS User Guide\n .\n If you specify launchTemplate, then don't specify \n IamInstanceProfile\n in your launch template,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

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

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The\n Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls\n through an IAM instance profile and associated policies. Before you can\n launch nodes and register them into a cluster, you must create an IAM\n role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the\n \n Amazon EKS User Guide\n . If you specify launchTemplate, then don't specify \n \n IamInstanceProfile\n in your launch template,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

", "smithy.api#required": {} } }, @@ -1468,7 +1468,7 @@ "releaseVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use with your node group. By default,\n the latest available AMI version for the node group's current Kubernetes version is\n used. For more information, see Amazon EKS\n optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate,\n and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use with your node group.\n By default, the latest available AMI version for the node group's current Kubernetes\n version is used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } } } @@ -1540,7 +1540,7 @@ "preserve": { "target": "com.amazonaws.eks#Boolean", "traits": { - "smithy.api#documentation": "

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it is not removed.

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

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM\n account is associated with the add-on, it is not removed.

", "smithy.api#httpQuery": "preserve" } } @@ -1580,7 +1580,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the Amazon EKS cluster control plane.

\n

If you have active services in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see Deleting a\n Cluster in the Amazon EKS User Guide.

\n

If you have managed node groups or Fargate profiles attached to the cluster, you must\n delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.

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

Deletes the Amazon EKS cluster control plane.

\n

If you have active services in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see Deleting a\n Cluster in the Amazon EKS User Guide.

\n

If you have managed node groups or Fargate profiles attached to the\n cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.

", "smithy.api#http": { "method": "DELETE", "uri": "/clusters/{name}", @@ -1635,7 +1635,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Fargate profile.

\n

When you delete a Fargate profile, any pods running on Fargate that were created with the\n profile are deleted. If those pods match another Fargate profile, then they are scheduled\n on Fargate with that profile. If they no longer match any Fargate profiles, then they are not\n scheduled on Fargate and they may remain in a pending state.

\n

Only one Fargate profile in a cluster can be in the DELETING status at a\n time. You must wait for a Fargate profile to finish deleting before you can delete any\n other profiles in that cluster.

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

Deletes an Fargate profile.

\n

When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match\n another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then\n they are not scheduled on Fargate and they may remain in a pending\n state.

\n

Only one Fargate profile in a cluster can be in the\n DELETING status at a time. You must wait for a Fargate\n profile to finish deleting before you can delete any other profiles in that\n cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/clusters/{clusterName}/fargate-profiles/{fargateProfileName}", @@ -1649,7 +1649,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the Fargate profile to delete.

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

The name of the Amazon EKS cluster associated with the Fargate\n profile to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1718,7 +1718,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster that is associated with your node group.

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

The name of the Amazon EKS cluster that is associated with your node\n group.

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

Deregisters a connected cluster to remove it from the Amazon EKS control plane.

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

Deregisters a connected cluster to remove it from the Amazon EKS control\n plane.

", "smithy.api#http": { "method": "DELETE", "uri": "/cluster-registrations/{name}", @@ -2235,7 +2235,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster associated with the Fargate profile.

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

The name of the Amazon EKS cluster associated with the Fargate\n profile.

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

Returns descriptive information about an update against your Amazon EKS cluster or\n associated managed node group.

\n

When the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.

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

Returns descriptive information about an update against your Amazon EKS\n cluster or associated managed node group.

\n

When the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.

", "smithy.api#http": { "method": "GET", "uri": "/clusters/{name}/updates/{updateId}", @@ -2546,7 +2546,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates an identity provider configuration from a cluster. If you disassociate\n an identity provider from your cluster, users included in the provider can no longer\n access the cluster. However, you can still access the cluster with Amazon Web Services IAM\n users.

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

Disassociates an identity provider configuration from a cluster. If you disassociate\n an identity provider from your cluster, users included in the provider can no longer\n access the cluster. However, you can still access the cluster with Amazon Web Services\n IAM users.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/identity-provider-configs/disassociate", @@ -2601,7 +2601,7 @@ "provider": { "target": "com.amazonaws.eks#Provider", "traits": { - "smithy.api#documentation": "

Key Management Service (KMS) key. Either the ARN or the alias can be used.

" + "smithy.api#documentation": "

Key Management Service (KMS) key. Either the ARN or the alias can be\n used.

" } } }, @@ -2702,7 +2702,7 @@ "errorCode": { "target": "com.amazonaws.eks#ErrorCode", "traits": { - "smithy.api#documentation": "

A brief description of the error.

\n
    \n
  • \n

    \n SubnetNotFound: We couldn't find one of the\n subnets associated with the cluster.

    \n
  • \n
  • \n

    \n SecurityGroupNotFound: We couldn't find one\n of the security groups associated with the cluster.

    \n
  • \n
  • \n

    \n EniLimitReached: You have reached the elastic\n network interface limit for your account.

    \n
  • \n
  • \n

    \n IpNotAvailable: A subnet associated with the\n cluster doesn't have any free IP addresses.

    \n
  • \n
  • \n

    \n AccessDenied: You don't have permissions to\n perform the specified operation.

    \n
  • \n
  • \n

    \n OperationNotPermitted: The service role\n associated with the cluster doesn't have the required access permissions for\n Amazon EKS.

    \n
  • \n
  • \n

    \n VpcIdNotFound: We couldn't find the VPC\n associated with the cluster.

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

A brief description of the error.

\n
    \n
  • \n

    \n SubnetNotFound: We couldn't find one of the\n subnets associated with the cluster.

    \n
  • \n
  • \n

    \n SecurityGroupNotFound: We couldn't find one\n of the security groups associated with the cluster.

    \n
  • \n
  • \n

    \n EniLimitReached: You have reached the elastic\n network interface limit for your account.

    \n
  • \n
  • \n

    \n IpNotAvailable: A subnet associated with the\n cluster doesn't have any free IP addresses.

    \n
  • \n
  • \n

    \n AccessDenied: You don't have permissions to\n perform the specified operation.

    \n
  • \n
  • \n

    \n OperationNotPermitted: The service role\n associated with the cluster doesn't have the required access permissions for\n Amazon EKS.

    \n
  • \n
  • \n

    \n VpcIdNotFound: We couldn't find the VPC\n associated with the cluster.

    \n
  • \n
" } }, "errorMessage": { @@ -2746,13 +2746,13 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster that the Fargate profile belongs to.

" + "smithy.api#documentation": "

The name of the Amazon EKS cluster that the Fargate profile\n belongs to.

" } }, "createdAt": { "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the Fargate profile was created.

" + "smithy.api#documentation": "

The Unix epoch timestamp in seconds for when the Fargate profile was\n created.

" } }, "podExecutionRoleArn": { @@ -2986,13 +2986,28 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.eks#IpFamily": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ipv4", + "name": "IPV4" + }, + { + "value": "ipv6", + "name": "IPV6" + } + ] + } + }, "com.amazonaws.eks#Issue": { "type": "structure", "members": { "code": { "target": "com.amazonaws.eks#NodegroupIssueCode", "traits": { - "smithy.api#documentation": "

A brief description of the error.

\n
    \n
  • \n

    \n AccessDenied: Amazon EKS or one or more of your\n managed nodes is failing to authenticate or authorize with your Kubernetes\n cluster API server.

    \n
  • \n
  • \n

    \n AsgInstanceLaunchFailures: Your Auto Scaling group is\n experiencing failures while attempting to launch instances.

    \n
  • \n
  • \n

    \n AutoScalingGroupNotFound: We couldn't find\n the Auto Scaling group associated with the managed node group. You may be able to\n recreate an Auto Scaling group with the same settings to recover.

    \n
  • \n
  • \n

    \n ClusterUnreachable: Amazon EKS or one or more of\n your managed nodes is unable to to communicate with your Kubernetes cluster API\n server. This can happen if there are network disruptions or if API servers are\n timing out processing requests.

    \n
  • \n
  • \n

    \n Ec2LaunchTemplateNotFound: We couldn't find\n the Amazon EC2 launch template for your managed node group. You may be able to\n recreate a launch template with the same settings to recover.

    \n
  • \n
  • \n

    \n Ec2LaunchTemplateVersionMismatch: The Amazon EC2\n launch template version for your managed node group does not match the version\n that Amazon EKS created. You may be able to revert to the version that Amazon EKS created\n to recover.

    \n
  • \n
  • \n

    \n Ec2SecurityGroupDeletionFailure: We could not\n delete the remote access security group for your managed node group. Remove any\n dependencies from the security group.

    \n
  • \n
  • \n

    \n Ec2SecurityGroupNotFound: We couldn't find\n the cluster security group for the cluster. You must recreate your\n cluster.

    \n
  • \n
  • \n

    \n Ec2SubnetInvalidConfiguration: One or more\n Amazon EC2 subnets specified for a node group do not automatically assign public IP\n addresses to instances launched into it. If you want your instances to be\n assigned a public IP address, then you need to enable the auto-assign\n public IP address setting for the subnet. See Modifying\n the public IPv4 addressing attribute for your subnet in the Amazon\n VPC User Guide.

    \n
  • \n
  • \n

    \n IamInstanceProfileNotFound: We couldn't find\n the IAM instance profile for your managed node group. You may be able to\n recreate an instance profile with the same settings to recover.

    \n
  • \n
  • \n

    \n IamNodeRoleNotFound: We couldn't find the\n IAM role for your managed node group. You may be able to recreate an IAM role\n with the same settings to recover.

    \n
  • \n
  • \n

    \n InstanceLimitExceeded: Your Amazon Web Services account is\n unable to launch any more instances of the specified instance type. You may be\n able to request an Amazon EC2 instance limit increase to recover.

    \n
  • \n
  • \n

    \n InsufficientFreeAddresses: One or more of the\n subnets associated with your managed node group does not have enough available\n IP addresses for new nodes.

    \n
  • \n
  • \n

    \n InternalFailure: These errors are usually\n caused by an Amazon EKS server-side issue.

    \n
  • \n
  • \n

    \n NodeCreationFailure: Your launched instances\n are unable to register with your Amazon EKS cluster. Common causes of this failure\n are insufficient node IAM role\n permissions or lack of outbound internet access for the nodes.

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

A brief description of the error.

\n
    \n
  • \n

    \n AccessDenied: Amazon EKS or one or\n more of your managed nodes is failing to authenticate or authorize with your\n Kubernetes cluster API server.

    \n
  • \n
  • \n

    \n AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch\n instances.

    \n
  • \n
  • \n

    \n AutoScalingGroupNotFound: We couldn't find\n the Auto Scaling group associated with the managed node group. You may be\n able to recreate an Auto Scaling group with the same settings to\n recover.

    \n
  • \n
  • \n

    \n ClusterUnreachable: Amazon EKS or one\n or more of your managed nodes is unable to to communicate with your Kubernetes\n cluster API server. This can happen if there are network disruptions or if API\n servers are timing out processing requests.

    \n
  • \n
  • \n

    \n Ec2LaunchTemplateNotFound: We couldn't find\n the Amazon EC2 launch template for your managed node group. You may be\n able to recreate a launch template with the same settings to recover.

    \n
  • \n
  • \n

    \n Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not\n match the version that Amazon EKS created. You may be able to revert to\n the version that Amazon EKS created to recover.

    \n
  • \n
  • \n

    \n Ec2SecurityGroupDeletionFailure: We could not\n delete the remote access security group for your managed node group. Remove any\n dependencies from the security group.

    \n
  • \n
  • \n

    \n Ec2SecurityGroupNotFound: We couldn't find\n the cluster security group for the cluster. You must recreate your\n cluster.

    \n
  • \n
  • \n

    \n Ec2SubnetInvalidConfiguration: One or more\n Amazon EC2 subnets specified for a node group do not automatically\n assign public IP addresses to instances launched into it. If you want your\n instances to be assigned a public IP address, then you need to enable the\n auto-assign public IP address setting for the subnet. See\n Modifying\n the public IPv4 addressing attribute for your subnet in the Amazon\n VPC User Guide.

    \n
  • \n
  • \n

    \n IamInstanceProfileNotFound: We couldn't find\n the IAM instance profile for your managed node group. You may be\n able to recreate an instance profile with the same settings to recover.

    \n
  • \n
  • \n

    \n IamNodeRoleNotFound: We couldn't find the\n IAM role for your managed node group. You may be able to\n recreate an IAM role with the same settings to recover.

    \n
  • \n
  • \n

    \n InstanceLimitExceeded: Your Amazon Web Services account is unable to launch any more instances of the specified instance\n type. You may be able to request an Amazon EC2 instance limit increase\n to recover.

    \n
  • \n
  • \n

    \n InsufficientFreeAddresses: One or more of the\n subnets associated with your managed node group does not have enough available\n IP addresses for new nodes.

    \n
  • \n
  • \n

    \n InternalFailure: These errors are usually\n caused by an Amazon EKS server-side issue.

    \n
  • \n
  • \n

    \n NodeCreationFailure: Your launched instances\n are unable to register with your Amazon EKS cluster. Common causes of this failure\n are insufficient node IAM role\n permissions or lack of outbound internet access for the nodes.

    \n
  • \n
" } }, "message": { @@ -3024,7 +3039,13 @@ "serviceIpv4Cidr": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a\n block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR\n blocks. We recommend that you specify a block that does not overlap with resources in\n other networks that are peered or connected to your VPC. The block must meet the\n following requirements:

\n
    \n
  • \n

    Within one of the following private IP address blocks: 10.0.0.0/8,\n 172.16.0.0/12, or 192.168.0.0/16.

    \n
  • \n
  • \n

    Doesn't overlap with any CIDR block assigned to the VPC that you selected for\n VPC.

    \n
  • \n
  • \n

    Between /24 and /12.

    \n
  • \n
\n \n

You can only specify a custom CIDR block when you create a cluster and can't\n change this value once the cluster is created.

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

Don't specify a value if you select ipv6 for ipFamily. The CIDR block to assign Kubernetes service IP addresses from.\n If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16\n or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not\n overlap with resources in other networks that are peered or connected to your VPC. The\n block must meet the following requirements:

\n
    \n
  • \n

    Within one of the following private IP address blocks: 10.0.0.0/8,\n 172.16.0.0/12, or 192.168.0.0/16.

    \n
  • \n
  • \n

    Doesn't overlap with any CIDR block assigned to the VPC that you selected for\n VPC.

    \n
  • \n
  • \n

    Between /24 and /12.

    \n
  • \n
\n \n

You can only specify a custom CIDR block when you create a cluster and can't\n change this value once the cluster is created.

\n
" + } + }, + "ipFamily": { + "target": "com.amazonaws.eks#IpFamily", + "traits": { + "smithy.api#documentation": "

Specify which IP version is used to assign Kubernetes Pod and Service IP addresses. If\n you don't specify a value, ipv4 is used by default. You can only specify an\n IP family when you create a cluster and can't change this value once the cluster is\n created. If you specify ipv6, the VPC and subnets that you specify for\n cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them.

\n

You can only specify ipv6 for 1.21 and later clusters that use version\n 1.10.0 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure\n that your VPC meets the requirements and that you're familiar with the considerations\n listed in Assigning\n IPv6 addresses to Pods and Services in the Amazon EKS User Guide. If\n you specify ipv6, Kubernetes assigns Service and Pod addresses from the\n unique local address range (fc00::/7). You can't specify a custom IPv6 CIDR\n block.

" } } }, @@ -3038,12 +3059,24 @@ "serviceIpv4Cidr": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't\n specify a CIDR block when you created the cluster, then Kubernetes assigns addresses\n from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then\n it was specified when the cluster was created and it cannot be changed.

" + "smithy.api#documentation": "

The CIDR block that Kubernetes Pod and Service IP addresses are assigned from.\n Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node\n is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes\n assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this\n was specified, then it was specified when the cluster was created and it can't be\n changed.

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

The CIDR block that Kubernetes Pod and Service IP addresses are assigned from if you\n created a 1.21 or later cluster with version 1.10.0 or later of the Amazon VPC CNI add-on and\n specified ipv6 for ipFamily when you\n created the cluster. Kubernetes assigns addresses from the unique local address range\n (fc00::/7).

" + } + }, + "ipFamily": { + "target": "com.amazonaws.eks#IpFamily", + "traits": { + "smithy.api#documentation": "

The IP family used to assign Kubernetes Pod and Service IP addresses. The IP family is\n always ipv4, unless you have a 1.21 or later cluster running\n version 1.10.0 or later of the Amazon VPC CNI add-on and specified ipv6 when you\n created the cluster.

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

The Kubernetes network configuration for the cluster.

" + "smithy.api#documentation": "

The Kubernetes network configuration for the cluster. The response contains a value\n for serviceIpv6Cidr or serviceIpv4Cidr, but not both.

" } }, "com.amazonaws.eks#LaunchTemplateSpecification": { @@ -3069,7 +3102,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n cannot include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API Reference.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

\n

Specify either name or id, but not both.

" + "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n cannot include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API\n Reference. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

\n

Specify either name or id, but not both.

" } }, "com.amazonaws.eks#ListAddons": { @@ -3189,7 +3222,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.

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

Lists the Amazon EKS clusters in your Amazon Web Services account in the\n specified Region.

", "smithy.api#http": { "method": "GET", "uri": "/clusters", @@ -3279,7 +3312,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services\n account in the specified Region.

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

Lists the Fargate profiles associated with the specified cluster in\n your Amazon Web Services account in the specified Region.

", "smithy.api#http": { "method": "GET", "uri": "/clusters/{clusterName}/fargate-profiles", @@ -3326,7 +3359,7 @@ "fargateProfileNames": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

A list of all of the Fargate profiles associated with the specified cluster.

" + "smithy.api#documentation": "

A list of all of the Fargate profiles associated with the specified\n cluster.

" } }, "nextToken": { @@ -3457,7 +3490,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon EKS managed node groups associated with the specified cluster in your\n Amazon Web Services account in the specified Region. Self-managed node groups are not listed.

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

Lists the Amazon EKS managed node groups associated with the specified cluster\n in your Amazon Web Services account in the specified Region. Self-managed node groups are\n not listed.

", "smithy.api#http": { "method": "GET", "uri": "/clusters/{clusterName}/node-groups", @@ -3477,7 +3510,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster that you would like to list node groups in.

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

The name of the Amazon EKS cluster that you would like to list node groups\n in.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3597,7 +3630,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services\n account, in the specified Region.

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

Lists the updates associated with an Amazon EKS cluster or managed node group\n in your Amazon Web Services account, in the specified Region.

", "smithy.api#http": { "method": "GET", "uri": "/clusters/{name}/updates", @@ -3691,7 +3724,7 @@ "enabled": { "target": "com.amazonaws.eks#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a\n log type isn't enabled, that log type doesn't export its control plane logs. Each\n individual log type can be enabled or disabled independently.

" + "smithy.api#documentation": "

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control\n plane logs. Each individual log type can be enabled or disabled independently.

" } } }, @@ -3782,7 +3815,7 @@ "releaseVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

If the node group was deployed using a launch template with a custom AMI, then this is\n the AMI ID that was specified in the launch template. For node groups that weren't\n deployed using a launch template, this is the version of the Amazon EKS optimized AMI that\n the node group was deployed with.

" + "smithy.api#documentation": "

If the node group was deployed using a launch template with a custom AMI, then this is\n the AMI ID that was specified in the launch template. For node groups that weren't\n deployed using a launch template, this is the version of the Amazon EKS\n optimized AMI that the node group was deployed with.

" } }, "createdAt": { @@ -3842,19 +3875,19 @@ "nodeRole": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The IAM role associated with your node group. The Amazon EKS node kubelet\n daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API\n calls through an IAM instance profile and associated policies.

" + "smithy.api#documentation": "

The IAM role associated with your node group. The Amazon EKS\n node kubelet daemon makes calls to Amazon Web Services APIs on your behalf.\n Nodes receive permissions for these API calls through an IAM instance\n profile and associated policies.

" } }, "labels": { "target": "com.amazonaws.eks#labelsMap", "traits": { - "smithy.api#documentation": "

The Kubernetes labels applied to the nodes in the node group.

\n \n

Only labels that are applied with the Amazon EKS API are shown here. There may be other\n Kubernetes labels applied to the nodes in this group.

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

The Kubernetes labels applied to the nodes in the node group.

\n \n

Only labels that are applied with the Amazon EKS API are shown here. There\n may be other Kubernetes labels applied to the nodes in this group.

\n
" } }, "taints": { "target": "com.amazonaws.eks#taintsList", "traits": { - "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group when they are\n created. Effect is one of No_Schedule, Prefer_No_Schedule, or No_Execute. Kubernetes taints\n can be used together with tolerations to control how workloads are scheduled to your\n nodes.

" + "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group when they are\n created. Effect is one of No_Schedule, Prefer_No_Schedule, or\n No_Execute. Kubernetes taints can be used together with tolerations to\n control how workloads are scheduled to your nodes.

" } }, "resources": { @@ -4023,13 +4056,13 @@ "maxSize": { "target": "com.amazonaws.eks#Capacity", "traits": { - "smithy.api#documentation": "

The maximum number of nodes that the managed node group can scale out to. For\n information about the maximum number that you can specify, see Amazon EKS service\n quotas in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The maximum number of nodes that the managed node group can scale out to. For\n information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

" } }, "desiredSize": { "target": "com.amazonaws.eks#ZeroCapacity", "traits": { - "smithy.api#documentation": "

The current number of nodes that the managed node group should maintain.

\n \n

If you use Cluster Autoscaler, you shouldn't change the desiredSize value\n directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\n down.

\n
\n

Whenever this parameter changes, the number of worker nodes in the node group is\n updated to the specified size. If this parameter is given a value that is smaller than\n the current number of running worker nodes, the necessary number of worker nodes are\n terminated to match the given value.\n \n When using CloudFormation, no action occurs if you remove this parameter from your CFN\n template.

\n

This parameter can be different from minSize in some cases, such as when starting with\n extra hosts for testing. This parameter can also be different when you want to start\n with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number\n if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is\n altered by Cluster Autoscaler (but can be out-of-date for short periods of time).\n Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than\n maxSize.

" + "smithy.api#documentation": "

The current number of nodes that the managed node group should maintain.

\n \n

If you use Cluster Autoscaler, you shouldn't change the desiredSize value\n directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\n down.

\n
\n

Whenever this parameter changes, the number of worker nodes in the node group is\n updated to the specified size. If this parameter is given a value that is smaller than\n the current number of running worker nodes, the necessary number of worker nodes are\n terminated to match the given value.\n \n When using CloudFormation, no action occurs if you remove this parameter from your CFN\n template.

\n

This parameter can be different from minSize in some cases, such as when starting with\n extra hosts for testing. This parameter can also be different when you want to start\n with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number\n if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is\n altered by Cluster Autoscaler (but can be out-of-date for short periods of time).\n Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than\n maxSize.

" } } }, @@ -4078,13 +4111,13 @@ "maxUnavailable": { "target": "com.amazonaws.eks#NonZeroInteger", "traits": { - "smithy.api#documentation": "

The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. \n This value or maxUnavailablePercentage is required to have a value.The maximum number\n is 100.

" + "smithy.api#documentation": "

The maximum number of nodes unavailable at once during a version update. Nodes will be\n updated in parallel. This value or maxUnavailablePercentage is required to\n have a value.The maximum number is 100.

" } }, "maxUnavailablePercentage": { "target": "com.amazonaws.eks#PercentCapacity", "traits": { - "smithy.api#documentation": "

The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be\n updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.

" + "smithy.api#documentation": "

The maximum percentage of nodes unavailable during a version update. This percentage\n of nodes will be updated in parallel, up to 100 nodes at once. This value or\n maxUnavailable is required to have a value.

" } } }, @@ -4259,7 +4292,7 @@ "requiredClaims": { "target": "com.amazonaws.eks#requiredClaimsMap", "traits": { - "smithy.api#documentation": "

The key value pairs that describe required claims in the identity token. If set, each\n claim is verified to be present in the token with a matching value. For the maximum\n number of claims that you can require, see Amazon EKS service quotas in the\n Amazon EKS User Guide.

" + "smithy.api#documentation": "

The key value pairs that describe required claims in the identity token. If set, each\n claim is verified to be present in the token with a matching value. For the maximum\n number of claims that you can require, see Amazon EKS service\n quotas in the Amazon EKS User Guide.

" } } }, @@ -4283,12 +4316,12 @@ "keyArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same\n region as the cluster, and if the KMS key was created in a different account, the user\n must have access to the KMS key. For more information, see Allowing\n Users in Other Accounts to Use a KMS key in the Key Management Service\n Developer Guide.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same\n region as the cluster, and if the KMS key was created in a different account, the user\n must have access to the KMS key. For more information, see Allowing\n Users in Other Accounts to Use a KMS key in the Key Management Service Developer Guide.

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

Identifies the Key Management Service (KMS) key used to encrypt the secrets.

" + "smithy.api#documentation": "

Identifies the Key Management Service (KMS) key used to encrypt the\n secrets.

" } }, "com.amazonaws.eks#RegisterCluster": { @@ -4326,7 +4359,7 @@ } ], "traits": { - "smithy.api#documentation": "

Connects a Kubernetes cluster to the Amazon EKS control plane.

\n

Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.\n

\n

Cluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS control plane.

\n

Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.

\n \n

After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, \n then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

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

Connects a Kubernetes cluster to the Amazon EKS control plane.

\n

Any Kubernetes cluster can be connected to the Amazon EKS control plane to\n view current information about the cluster and its nodes.

\n

Cluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS\n control plane.

\n

Second, a Manifest containing the activationID and\n activationCode must be applied to the Kubernetes cluster through it's\n native provider to provide visibility.

\n \n

After the Manifest is updated and applied, then the connected cluster is visible to\n the Amazon EKS control plane. If the Manifest is not applied within three days,\n then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

", "smithy.api#http": { "method": "POST", "uri": "/cluster-registrations", @@ -4354,7 +4387,7 @@ "clientRequestToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", "smithy.api#idempotencyToken": {} } }, @@ -4380,13 +4413,13 @@ "ec2SshKey": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the\n managed node group. For more information, see Amazon EC2 key\n pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

" + "smithy.api#documentation": "

The Amazon EC2 SSH key that provides access for SSH communication with the\n nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

" } }, "sourceSecurityGroups": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The security groups that are allowed SSH access (port 22) to the nodes. If you specify\n an Amazon EC2 SSH key but do not specify a source security group when you create a managed\n node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0). For more\n information, see Security Groups for Your VPC in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

The security groups that are allowed SSH access (port 22) to the nodes. If you specify\n an Amazon EC2 SSH key but do not specify a source security group when you create\n a managed node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0).\n For more information, see Security Groups for Your VPC in the\n Amazon Virtual Private Cloud User Guide.

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

Associates the specified tags to a resource with the specified\n resourceArn. If existing tags on a resource are not specified in the\n request parameters, they are not changed. When a resource is deleted, the tags\n associated with that resource are deleted as well. Tags that you create for Amazon EKS\n resources do not propagate to any other resources associated with the cluster. For\n example, if you tag a cluster with this operation, that tag does not automatically\n propagate to the subnets and nodes associated with the cluster.

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

Associates the specified tags to a resource with the specified\n resourceArn. If existing tags on a resource are not specified in the\n request parameters, they are not changed. When a resource is deleted, the tags\n associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the\n cluster. For example, if you tag a cluster with this operation, that tag does not\n automatically propagate to the subnets and nodes associated with the cluster.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -4736,7 +4769,7 @@ } }, "traits": { - "smithy.api#documentation": "

At least one of your specified cluster subnets is in an Availability Zone that does\n not support Amazon EKS. The exception output specifies the supported Availability Zones for\n your account, from which you can choose subnets for your cluster.

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

At least one of your specified cluster subnets is in an Availability Zone that does\n not support Amazon EKS. The exception output specifies the supported\n Availability Zones for your account, from which you can choose subnets for your\n cluster.

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

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the\n update. The response output includes an update ID that you can use to track the status\n of your cluster update with the DescribeUpdate API operation.

\n

You can use this API operation to enable or disable exporting the Kubernetes control\n plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't\n exported to CloudWatch Logs. For more information, see Amazon EKS\n Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see CloudWatch Pricing.

\n
\n

You can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .

\n \n

You can't update the subnets or security group IDs for an existing cluster.

\n
\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

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

Updates an Amazon EKS cluster configuration. Your cluster continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your cluster update with the DescribeUpdate API\n operation.

\n

You can use this API operation to enable or disable exporting the Kubernetes control\n plane logs for your cluster to CloudWatch Logs. By default, cluster control plane\n logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n
\n

You can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

\n \n

You can't update the subnets or security group IDs for an existing cluster.

\n
\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{name}/update-config", @@ -4980,7 +5013,7 @@ "logging": { "target": "com.amazonaws.eks#Logging", "traits": { - "smithy.api#documentation": "

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more\n information, see Amazon EKS cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see CloudWatch Pricing.

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

Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to\n CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n
" } }, "clientRequestToken": { @@ -5029,7 +5062,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues\n to function during the update. The response output includes an update ID that you can\n use to track the status of your cluster update with the DescribeUpdate\n API operation.

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

\n

If your cluster has managed node groups attached to it, all of your node groups’\n Kubernetes versions must match the cluster’s Kubernetes version in order to update the\n cluster to a new Kubernetes version.

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

Updates an Amazon EKS cluster to the specified Kubernetes version. Your\n cluster continues to function during the update. The response output includes an update\n ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

\n

If your cluster has managed node groups attached to it, all of your node groups’\n Kubernetes versions must match the cluster’s Kubernetes version in order to update the\n cluster to a new Kubernetes version.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{name}/updates", @@ -5124,7 +5157,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an Amazon EKS managed node group configuration. Your node group continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your node group update with the DescribeUpdate\n API operation. Currently you can update the Kubernetes labels for a node group or the\n scaling configuration.

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

Updates an Amazon EKS managed node group configuration. Your node group\n continues to function during the update. The response output includes an update ID that\n you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes\n labels for a node group or the scaling configuration.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-config", @@ -5138,7 +5171,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster that the managed node group resides in.

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

The name of the Amazon EKS cluster that the managed node group resides\n in.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5221,7 +5254,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

\n

You can update a node group using a launch template only if the node group was\n originally deployed with a launch template. If you need to update a custom AMI in a node\n group that was deployed with a launch template, then update your custom AMI, specify the\n new ID in a new version of the launch template, and then update the node group to the\n new version of the launch template.

\n

If you update without a launch template, then you can update to the latest available\n AMI version of a node group's current Kubernetes version by not specifying a Kubernetes\n version in the request. You can update to the latest AMI version of your cluster's\n current Kubernetes version by specifying your cluster's Kubernetes version in the\n request. For more information, see Amazon EKS\n optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.

\n

You cannot roll back a node group to an earlier Kubernetes version or AMI\n version.

\n

When a node in a managed node group is terminated due to a scaling action or update,\n the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully\n and will fail if it is unable to do so. You can force the update if Amazon EKS\n is unable to drain the nodes as a result of a pod disruption budget issue.

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

Updates the Kubernetes version or AMI version of an Amazon EKS managed node\n group.

\n

You can update a node group using a launch template only if the node group was\n originally deployed with a launch template. If you need to update a custom AMI in a node\n group that was deployed with a launch template, then update your custom AMI, specify the\n new ID in a new version of the launch template, and then update the node group to the\n new version of the launch template.

\n

If you update without a launch template, then you can update to the latest available\n AMI version of a node group's current Kubernetes version by not specifying a Kubernetes\n version in the request. You can update to the latest AMI version of your cluster's\n current Kubernetes version by specifying your cluster's Kubernetes version in the\n request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.

\n

You cannot roll back a node group to an earlier Kubernetes version or AMI\n version.

\n

When a node in a managed node group is terminated due to a scaling action or update,\n the pods in that node are drained first. Amazon EKS attempts to drain the nodes\n gracefully and will fail if it is unable to do so. You can force the update\n if Amazon EKS is unable to drain the nodes as a result of a pod disruption\n budget issue.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-version", @@ -5235,7 +5268,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS cluster that is associated with the managed node group to\n update.

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

The name of the Amazon EKS cluster that is associated with the managed node\n group to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5257,7 +5290,7 @@ "releaseVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the\n latest available AMI version for the node group's Kubernetes version is used. For more\n information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the\n Amazon EKS User Guide. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group update will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use for the update. By\n default, the latest available AMI version for the node group's Kubernetes version is\n used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "launchTemplate": { @@ -5502,36 +5535,36 @@ "subnetIds": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network\n interfaces in these subnets to allow communication between your nodes and the Kubernetes\n control plane.

" + "smithy.api#documentation": "

Specify subnets for your Amazon EKS nodes. Amazon EKS creates\n cross-account elastic network interfaces in these subnets to allow communication between\n your nodes and the Kubernetes control plane.

" } }, "securityGroupIds": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

Specify one or more security groups for the cross-account elastic network interfaces\n that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes\n control plane. If you don't specify any security groups, then familiarize yourself with\n the difference between Amazon EKS defaults for clusters deployed with Kubernetes:

\n
    \n
  • \n

    1.14 Amazon EKS platform version eks.2 and earlier

    \n
  • \n
  • \n

    1.14 Amazon EKS platform version eks.3 and later

    \n
  • \n
\n

For more information, see Amazon EKS security group\n considerations in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

Specify one or more security groups for the cross-account elastic network interfaces\n that Amazon EKS creates to use that allow communication between your nodes and\n the Kubernetes control plane. If you don't specify any security groups, then familiarize\n yourself with the difference between Amazon EKS defaults for clusters deployed\n with Kubernetes:

\n
    \n
  • \n

    1.14 Amazon EKS platform version eks.2 and earlier

    \n
  • \n
  • \n

    1.14 Amazon EKS platform version eks.3 and later

    \n
  • \n
\n

For more information, see Amazon EKS security group\n considerations in the \n Amazon EKS User Guide\n .

" } }, "endpointPublicAccess": { "target": "com.amazonaws.eks#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Set this value to false to disable public access to your cluster's\n Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes\n API server can only receive requests from within the cluster VPC. The default value for\n this parameter is true, which enables public access for your Kubernetes API\n server. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

Set this value to false to disable public access to your cluster's\n Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes\n API server can only receive requests from within the cluster VPC. The default value for\n this parameter is true, which enables public access for your Kubernetes API\n server. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

" } }, "endpointPrivateAccess": { "target": "com.amazonaws.eks#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Set this value to true to enable private access for your cluster's\n Kubernetes API server endpoint. If you enable private access, Kubernetes API requests\n from within your cluster's VPC use the private VPC endpoint. The default value for this\n parameter is false, which disables private access for your Kubernetes API\n server. If you disable private access and you have nodes or Fargate pods in the\n cluster, then ensure that publicAccessCidrs includes the necessary CIDR\n blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

Set this value to true to enable private access for your cluster's\n Kubernetes API server endpoint. If you enable private access, Kubernetes API requests\n from within your cluster's VPC use the private VPC endpoint. The default value for this\n parameter is false, which disables private access for your Kubernetes API\n server. If you disable private access and you have nodes or Fargate\n pods in the cluster, then ensure that publicAccessCidrs includes the\n necessary CIDR blocks for communication with the nodes or Fargate pods.\n For more information, see Amazon EKS cluster endpoint access control in\n the \n Amazon EKS User Guide\n .

" } }, "publicAccessCidrs": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that\n you specify is denied. The default value is 0.0.0.0/0. If you've disabled\n private endpoint access and you have nodes or Fargate pods in the cluster, then ensure\n that you specify the necessary CIDR blocks. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that\n you specify is denied. The default value is 0.0.0.0/0. If you've disabled\n private endpoint access and you have nodes or Fargate pods in the\n cluster, then ensure that you specify the necessary CIDR blocks. For more information,\n see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

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

An object representing the VPC configuration to use for an Amazon EKS cluster.

" + "smithy.api#documentation": "

An object representing the VPC configuration to use for an Amazon EKS\n cluster.

" } }, "com.amazonaws.eks#VpcConfigResponse": { @@ -5552,7 +5585,7 @@ "clusterSecurityGroupId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The cluster security group that was created by Amazon EKS for the cluster. Managed node\n groups use this security group for control-plane-to-data-plane communication.

" + "smithy.api#documentation": "

The cluster security group that was created by Amazon EKS for the cluster.\n Managed node groups use this security group for control-plane-to-data-plane\n communication.

" } }, "vpcId": { @@ -5564,24 +5597,24 @@ "endpointPublicAccess": { "target": "com.amazonaws.eks#Boolean", "traits": { - "smithy.api#documentation": "

This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If\n the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server\n can only receive requests that originate from within the cluster VPC.

" + "smithy.api#documentation": "

This parameter indicates whether the Amazon EKS public API server endpoint is\n enabled. If the Amazon EKS public API server endpoint is disabled, your\n cluster's Kubernetes API server can only receive requests that originate from within the\n cluster VPC.

" } }, "endpointPrivateAccess": { "target": "com.amazonaws.eks#Boolean", "traits": { - "smithy.api#documentation": "

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If\n the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate\n from within your cluster's VPC use the private VPC endpoint instead of traversing the\n internet. If this value is disabled and you have nodes or Fargate pods in the cluster,\n then ensure that publicAccessCidrs includes the necessary CIDR blocks for\n communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

This parameter indicates whether the Amazon EKS private API server endpoint is\n enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes\n API requests that originate from within your cluster's VPC use the private VPC endpoint\n instead of traversing the internet. If this value is disabled and you have nodes or\n Fargate pods in the cluster, then ensure that\n publicAccessCidrs includes the necessary CIDR blocks for communication\n with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

" } }, "publicAccessCidrs": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks\n is denied. The default value is 0.0.0.0/0. If you've disabled private\n endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the\n necessary CIDR blocks are listed. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .

" + "smithy.api#documentation": "

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks\n is denied. The default value is 0.0.0.0/0. If you've disabled private\n endpoint access and you have nodes or Fargate pods in the cluster,\n then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

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

An object representing an Amazon EKS cluster VPC configuration response.

" + "smithy.api#documentation": "

An object representing an Amazon EKS cluster VPC configuration\n response.

" } }, "com.amazonaws.eks#ZeroCapacity": { diff --git a/aws/sdk/aws-models/finspace-data.json b/aws/sdk/aws-models/finspace-data.json index 2f28ffa467..1ebe692d23 100644 --- a/aws/sdk/aws-models/finspace-data.json +++ b/aws/sdk/aws-models/finspace-data.json @@ -250,6 +250,12 @@ "smithy.api#documentation": "

Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, + "activeFromTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#box": {} + } + }, "updatesChangesetId": { "target": "com.amazonaws.finspacedata#ChangesetId", "traits": { @@ -696,8 +702,7 @@ "datasetDescription": { "target": "com.amazonaws.finspacedata#DatasetDescription", "traits": { - "smithy.api#documentation": "

Description of a Dataset.

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

Description of a Dataset.

" } }, "ownerInfo": { @@ -716,8 +721,7 @@ "alias": { "target": "com.amazonaws.finspacedata#AliasString", "traits": { - "smithy.api#documentation": "

The unique resource identifier for a Dataset.

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

The unique resource identifier for a Dataset.

" } }, "schemaDefinition": { @@ -792,6 +796,12 @@ "smithy.api#documentation": "

Destination type for a Dataview.

\n
    \n
  • \n

    \n GLUE_TABLE - Glue table destination type.

    \n
  • \n
", "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": "

Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

" } }, + "activeFromTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#box": {} + } + }, "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": "

The unique resource identifier for a Dataset.

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

The unique resource identifier for a Dataset.

" } }, "schemaDefinition": { diff --git a/aws/sdk/aws-models/forecast.json b/aws/sdk/aws-models/forecast.json index 05c0c39cf1..50182d1a4b 100644 --- a/aws/sdk/aws-models/forecast.json +++ b/aws/sdk/aws-models/forecast.json @@ -42,7 +42,7 @@ "Configuration": { "target": "com.amazonaws.forecast#Configuration", "traits": { - "smithy.api#documentation": "

\n Weather Index\n

\n

To enable the Weather Index, do not specify a value for\n Configuration.

\n

\n Holidays\n

\n

To enable Holidays, specify a country with one of the following two-letter country\n codes:

\n
    \n
  • \n

    \"AL\" - ALBANIA

    \n
  • \n
  • \n

    \"AR\" - ARGENTINA

    \n
  • \n
  • \n

    \"AT\" - AUSTRIA

    \n
  • \n
  • \n

    \"AU\" - AUSTRALIA

    \n
  • \n
  • \n

    \"BA\" - BOSNIA HERZEGOVINA

    \n
  • \n
  • \n

    \"BE\" - BELGIUM

    \n
  • \n
  • \n

    \"BG\" - BULGARIA

    \n
  • \n
  • \n

    \"BO\" - BOLIVIA

    \n
  • \n
  • \n

    \"BR\" - BRAZIL

    \n
  • \n
  • \n

    \"BY\" - BELARUS

    \n
  • \n
  • \n

    \"CA\" - CANADA

    \n
  • \n
  • \n

    \"CL\" - CHILE

    \n
  • \n
  • \n

    \"CO\" - COLOMBIA

    \n
  • \n
  • \n

    \"CR\" - COSTA RICA

    \n
  • \n
  • \n

    \"HR\" - CROATIA

    \n
  • \n
  • \n

    \"CZ\" - CZECH REPUBLIC

    \n
  • \n
  • \n

    \"DK\" - DENMARK

    \n
  • \n
  • \n

    \"EC\" - ECUADOR

    \n
  • \n
  • \n

    \"EE\" - ESTONIA

    \n
  • \n
  • \n

    \"ET\" - ETHIOPIA

    \n
  • \n
  • \n

    \"FI\" - FINLAND

    \n
  • \n
  • \n

    \"FR\" - FRANCE

    \n
  • \n
  • \n

    \"DE\" - GERMANY

    \n
  • \n
  • \n

    \"GR\" - GREECE

    \n
  • \n
  • \n

    \"HU\" - HUNGARY

    \n
  • \n
  • \n

    \"IS\" - ICELAND

    \n
  • \n
  • \n

    \"IN\" - INDIA

    \n
  • \n
  • \n

    \"IE\" - IRELAND

    \n
  • \n
  • \n

    \"IT\" - ITALY

    \n
  • \n
  • \n

    \"JP\" - JAPAN

    \n
  • \n
  • \n

    \"KZ\" - KAZAKHSTAN

    \n
  • \n
  • \n

    \"KR\" - KOREA

    \n
  • \n
  • \n

    \"LV\" - LATVIA

    \n
  • \n
  • \n

    \"LI\" - LIECHTENSTEIN

    \n
  • \n
  • \n

    \"LT\" - LITHUANIA

    \n
  • \n
  • \n

    \"LU\" - LUXEMBOURG

    \n
  • \n
  • \n

    \"MK\" - MACEDONIA

    \n
  • \n
  • \n

    \"MT\" - MALTA

    \n
  • \n
  • \n

    \"MX\" - MEXICO

    \n
  • \n
  • \n

    \"MD\" - MOLDOVA

    \n
  • \n
  • \n

    \"ME\" - MONTENEGRO

    \n
  • \n
  • \n

    \"NL\" - NETHERLANDS

    \n
  • \n
  • \n

    \"NZ\" - NEW ZEALAND

    \n
  • \n
  • \n

    \"NI\" - NICARAGUA

    \n
  • \n
  • \n

    \"NG\" - NIGERIA

    \n
  • \n
  • \n

    \"NO\" - NORWAY

    \n
  • \n
  • \n

    \"PA\" - PANAMA

    \n
  • \n
  • \n

    \"PY\" - PARAGUAY

    \n
  • \n
  • \n

    \"PE\" - PERU

    \n
  • \n
  • \n

    \"PL\" - POLAND

    \n
  • \n
  • \n

    \"PT\" - PORTUGAL

    \n
  • \n
  • \n

    \"RO\" - ROMANIA

    \n
  • \n
  • \n

    \"RU\" - RUSSIA

    \n
  • \n
  • \n

    \"RS\" - SERBIA

    \n
  • \n
  • \n

    \"SK\" - SLOVAKIA

    \n
  • \n
  • \n

    \"SI\" - SLOVENIA

    \n
  • \n
  • \n

    \"ZA\" - SOUTH AFRICA

    \n
  • \n
  • \n

    \"ES\" - SPAIN

    \n
  • \n
  • \n

    \"SE\" - SWEDEN

    \n
  • \n
  • \n

    \"CH\" - SWITZERLAND

    \n
  • \n
  • \n

    \"UA\" - UKRAINE

    \n
  • \n
  • \n

    \"AE\" - UNITED ARAB EMIRATES

    \n
  • \n
  • \n

    \"US\" - UNITED STATES

    \n
  • \n
  • \n

    \"UK\" - UNITED KINGDOM

    \n
  • \n
  • \n

    \"UY\" - URUGUAY

    \n
  • \n
  • \n

    \"VE\" - VENEZUELA

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

\n Weather Index\n

\n

To enable the Weather Index, do not specify a value for\n Configuration.

\n

\n Holidays\n

\n

To enable Holidays, set CountryCode to one of the following two-letter country\n codes:

\n
    \n
  • \n

    \"AL\" - ALBANIA

    \n
  • \n
  • \n

    \"AR\" - ARGENTINA

    \n
  • \n
  • \n

    \"AT\" - AUSTRIA

    \n
  • \n
  • \n

    \"AU\" - AUSTRALIA

    \n
  • \n
  • \n

    \"BA\" - BOSNIA HERZEGOVINA

    \n
  • \n
  • \n

    \"BE\" - BELGIUM

    \n
  • \n
  • \n

    \"BG\" - BULGARIA

    \n
  • \n
  • \n

    \"BO\" - BOLIVIA

    \n
  • \n
  • \n

    \"BR\" - BRAZIL

    \n
  • \n
  • \n

    \"BY\" - BELARUS

    \n
  • \n
  • \n

    \"CA\" - CANADA

    \n
  • \n
  • \n

    \"CL\" - CHILE

    \n
  • \n
  • \n

    \"CO\" - COLOMBIA

    \n
  • \n
  • \n

    \"CR\" - COSTA RICA

    \n
  • \n
  • \n

    \"HR\" - CROATIA

    \n
  • \n
  • \n

    \"CZ\" - CZECH REPUBLIC

    \n
  • \n
  • \n

    \"DK\" - DENMARK

    \n
  • \n
  • \n

    \"EC\" - ECUADOR

    \n
  • \n
  • \n

    \"EE\" - ESTONIA

    \n
  • \n
  • \n

    \"ET\" - ETHIOPIA

    \n
  • \n
  • \n

    \"FI\" - FINLAND

    \n
  • \n
  • \n

    \"FR\" - FRANCE

    \n
  • \n
  • \n

    \"DE\" - GERMANY

    \n
  • \n
  • \n

    \"GR\" - GREECE

    \n
  • \n
  • \n

    \"HU\" - HUNGARY

    \n
  • \n
  • \n

    \"IS\" - ICELAND

    \n
  • \n
  • \n

    \"IN\" - INDIA

    \n
  • \n
  • \n

    \"IE\" - IRELAND

    \n
  • \n
  • \n

    \"IT\" - ITALY

    \n
  • \n
  • \n

    \"JP\" - JAPAN

    \n
  • \n
  • \n

    \"KZ\" - KAZAKHSTAN

    \n
  • \n
  • \n

    \"KR\" - KOREA

    \n
  • \n
  • \n

    \"LV\" - LATVIA

    \n
  • \n
  • \n

    \"LI\" - LIECHTENSTEIN

    \n
  • \n
  • \n

    \"LT\" - LITHUANIA

    \n
  • \n
  • \n

    \"LU\" - LUXEMBOURG

    \n
  • \n
  • \n

    \"MK\" - MACEDONIA

    \n
  • \n
  • \n

    \"MT\" - MALTA

    \n
  • \n
  • \n

    \"MX\" - MEXICO

    \n
  • \n
  • \n

    \"MD\" - MOLDOVA

    \n
  • \n
  • \n

    \"ME\" - MONTENEGRO

    \n
  • \n
  • \n

    \"NL\" - NETHERLANDS

    \n
  • \n
  • \n

    \"NZ\" - NEW ZEALAND

    \n
  • \n
  • \n

    \"NI\" - NICARAGUA

    \n
  • \n
  • \n

    \"NG\" - NIGERIA

    \n
  • \n
  • \n

    \"NO\" - NORWAY

    \n
  • \n
  • \n

    \"PA\" - PANAMA

    \n
  • \n
  • \n

    \"PY\" - PARAGUAY

    \n
  • \n
  • \n

    \"PE\" - PERU

    \n
  • \n
  • \n

    \"PL\" - POLAND

    \n
  • \n
  • \n

    \"PT\" - PORTUGAL

    \n
  • \n
  • \n

    \"RO\" - ROMANIA

    \n
  • \n
  • \n

    \"RU\" - RUSSIA

    \n
  • \n
  • \n

    \"RS\" - SERBIA

    \n
  • \n
  • \n

    \"SK\" - SLOVAKIA

    \n
  • \n
  • \n

    \"SI\" - SLOVENIA

    \n
  • \n
  • \n

    \"ZA\" - SOUTH AFRICA

    \n
  • \n
  • \n

    \"ES\" - SPAIN

    \n
  • \n
  • \n

    \"SE\" - SWEDEN

    \n
  • \n
  • \n

    \"CH\" - SWITZERLAND

    \n
  • \n
  • \n

    \"UA\" - UKRAINE

    \n
  • \n
  • \n

    \"AE\" - UNITED ARAB EMIRATES

    \n
  • \n
  • \n

    \"US\" - UNITED STATES

    \n
  • \n
  • \n

    \"UK\" - UNITED KINGDOM

    \n
  • \n
  • \n

    \"UY\" - URUGUAY

    \n
  • \n
  • \n

    \"VE\" - VENEZUELA

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

Creates an Amazon Forecast predictor.

\n

Amazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain existing\n predictors.

\n

\n Creating new predictors\n

\n

The following parameters are required when creating a new predictor:

\n
    \n
  • \n

    \n PredictorName - A unique name for the predictor.

    \n
  • \n
  • \n

    \n DatasetGroupArn - The ARN of the dataset group used to train the\n predictor.

    \n
  • \n
  • \n

    \n ForecastFrequency - The granularity of your forecasts (hourly,\n daily, weekly, etc).

    \n
  • \n
  • \n

    \n ForecastHorizon - The number of time steps being\n forecasted.

    \n
  • \n
\n

When creating a new predictor, do not specify a value for\n ReferencePredictorArn.

\n

\n Upgrading and retraining predictors\n

\n

The following parameters are required when retraining or upgrading a predictor:

\n
    \n
  • \n

    \n PredictorName - A unique name for the predictor.

    \n
  • \n
  • \n

    \n ReferencePredictorArn - The ARN of the predictor to retrain or\n upgrade.

    \n
  • \n
\n

When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn and PredictorName.

" + "smithy.api#documentation": "

Creates an Amazon Forecast predictor.

\n

Amazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain existing\n predictors.

\n

\n Creating new predictors\n

\n

The following parameters are required when creating a new predictor:

\n
    \n
  • \n

    \n PredictorName - A unique name for the predictor.

    \n
  • \n
  • \n

    \n DatasetGroupArn - The ARN of the dataset group used to train the\n predictor.

    \n
  • \n
  • \n

    \n ForecastFrequency - The granularity of your forecasts (hourly,\n daily, weekly, etc).

    \n
  • \n
  • \n

    \n ForecastHorizon - The number of time steps being\n forecasted.

    \n
  • \n
\n

When creating a new predictor, do not specify a value for\n ReferencePredictorArn.

\n

\n Upgrading and retraining predictors\n

\n

The following parameters are required when retraining or upgrading a predictor:

\n
    \n
  • \n

    \n PredictorName - A unique name for the predictor.

    \n
  • \n
  • \n

    \n ReferencePredictorArn - The ARN of the predictor to retrain or\n upgrade.

    \n
  • \n
\n

When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn and PredictorName.

" } }, "com.amazonaws.forecast#CreateAutoPredictorRequest": { @@ -491,7 +491,10 @@ } }, "ExplainPredictor": { - "target": "com.amazonaws.forecast#Boolean" + "target": "com.amazonaws.forecast#Boolean", + "traits": { + "smithy.api#documentation": "

Create an Explainability resource for the predictor.

" + } }, "Tags": { "target": "com.amazonaws.forecast#Tags", @@ -590,7 +593,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The optional metadata that you apply to the dataset group to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
  • \n
" } } } @@ -686,7 +689,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The optional metadata that you apply to the dataset import job to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
  • \n
" } } } @@ -748,7 +751,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The optional metadata that you apply to the dataset to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
  • \n
" } } } @@ -790,7 +793,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)

\n
\n

Creates an Amazon Forecast Explainability.

\n

Explainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.

\n

To enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.

\n

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.

\n

\n CreateExplainability with a Predictor ARN\n

\n \n

You can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor in CreateAutoPredictor, that\n predictor already has an Explainability resource.

\n
\n

The following parameters are required when providing a Predictor ARN:

\n
    \n
  • \n

    \n ExplainabilityName - A unique name for the Explainability.

    \n
  • \n
  • \n

    \n ResourceArn - The Arn of the predictor.

    \n
  • \n
  • \n

    \n TimePointGranularity - Must be set to β€œALL”.

    \n
  • \n
  • \n

    \n TimeSeriesGranularity - Must be set to β€œALL”.

    \n
  • \n
\n

Do not specify a value for the following parameters:

\n
    \n
  • \n

    \n DataSource - Only valid when TimeSeriesGranularity is\n β€œSPECIFIC”.

    \n
  • \n
  • \n

    \n Schema - Only valid when TimeSeriesGranularity is\n β€œSPECIFIC”.

    \n
  • \n
  • \n

    \n StartDateTime - Only valid when TimePointGranularity is\n β€œSPECIFIC”.

    \n
  • \n
  • \n

    \n EndDateTime - Only valid when TimePointGranularity is\n β€œSPECIFIC”.

    \n
  • \n
\n

\n CreateExplainability with a Forecast ARN\n

\n \n

You can specify a maximum of 50 time series and 1500 time points.

\n
\n

The following parameters are required when providing a Predictor ARN:

\n
    \n
  • \n

    \n ExplainabilityName - A unique name for the Explainability.

    \n
  • \n
  • \n

    \n ResourceArn - The Arn of the forecast.

    \n
  • \n
  • \n

    \n TimePointGranularity - Either β€œALL” or β€œSPECIFIC”.

    \n
  • \n
  • \n

    \n TimeSeriesGranularity - Either β€œALL” or β€œSPECIFIC”.

    \n
  • \n
\n

If you set TimeSeriesGranularity to β€œSPECIFIC”, you must also provide the\n following:

\n
    \n
  • \n

    \n DataSource - The S3 location of the CSV file specifying your time\n series.

    \n
  • \n
  • \n

    \n Schema - The Schema defines the attributes and attribute types\n listed in the Data Source.

    \n
  • \n
\n

If you set TimePointGranularity to β€œSPECIFIC”, you must also provide the\n following:

\n
    \n
  • \n

    \n StartDateTime - The first timestamp in the range of time\n points.

    \n
  • \n
  • \n

    \n EndDateTime - The last timestamp in the range of time\n points.

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

Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)

\n
\n

Creates an Amazon Forecast Explainability.

\n

Explainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.

\n

To enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.

\n

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.

\n

\n CreateExplainability with a Predictor ARN\n

\n \n

You can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor in CreateAutoPredictor, that\n predictor already has an Explainability resource.

\n
\n

The following parameters are required when providing a Predictor ARN:

\n
    \n
  • \n

    \n ExplainabilityName - A unique name for the Explainability.

    \n
  • \n
  • \n

    \n ResourceArn - The Arn of the predictor.

    \n
  • \n
  • \n

    \n TimePointGranularity - Must be set to β€œALL”.

    \n
  • \n
  • \n

    \n TimeSeriesGranularity - Must be set to β€œALL”.

    \n
  • \n
\n

Do not specify a value for the following parameters:

\n
    \n
  • \n

    \n DataSource - Only valid when TimeSeriesGranularity is\n β€œSPECIFIC”.

    \n
  • \n
  • \n

    \n Schema - Only valid when TimeSeriesGranularity is\n β€œSPECIFIC”.

    \n
  • \n
  • \n

    \n StartDateTime - Only valid when TimePointGranularity is\n β€œSPECIFIC”.

    \n
  • \n
  • \n

    \n EndDateTime - Only valid when TimePointGranularity is\n β€œSPECIFIC”.

    \n
  • \n
\n

\n CreateExplainability with a Forecast ARN\n

\n \n

You can specify a maximum of 50 time series and 500 time points.

\n
\n

The following parameters are required when providing a Predictor ARN:

\n
    \n
  • \n

    \n ExplainabilityName - A unique name for the Explainability.

    \n
  • \n
  • \n

    \n ResourceArn - The Arn of the forecast.

    \n
  • \n
  • \n

    \n TimePointGranularity - Either β€œALL” or β€œSPECIFIC”.

    \n
  • \n
  • \n

    \n TimeSeriesGranularity - Either β€œALL” or β€œSPECIFIC”.

    \n
  • \n
\n

If you set TimeSeriesGranularity to β€œSPECIFIC”, you must also provide the\n following:

\n
    \n
  • \n

    \n DataSource - The S3 location of the CSV file specifying your time\n series.

    \n
  • \n
  • \n

    \n Schema - The Schema defines the attributes and attribute types\n listed in the Data Source.

    \n
  • \n
\n

If you set TimePointGranularity to β€œSPECIFIC”, you must also provide the\n following:

\n
    \n
  • \n

    \n StartDateTime - The first timestamp in the range of time\n points.

    \n
  • \n
  • \n

    \n EndDateTime - The last timestamp in the range of time\n points.

    \n
  • \n
" } }, "com.amazonaws.forecast#CreateExplainabilityExport": { @@ -903,13 +906,13 @@ "StartDateTime": { "target": "com.amazonaws.forecast#LocalDateTime", "traits": { - "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the first\n point for the Explainability.

" + "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the first\n point for the Explainability.

\n

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

" } }, "EndDateTime": { "target": "com.amazonaws.forecast#LocalDateTime", "traits": { - "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the last\n time point for the Explainability.

" + "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the last\n time point for the Explainability.

\n

Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

" } }, "Tags": { @@ -1016,7 +1019,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The optional metadata that you apply to the forecast export job to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
  • \n
" } } } @@ -1058,7 +1061,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The optional metadata that you apply to the forecast to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
  • \n
" } } } @@ -1100,7 +1103,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This operation creates a legacy predictor that does not include all the predictor\n functionalities provided by Amazon Forecast. To create a predictor that is compatible with all\n aspects of Forecast, use CreateAutoPredictor.

\n
\n

Creates an Amazon Forecast predictor.

\n

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast\n choose an algorithm for you using AutoML. If you specify an algorithm, you also can override\n algorithm-specific hyperparameters.

\n

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets\n in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

\n

To see the evaluation metrics, use the GetAccuracyMetrics operation.

\n

You can specify a featurization configuration to fill and aggregate the data fields in the\n TARGET_TIME_SERIES dataset to improve model training. For more information, see\n FeaturizationConfig.

\n

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the\n DataFrequency specified when the dataset was created matches the\n ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction.\n Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

\n

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9\n (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by\n setting the ForecastTypes.

\n

\n AutoML\n

\n

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the\n objective function, set PerformAutoML to true. The\n objective function is defined as the mean of the weighted losses over the\n forecast types. By default, these are the p10, p50, and p90 quantile losses. For more\n information, see EvaluationResult.

\n

When AutoML is enabled, the following properties are disallowed:

\n
    \n
  • \n

    \n AlgorithmArn\n

    \n
  • \n
  • \n

    \n HPOConfig\n

    \n
  • \n
  • \n

    \n PerformHPO\n

    \n
  • \n
  • \n

    \n TrainingParameters\n

    \n
  • \n
\n\n \n\n

To get a list of all of your predictors, use the ListPredictors\n operation.

\n \n

Before you can use the predictor to create a forecast, the Status of the\n predictor must be ACTIVE, signifying that training has completed. To get the\n status, use the DescribePredictor operation.

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

This operation creates a legacy predictor that does not include all the predictor\n functionalities provided by Amazon Forecast. To create a predictor that is compatible with all\n aspects of Forecast, use CreateAutoPredictor.

\n
\n

Creates an Amazon Forecast predictor.

\n

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast\n choose an algorithm for you using AutoML. If you specify an algorithm, you also can override\n algorithm-specific hyperparameters.

\n

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets\n in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

\n

To see the evaluation metrics, use the GetAccuracyMetrics operation.

\n

You can specify a featurization configuration to fill and aggregate the data fields in the\n TARGET_TIME_SERIES dataset to improve model training. For more information, see\n FeaturizationConfig.

\n

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the\n DataFrequency specified when the dataset was created matches the\n ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction.\n Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

\n

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9\n (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by\n setting the ForecastTypes.

\n

\n AutoML\n

\n

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the\n objective function, set PerformAutoML to true. The\n objective function is defined as the mean of the weighted losses over the\n forecast types. By default, these are the p10, p50, and p90 quantile losses. For more\n information, see EvaluationResult.

\n

When AutoML is enabled, the following properties are disallowed:

\n
    \n
  • \n

    \n AlgorithmArn\n

    \n
  • \n
  • \n

    \n HPOConfig\n

    \n
  • \n
  • \n

    \n PerformHPO\n

    \n
  • \n
  • \n

    \n TrainingParameters\n

    \n
  • \n
\n\n \n\n

To get a list of all of your predictors, use the ListPredictors\n operation.

\n \n

Before you can use the predictor to create a forecast, the Status of the\n predictor must be ACTIVE, signifying that training has completed. To get the\n status, use the DescribePredictor operation.

\n
" } }, "com.amazonaws.forecast#CreatePredictorBacktestExportJob": { @@ -1129,7 +1132,7 @@ } ], "traits": { - "smithy.api#documentation": "

Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported\n to your specified S3 bucket.

\n

The export file names will match the following conventions:

\n

\n __.csv\n

\n

The component is in Java SimpleDate format\n (yyyy-MM-ddTHH-mm-ssZ).

\n

You must specify a DataDestination object that includes an Amazon S3\n bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket. For more information, see aws-forecast-iam-roles.

\n \n

The Status of the export job must be ACTIVE before\n you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

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

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two\n folders containing CSV files are exported to your specified S3 bucket.

\n

The export file names will match the following conventions:

\n

\n __.csv\n

\n

The component is in Java SimpleDate format\n (yyyy-MM-ddTHH-mm-ssZ).

\n

You must specify a DataDestination object that includes an Amazon S3\n bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket. For more information, see aws-forecast-iam-roles.

\n \n

The Status of the export job must be ACTIVE before you\n can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

\n
" } }, "com.amazonaws.forecast#CreatePredictorBacktestExportJobRequest": { @@ -1158,7 +1161,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

Optional metadata to help you categorize and organize your backtests. Each tag consists\n of a key and an optional value, both of which you define. Tag keys and values are case\n sensitive.

\n

The following restrictions apply to tags:

\n
    \n
  • \n

    For each resource, each tag key must be unique and each tag key must have one\n value.

    \n
  • \n
  • \n

    Maximum number of tags per resource: 50.

    \n
  • \n
  • \n

    Maximum key length: 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length: 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Accepted characters: all letters and numbers, spaces representable in UTF-8, and +\n - = . _ : / @. If your tagging schema is used across other services and resources,\n the character restrictions of those services also apply.

    \n
  • \n
  • \n

    Key prefixes cannot include any upper or lowercase combination of\n aws: or AWS:. Values can have this prefix. If a tag\n value has aws as its prefix but the key does not, Forecast considers it\n to be a user tag and will count against the limit of 50 tags. Tags with only the key\n prefix of aws do not count against your tags per resource limit. You\n cannot edit or delete tag keys with this prefix.

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

Optional metadata to help you categorize and organize your backtests. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.

\n

The following restrictions apply to tags:

\n
    \n
  • \n

    For each resource, each tag key must be unique and each tag key must have one\n value.

    \n
  • \n
  • \n

    Maximum number of tags per resource: 50.

    \n
  • \n
  • \n

    Maximum key length: 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length: 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Accepted characters: all letters and numbers, spaces representable in UTF-8,\n and + - = . _ : / @. If your tagging schema is used across other services and\n resources, the character restrictions of those services also apply.

    \n
  • \n
  • \n

    Key prefixes cannot include any upper or lowercase combination of\n aws: or AWS:. Values can have this prefix. If a\n tag value has aws as its prefix but the key does not, Forecast\n considers it to be a user tag and will count against the limit of 50 tags. Tags\n with only the key prefix of aws do not count against your tags per\n resource limit. You cannot edit or delete tag keys with this prefix.

    \n
  • \n
" } } } @@ -1262,7 +1265,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "

The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The optional metadata that you apply to the predictor to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
  • \n
" } }, "OptimizationMetric": { @@ -1332,13 +1335,13 @@ "S3Config": { "target": "com.amazonaws.forecast#S3Config", "traits": { - "smithy.api#documentation": "

The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the\n credentials to access the data.

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

The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the\n credentials to access the data.

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

The source of your training data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to\n access the data and, optionally, an AWS Key Management Service (KMS) key. This object is submitted in the\n CreateDatasetImportJob request.

" + "smithy.api#documentation": "

The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to\n access the data and, optionally, an AWS Key Management Service (KMS) key.

" } }, "com.amazonaws.forecast#DatasetGroupSummary": { @@ -1641,7 +1644,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Explainability export job.

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

Deletes an Explainability export.

", "smithy.api#idempotent": {} } }, @@ -1752,7 +1755,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a predictor created using the CreatePredictor operation. You can\n delete only predictor that have a status of ACTIVE or CREATE_FAILED.\n To get the status, use the DescribePredictor operation.

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

Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can delete only predictor that have a status of\n ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.

", "smithy.api#idempotent": {} } }, @@ -1900,6 +1903,12 @@ "smithy.api#documentation": "

The frequency of predictions in a forecast.

\n

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30\n minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).\n For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.

" } }, + "ForecastDimensions": { + "target": "com.amazonaws.forecast#ForecastDimensions", + "traits": { + "smithy.api#documentation": "

An array of dimension (field) names that specify the attributes used to group your time series.

" + } + }, "DatasetImportJobArns": { "target": "com.amazonaws.forecast#ArnList", "traits": { @@ -1958,7 +1967,10 @@ } }, "ExplainabilityInfo": { - "target": "com.amazonaws.forecast#ExplainabilityInfo" + "target": "com.amazonaws.forecast#ExplainabilityInfo", + "traits": { + "smithy.api#documentation": "

Provides the status and ARN of the Predictor Explainability.

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

This operation is only valid for legacy predictors created with CreatePredictor. If you\n are not using a legacy predictor, use DescribeAutoPredictor.

\n

To upgrade a legacy predictor to AutoPredictor, see Upgrading to AutoPredictor.

\n
\n

Describes a predictor created using the CreatePredictor\n operation.

\n

In addition to listing the properties provided in the CreatePredictor\n request, this operation lists the following properties:

\n
    \n
  • \n

    \n DatasetImportJobArns - The dataset import jobs used to import training\n data.

    \n
  • \n
  • \n

    \n AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were\n evaluated.

    \n
  • \n
  • \n

    \n CreationTime\n

    \n
  • \n
  • \n

    \n LastModificationTime\n

    \n
  • \n
  • \n

    \n Status\n

    \n
  • \n
  • \n

    \n Message - If an error occurred, information about the error.

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

This operation is only valid for legacy predictors created with CreatePredictor. If you\n are not using a legacy predictor, use DescribeAutoPredictor.

\n
\n

Describes a predictor created using the CreatePredictor\n operation.

\n

In addition to listing the properties provided in the CreatePredictor\n request, this operation lists the following properties:

\n
    \n
  • \n

    \n DatasetImportJobArns - The dataset import jobs used to import training\n data.

    \n
  • \n
  • \n

    \n AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were\n evaluated.

    \n
  • \n
  • \n

    \n CreationTime\n

    \n
  • \n
  • \n

    \n LastModificationTime\n

    \n
  • \n
  • \n

    \n Status\n

    \n
  • \n
  • \n

    \n Message - If an error occurred, information about the error.

    \n
  • \n
", "smithy.api#idempotent": {} } }, @@ -2689,7 +2701,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

\n

In addition to listing the properties provided by the user in the\n CreatePredictorBacktestExportJob request, this operation lists the\n following properties:

\n
    \n
  • \n

    \n CreationTime\n

    \n
  • \n
  • \n

    \n LastModificationTime\n

    \n
  • \n
  • \n

    \n Status\n

    \n
  • \n
  • \n

    \n Message (if an error occurred)

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

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

\n

In addition to listing the properties provided by the user in the\n CreatePredictorBacktestExportJob request, this operation lists the\n following properties:

\n
    \n
  • \n

    \n CreationTime\n

    \n
  • \n
  • \n

    \n LastModificationTime\n

    \n
  • \n
  • \n

    \n Status\n

    \n
  • \n
  • \n

    \n Message (if an error occurred)

    \n
  • \n
", "smithy.api#idempotent": {} } }, @@ -2738,7 +2750,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the predictor backtest export job. States include:

\n
    \n
  • \n

    \n ACTIVE\n

    \n
  • \n
  • \n

    \n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n

    \n
  • \n
  • \n

    \n CREATE_STOPPING, CREATE_STOPPED\n

    \n
  • \n
  • \n

    \n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n

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

The status of the predictor backtest export job. States include:

\n
    \n
  • \n

    \n ACTIVE\n

    \n
  • \n
  • \n

    \n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n

    \n
  • \n
  • \n

    \n CREATE_STOPPING, CREATE_STOPPED\n

    \n
  • \n
  • \n

    \n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n

    \n
  • \n
" } }, "CreationTime": { @@ -2750,7 +2762,7 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
  • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
  • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
  • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
  • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

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

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
  • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
  • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
  • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
  • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

    \n
  • \n
" } } } @@ -3166,11 +3178,20 @@ "type": "structure", "members": { "ExplainabilityArn": { - "target": "com.amazonaws.forecast#Arn" + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability.

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

The status of the Explainability. States include:

\n
    \n
  • \n

    \n ACTIVE\n

    \n
  • \n
  • \n

    \n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n

    \n
  • \n
  • \n

    \n CREATE_STOPPING, CREATE_STOPPED\n

    \n
  • \n
  • \n

    \n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n

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

Provides information about the Explainability resource.

" } }, "com.amazonaws.forecast#ExplainabilitySummary": { @@ -3235,7 +3256,7 @@ "AttributeName": { "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of \n the TARGET_TIME_SERIES and the RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target is\n demand, and for the CUSTOM domain, the target is\n target_value.\n For more information, see howitworks-missing-values.

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

The name of the schema attribute that specifies the data field to be featurized. Amazon\n Forecast supports the target field of the TARGET_TIME_SERIES and the\n RELATED_TIME_SERIES datasets. For example, for the RETAIL domain,\n the target is demand, and for the CUSTOM domain, the target is\n target_value. For more information, see howitworks-missing-values.

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

Provides featurization (transformation) information for a dataset field. This object\n is part of the FeaturizationConfig object.

\n

For example:

\n

\n {\n

\n

\n \"AttributeName\": \"demand\",\n

\n

\n FeaturizationPipeline [ {\n

\n \n

\n \"FeaturizationMethodName\": \"filling\",\n

\n

\n \"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}\n

\n

\n } ]\n

\n

\n }\n

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

This object belongs to the CreatePredictor operation. If you created\n your predictor with CreateAutoPredictor, see AttributeConfig.

\n
\n

Provides featurization (transformation) information for a dataset field. This object is\n part of the FeaturizationConfig object.

\n

For example:

\n

\n {\n

\n

\n \"AttributeName\": \"demand\",\n

\n

\n FeaturizationPipeline [ {\n

\n \n

\n \"FeaturizationMethodName\": \"filling\",\n

\n

\n \"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\":\n \"nan\"}\n

\n

\n } ]\n

\n

\n }\n

" } }, "com.amazonaws.forecast#FeaturizationConfig": { @@ -3256,14 +3277,14 @@ "ForecastFrequency": { "target": "com.amazonaws.forecast#Frequency", "traits": { - "smithy.api#documentation": "

The frequency of predictions in a forecast.

\n

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).\n For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.

\n

The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset\n frequency.

\n

When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the\n RELATED_TIME_SERIES dataset frequency.

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

The frequency of predictions in a forecast.

\n

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"Y\" indicates every year and \"5min\" indicates every five minutes.

\n

The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset\n frequency.

\n

When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the\n RELATED_TIME_SERIES dataset frequency.

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

An array of dimension (field) names that specify how to group the generated forecast.

\n

For example, suppose that you are generating a forecast for item sales across all of\n your stores, and your dataset contains a store_id field. If you want the sales\n forecast for each item by store, you would specify store_id as the dimension.

\n

All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't\n need to be specified in the CreatePredictor request.\n All forecast dimensions specified in the RELATED_TIME_SERIES dataset must\n be specified in the CreatePredictor request.

" + "smithy.api#documentation": "

An array of dimension (field) names that specify how to group the generated\n forecast.

\n

For example, suppose that you are generating a forecast for item sales across all of your\n stores, and your dataset contains a store_id field. If you want the sales\n forecast for each item by store, you would specify store_id as the\n dimension.

\n

All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't\n need to be specified in the CreatePredictor request. All forecast dimensions\n specified in the RELATED_TIME_SERIES dataset must be specified in the\n CreatePredictor request.

" } }, "Featurizations": { @@ -3274,7 +3295,7 @@ } }, "traits": { - "smithy.api#documentation": "

In a CreatePredictor operation, the specified algorithm\n trains a model using the specified dataset group. You can optionally tell the operation\n to modify data fields prior to training a model. These modifications are referred to as\n featurization.

\n

You define featurization using the FeaturizationConfig object.\n You specify an array of transformations, one for each field that you want to\n featurize. You then include the FeaturizationConfig object in your\n CreatePredictor request. Amazon Forecast applies the featurization to the\n TARGET_TIME_SERIES and RELATED_TIME_SERIES datasets before model training.

\n

You can create multiple featurization configurations. For example, you\n might call the CreatePredictor operation twice by specifying different\n featurization configurations.

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

This object belongs to the CreatePredictor operation. If you created\n your predictor with CreateAutoPredictor, see AttributeConfig.

\n
\n

In a CreatePredictor operation, the specified algorithm trains a model\n using the specified dataset group. You can optionally tell the operation to modify data fields\n prior to training a model. These modifications are referred to as\n featurization.

\n

You define featurization using the FeaturizationConfig object. You specify an\n array of transformations, one for each field that you want to featurize. You then include the\n FeaturizationConfig object in your CreatePredictor request.\n Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and\n RELATED_TIME_SERIES datasets before model training.

\n

You can create multiple featurization configurations. For example, you might call the\n CreatePredictor operation twice by specifying different featurization\n configurations.

" } }, "com.amazonaws.forecast#FeaturizationMethod": { @@ -3290,12 +3311,12 @@ "FeaturizationMethodParameters": { "target": "com.amazonaws.forecast#FeaturizationMethodParameters", "traits": { - "smithy.api#documentation": "

The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. \n Related Time Series attributes do not accept aggregation parameters.

\n

The following list shows the parameters and their valid values for the \"filling\" featurization method for a Target Time Series dataset. Bold signifies the default\n value.

\n
    \n
  • \n

    \n aggregation: sum, avg, first, min, max\n

    \n
  • \n
  • \n

    \n frontfill: none\n

    \n
  • \n
  • \n

    \n middlefill: zero, nan (not a number), value, median, mean, min, max\n

    \n
  • \n
  • \n

    \n backfill: zero, nan, value, median, mean, min, max\n

    \n
  • \n
\n\n

The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

\n
    \n
  • \n

    \n middlefill: zero, value, median, mean, min, max\n

    \n
  • \n
  • \n

    \n backfill: zero, value, median, mean, min, max\n

    \n
  • \n
  • \n

    \n futurefill: zero, value, median, mean, min, max\n

    \n
  • \n
\n

To set a filling method to a specific value, set the fill parameter to value\n and define the value in a corresponding _value parameter. For example, to set\n backfilling to a value of 2, include the following: \"backfill\": \"value\" and\n \"backfill_value\":\"2\".

" + "smithy.api#documentation": "

The method parameters (key-value pairs), which are a map of override parameters. Specify\n these parameters to override the default values. Related Time Series attributes do not accept\n aggregation parameters.

\n

The following list shows the parameters and their valid values for the \"filling\"\n featurization method for a Target Time Series dataset. Bold\n signifies the default value.

\n
    \n
  • \n

    \n aggregation: sum, avg,\n first, min, max\n

    \n
  • \n
  • \n

    \n frontfill: none\n

    \n
  • \n
  • \n

    \n middlefill: zero, nan (not\n a number), value, median, mean, min,\n max\n

    \n
  • \n
  • \n

    \n backfill: zero, nan,\n value, median, mean, min,\n max\n

    \n
  • \n
\n\n

The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

\n
    \n
  • \n

    \n middlefill: zero, value, median,\n mean, min, max\n

    \n
  • \n
  • \n

    \n backfill: zero, value, median,\n mean, min, max\n

    \n
  • \n
  • \n

    \n futurefill: zero, value, median,\n mean, min, max\n

    \n
  • \n
\n

To set a filling method to a specific value, set the fill parameter to value\n and define the value in a corresponding _value parameter. For example, to set\n backfilling to a value of 2, include the following: \"backfill\": \"value\" and\n \"backfill_value\":\"2\".

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

Provides information about the method that featurizes (transforms) a dataset field.\n The method is part of the FeaturizationPipeline of the\n Featurization object.

\n

The following is an example of how you specify a FeaturizationMethod object.

\n

\n {\n

\n

\n \"FeaturizationMethodName\": \"filling\",\n

\n

\n \"FeaturizationMethodParameters\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\": \"zero\"}\n

\n

\n }\n

" + "smithy.api#documentation": "

Provides information about the method that featurizes (transforms) a dataset field. The\n method is part of the FeaturizationPipeline of the Featurization object.

\n

The following is an example of how you specify a FeaturizationMethod\n object.

\n

\n {\n

\n

\n \"FeaturizationMethodName\": \"filling\",\n

\n

\n \"FeaturizationMethodParameters\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\",\n \"backfill\": \"zero\"}\n

\n

\n }\n

" } }, "com.amazonaws.forecast#FeaturizationMethodName": { @@ -3497,7 +3518,10 @@ } }, "CreatedUsingAutoPredictor": { - "target": "com.amazonaws.forecast#Boolean" + "target": "com.amazonaws.forecast#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the Forecast was created from an AutoPredictor.

" + } }, "DatasetGroupArn": { "target": "com.amazonaws.forecast#String", @@ -3679,7 +3703,7 @@ } }, "traits": { - "smithy.api#documentation": "

The data used to train a predictor. The data includes a dataset group and any\n supplementary features. You specify this object in the CreatePredictor\n request.

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

This object belongs to the CreatePredictor operation. If you created\n your predictor with CreateAutoPredictor, see DataConfig.

\n
\n

The data used to train a predictor. The data includes a dataset group and any\n supplementary features. You specify this object in the CreatePredictor\n request.

" } }, "com.amazonaws.forecast#Integer": { @@ -4006,7 +4030,7 @@ "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n
    \n
  • \n

    \n Condition - The condition to apply. Valid values are\n IS and IS_NOT.

    \n
  • \n
  • \n

    \n Key - The name of the parameter to filter on. Valid values are\n PredictorArn and Status.

    \n
  • \n
  • \n

    \n Value - The value to match.

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

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n
    \n
  • \n

    \n Condition - The condition to apply. Valid values are\n IS and IS_NOT.

    \n
  • \n
  • \n

    \n Key - The name of the parameter to filter on. Valid values are\n ResourceArn and Status.

    \n
  • \n
  • \n

    \n Value - The value to match.

    \n
  • \n
" } } } @@ -4067,7 +4091,7 @@ "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude resources that match the statement from the list. The match statement\n consists of a key and a value.

\n

\n Filter properties\n

\n
    \n
  • \n

    \n Condition - The condition to apply. Valid values are\n IS and IS_NOT.

    \n
  • \n
  • \n

    \n Key - The name of the parameter to filter on. Valid values are\n PredictorArn and Status.

    \n
  • \n
  • \n

    \n Value - The value to match.

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

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude resources that match the statement from the list. The match statement\n consists of a key and a value.

\n

\n Filter properties\n

\n
    \n
  • \n

    \n Condition - The condition to apply. Valid values are\n IS and IS_NOT.

    \n
  • \n
  • \n

    \n Key - The name of the parameter to filter on. Valid values are\n ResourceArn and Status.

    \n
  • \n
  • \n

    \n Value - The value to match.

    \n
  • \n
" } } } @@ -4240,7 +4264,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary\n for each backtest export job. You can filter the list using an array of Filter objects.

\n

To retrieve the complete set of properties for a particular backtest export job, use the\n ARN with the DescribePredictorBacktestExportJob operation.

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

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a\n summary for each backtest export job. You can filter the list using an array of Filter objects.

\n

To retrieve the complete set of properties for a particular backtest export job, use\n the ARN with the DescribePredictorBacktestExportJob operation.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -4256,7 +4280,7 @@ "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { - "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a NextToken.\n To retrieve the next set of results, use the token in the next request. Tokens expire after\n 24 hours.

" + "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next request.\n Tokens expire after 24 hours.

" } }, "MaxResults": { @@ -4268,7 +4292,7 @@ "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the predictor backtest export jobs that match the statement from the\n list. The match statement consists of a key and a value.

\n

\n Filter properties\n

\n
    \n
  • \n

    \n Condition - The condition to apply. Valid values are\n IS and IS_NOT. To include the predictor backtest\n export jobs that match the statement, specify IS. To exclude matching\n predictor backtest export jobs, specify IS_NOT.

    \n
  • \n
  • \n

    \n Key - The name of the parameter to filter on. Valid values are\n PredictorArn and Status.

    \n
  • \n
  • \n

    \n Value - The value to match.

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

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the predictor backtest export jobs that match the statement from the\n list. The match statement consists of a key and a value.

\n

\n Filter properties\n

\n
    \n
  • \n

    \n Condition - The condition to apply. Valid values are\n IS and IS_NOT. To include the predictor backtest\n export jobs that match the statement, specify IS. To exclude\n matching predictor backtest export jobs, specify IS_NOT.

    \n
  • \n
  • \n

    \n Key - The name of the parameter to filter on. Valid values are\n PredictorArn and Status.

    \n
  • \n
  • \n

    \n Value - The value to match.

    \n
  • \n
" } } } @@ -4285,7 +4309,7 @@ "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { - "smithy.api#documentation": "

Returns this token if the response is truncated. To retrieve the next\n set of results, use the token in the next request.

" + "smithy.api#documentation": "

Returns this token if the response is truncated. To retrieve the next set of results,\n use the token in the next request.

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

Returns a list of predictors created using the CreatePredictor\n operation. For each predictor, this operation returns a summary of its properties, including\n its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the\n ARN with the DescribePredictor operation. You can filter the list using an\n array of Filter objects.

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

Returns a list of predictors created using the CreateAutoPredictor or\n CreatePredictor operations. For each predictor, this operation returns a\n summary of its properties, including its Amazon Resource Name (ARN).

\n

You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You\n can filter the list using an array of Filter objects.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -4383,7 +4407,7 @@ "ResourceArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.

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

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.\n

", "smithy.api#required": {} } } @@ -4578,7 +4602,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the predictor backtest export job. States include:

\n
    \n
  • \n

    \n ACTIVE\n

    \n
  • \n
  • \n

    \n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n

    \n
  • \n
  • \n

    \n CREATE_STOPPING, CREATE_STOPPED\n

    \n
  • \n
  • \n

    \n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n

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

The status of the predictor backtest export job. States include:

\n
    \n
  • \n

    \n ACTIVE\n

    \n
  • \n
  • \n

    \n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n

    \n
  • \n
  • \n

    \n CREATE_STOPPING, CREATE_STOPPED\n

    \n
  • \n
  • \n

    \n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n

    \n
  • \n
" } }, "Message": { @@ -4596,12 +4620,12 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
  • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
  • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
  • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
  • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

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

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
  • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
  • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
  • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
  • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

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

Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of properties, call\n the DescribePredictorBacktestExportJob operation, and provide the listed\n PredictorBacktestExportJobArn.

" + "smithy.api#documentation": "

Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of\n properties, call the DescribePredictorBacktestExportJob operation, and\n provide the listed PredictorBacktestExportJobArn.

" } }, "com.amazonaws.forecast#PredictorBacktestExportJobs": { @@ -4861,7 +4885,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the fields of a dataset. You specify this object in the CreateDataset request.

" + "smithy.api#documentation": "

Defines the fields of a dataset.

" } }, "com.amazonaws.forecast#SchemaAttribute": { @@ -5017,7 +5041,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a resource.

\n

The resource undergoes the following states:\n CREATE_STOPPING and CREATE_STOPPED. You cannot resume\n a resource once it has been stopped.

\n

This operation can be applied to the following resources (and their corresponding child\n resources):

\n
    \n
  • \n

    Dataset Import Job

    \n
  • \n
  • \n

    Predictor Job

    \n
  • \n
  • \n

    Forecast Job

    \n
  • \n
  • \n

    Forecast Export Job

    \n
  • \n
  • \n

    Predictor Backtest Export Job

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

Stops a resource.

\n

The resource undergoes the following states: CREATE_STOPPING and\n CREATE_STOPPED. You cannot resume a resource once it has been\n stopped.

\n

This operation can be applied to the following resources (and their corresponding child\n resources):

\n
    \n
  • \n

    Dataset Import Job

    \n
  • \n
  • \n

    Predictor Job

    \n
  • \n
  • \n

    Forecast Job

    \n
  • \n
  • \n

    Forecast Export Job

    \n
  • \n
  • \n

    Predictor Backtest Export Job

    \n
  • \n
  • \n

    Explainability Job

    \n
  • \n
  • \n

    Explainability Export Job

    \n
  • \n
", "smithy.api#idempotent": {} } }, @@ -5027,7 +5051,7 @@ "ResourceArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs\n are DatasetImportJobArn, PredictorArn,\n PredictorBacktestExportJobArn, ForecastArn, and\n ForecastExportJobArn.

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

The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs\n are DatasetImportJobArn, PredictorArn,\n PredictorBacktestExportJobArn, ForecastArn,\n ForecastExportJobArn, ExplainabilityArn, and\n ExplainabilityExportArn.

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

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in\n featurizations.

\n

\n Weather Index\n

\n

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and\n projected weather information into your model. The Weather Index supplements your datasets\n with over two years of historical weather data and up to 14 days of projected weather data.\n For more information, see Amazon Forecast Weather\n Index.

\n

\n Holidays\n

\n

Holidays is a built-in featurization that incorporates a feature-engineered dataset of\n national holiday information into your model. It provides native support for the holiday\n calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays Featurization.

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

This object belongs to the CreatePredictor operation. If you created\n your predictor with CreateAutoPredictor, see AdditionalDataset.

\n
\n

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in\n featurizations.

\n

\n Weather Index\n

\n

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and\n projected weather information into your model. The Weather Index supplements your datasets\n with over two years of historical weather data and up to 14 days of projected weather data.\n For more information, see Amazon Forecast Weather\n Index.

\n

\n Holidays\n

\n

Holidays is a built-in featurization that incorporates a feature-engineered dataset of\n national holiday information into your model. It provides native support for the holiday\n calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays Featurization.

" } }, "com.amazonaws.forecast#SupplementaryFeatures": { @@ -5083,20 +5107,20 @@ "Key": { "target": "com.amazonaws.forecast#TagKey", "traits": { - "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

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

One part of a key-value pair that makes up a tag. A key is a general label\n that acts like a category for more specific tag values.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.forecast#TagValue", "traits": { - "smithy.api#documentation": "

The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

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

The optional part of a key-value pair that makes up a tag. A value acts as a\n descriptor within a tag category (key).

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

The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The optional metadata that you apply to a resource to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
  • \n
" } }, "com.amazonaws.forecast#TagKey": { @@ -5142,7 +5166,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

" + "smithy.api#documentation": "

Associates the specified tags to a resource with the specified resourceArn.\n If existing tags on a resource are not specified in the request parameters, they are not\n changed. When a resource is deleted, the tags associated with that resource are also\n deleted.

" } }, "com.amazonaws.forecast#TagResourceRequest": { @@ -5151,14 +5175,14 @@ "ResourceArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.

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

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.\n

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

The tags to add to the resource. A tag is an array of key-value pairs.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

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

The tags to add to the resource. A tag is an array of key-value pairs.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
  • \n
", "smithy.api#required": {} } } @@ -5344,7 +5368,7 @@ "ResourceArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast exports.

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

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.\n

", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/glue.json b/aws/sdk/aws-models/glue.json index 43d31192a0..b0089974c2 100644 --- a/aws/sdk/aws-models/glue.json +++ b/aws/sdk/aws-models/glue.json @@ -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": "

A list of the tables to be synchronized.

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

The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.

" + } } }, "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": "

The name of the SecurityConfiguration structure to be used by this\n crawler.

" } + }, + "LakeFormationConfiguration": { + "target": "com.amazonaws.glue#LakeFormationConfiguration" } }, "traits": { @@ -3821,6 +3882,12 @@ "traits": { "smithy.api#documentation": "

Specifies Glue Data Catalog targets.

" } + }, + "DeltaTargets": { + "target": "com.amazonaws.glue#DeltaTargetList", + "traits": { + "smithy.api#documentation": "

Specifies Delta data store targets.

" + } } }, "traits": { @@ -4109,6 +4176,9 @@ "smithy.api#documentation": "

Specifies data lineage configuration settings for the crawler.

" } }, + "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": "

A list of the Amazon S3 paths to the Delta tables.

" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#ConnectionName", + "traits": { + "smithy.api#documentation": "

The name of the connection to use to connect to the Delta table target.

" + } + }, + "WriteManifest": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to write the manifest files to the Delta table path.

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

Specifies a Delta data store to crawl one or more Delta tables.

" + } + }, + "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": "

Specifies configuration properties for a labeling set generation task run.

" } }, + "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": "

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.

" } }, + "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": "

Specifies data lineage configuration settings for the crawler.

" } }, + "LakeFormationConfiguration": { + "target": "com.amazonaws.glue#LakeFormationConfiguration" + }, "Configuration": { "target": "com.amazonaws.glue#CrawlerConfiguration", "traits": { diff --git a/aws/sdk/aws-models/greengrassv2.json b/aws/sdk/aws-models/greengrassv2.json index 8b7b51a59f..4305dcc48d 100644 --- a/aws/sdk/aws-models/greengrassv2.json +++ b/aws/sdk/aws-models/greengrassv2.json @@ -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": "

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 AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that\n defines equivalent permissions for the IoT Greengrass features that you use. For more information, see\n Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

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

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.

", + "smithy.api#jsonName": "RoleArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#AssociateServiceRoleToAccountResponse": { + "type": "structure", + "members": { + "associatedAt": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.

", + "smithy.api#jsonName": "AssociatedAt" + } + } + } + }, "com.amazonaws.greengrassv2#AssociatedClientDevice": { "type": "structure", "members": { @@ -168,7 +218,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 Configure cloud\n discovery in the IoT Greengrass V2 Developer Guide.

\n \n \n

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 Interact with\n local IoT devices in the IoT Greengrass V2 Developer Guide.

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

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 Configure cloud\n discovery in the IoT Greengrass V2 Developer Guide.

\n \n \n

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 Interact with\n local IoT devices in the IoT Greengrass V2 Developer Guide.

\n
", "smithy.api#http": { "method": "POST", "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/associateClientDevices", @@ -232,7 +282,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

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

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.

", "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": "

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.

" + "smithy.api#documentation": "

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.

" } } } @@ -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": "

An ID for the connectivity information.

", + "smithy.api#jsonName": "Id" + } + }, + "hostAddress": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The IP address or DNS address where client devices can connect to an MQTT broker on the\n Greengrass core device.

", + "smithy.api#jsonName": "HostAddress" + } + }, + "portNumber": { + "target": "com.amazonaws.greengrassv2#PortNumberInt", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#jsonName": "PortNumber" + } + }, + "metadata": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

Additional metadata to provide to client devices that connect to this core device.

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

Contains information about an endpoint and port where client devices can connect to an\n MQTT broker on a Greengrass core device.

" + } + }, "com.amazonaws.greengrassv2#CoreDevice": { "type": "structure", "members": { @@ -815,7 +901,7 @@ "status": { "target": "com.amazonaws.greengrassv2#CoreDeviceStatus", "traits": { - "smithy.api#documentation": "

The status of the core device. Core devices can have the following statuses:

\n
    \n
  • \n

    \n HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

    \n
  • \n
  • \n

    \n UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state\n on the core device.

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

The status of the core device. Core devices can have the following\n statuses:

\n
    \n
  • \n

    \n HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

    \n
  • \n
  • \n

    \n UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state\n on the core device.

    \n
  • \n
" } }, "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": "

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 Greengrass service role in\n the IoT Greengrass Version 2 Developer Guide.

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

The time when the service role was disassociated from IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.

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

Retrieves connectivity information for a Greengrass core device.

\n

Connectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the Greengrass discovery API,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see Connect client devices to\n core devices in the IoT Greengrass Version 2 Developer Guide.

", + "smithy.api#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": "

The name of the core device. This is also the name of the IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#GetConnectivityInfoResponse": { + "type": "structure", + "members": { + "connectivityInfo": { + "target": "com.amazonaws.greengrassv2#connectivityInfoList", + "traits": { + "smithy.api#documentation": "

The connectivity information for the core device.

", + "smithy.api#jsonName": "ConnectivityInfo" + } + }, + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

A message about the connectivity information request.

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

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 Greengrass service role in\n the IoT Greengrass Version 2 Developer Guide.

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

The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.

", + "smithy.api#jsonName": "AssociatedAt" + } + }, + "roleArn": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

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.

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

Updates connectivity information for a Greengrass core device.

\n

Connectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the Greengrass discovery API,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see Connect client devices to\n core devices in the IoT Greengrass Version 2 Developer Guide.

", + "smithy.api#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": "

The name of the core device. This is also the name of the IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "ThingName", + "smithy.api#required": {} + } + }, + "connectivityInfo": { + "target": "com.amazonaws.greengrassv2#connectivityInfoList", + "traits": { + "smithy.api#documentation": "

The connectivity information for the core device.

", + "smithy.api#jsonName": "ConnectivityInfo", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#UpdateConnectivityInfoResponse": { + "type": "structure", + "members": { + "version": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

The new version of the connectivity information for the core device.

", + "smithy.api#jsonName": "Version" + } + }, + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "

A message about the connectivity information update request.

", + "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" + } } } } diff --git a/aws/sdk/aws-models/health.json b/aws/sdk/aws-models/health.json index 19416997dc..2afabe8f38 100644 --- a/aws/sdk/aws-models/health.json +++ b/aws/sdk/aws-models/health.json @@ -43,7 +43,7 @@ "name": "health" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Health\n \n

The Health API provides programmatic access to the Health information that\n appears in the Personal Health Dashboard. You\n can use the API operations to get information about events that might affect your Amazon Web Services\n services and resources.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan from Amazon Web Services Support 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 SubscriptionRequiredException error.

    \n
  • \n
  • \n

    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 Accessing the Health API in the\n Health User Guide.

    \n
  • \n
\n
\n

For authentication of requests, Health uses the Signature Version 4 Signing\n Process.

\n

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 Aggregating\n Health events in the Health User Guide.

\n \n

When you use the Health API operations to return Health events, see the\n following recommendations:

\n
    \n
  • \n

    Use the eventScopeCode parameter to specify whether to return Health\n events that are public or account-specific.

    \n
  • \n
  • \n

    Use pagination to view all events from the response. For example, if you call\n the DescribeEventsForOrganization operation to get all events in your\n organization, you might receive several page results. Specify the\n nextToken in the next request to return more results.

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

The Health API provides programmatic access to the Health information that\n appears in the Personal Health Dashboard. You\n can use the API operations to get information about events that might affect your Amazon Web Services services and resources.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support 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 SubscriptionRequiredException error.

    \n
  • \n
  • \n

    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 Accessing the Health API in the\n Health User Guide.

    \n
  • \n
\n
\n

For authentication of requests, Health uses the Signature Version 4 Signing\n Process.

\n

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 Aggregating\n Health events in the Health User Guide.

\n \n

When you use the Health API operations to return Health events, see the\n following recommendations:

\n
    \n
  • \n

    Use the eventScopeCode parameter to specify whether to return Health\n events that are public or account-specific.

    \n
  • \n
  • \n

    Use pagination to view all events from the response. For example, if you call\n the DescribeEventsForOrganization operation to get all events in your\n organization, you might receive several page results. Specify the\n nextToken in the next request to return more results.

    \n
  • \n
\n
", "smithy.api#title": "AWS Health APIs and Notifications" }, "version": "2016-08-04", @@ -265,7 +265,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

At least one event ARN is required.

\n \n \n
    \n
  • \n

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    \n
  • \n
  • \n

    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 Resource- and action-based conditions in the Health User Guide.

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

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.

\n

At least one event ARN is required.

\n\n \n
    \n
  • \n

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    \n
  • \n
  • \n

    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 Resource- and action-based conditions in the Health User Guide.

    \n
  • \n
\n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -292,7 +292,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

At least one event Amazon Resource Name (ARN) and account ID are required.

\n

Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's management account.

\n \n
    \n
  • \n

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    \n
  • \n
  • \n

    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 Resource- and action-based conditions in the Health User Guide.

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

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.

\n

At least one event Amazon Resource Name (ARN) and account ID are required.

\n

Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n \n
    \n
  • \n

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    \n
  • \n
  • \n

    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 Resource- and action-based conditions in the Health User Guide.

    \n
  • \n
\n\n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -552,7 +552,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 DescribeAffectedEntitiesForOrganization operation.

\n \n

Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n
\n

When you call the DescribeEventDetailsForOrganization operation, specify\n the organizationEventDetailFilters object in the request. Depending on the\n Health event type, note the following differences:

\n
    \n
  • \n

    To return event details for a public event, you must specify a null value for the\n awsAccountId 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.

    \n
  • \n
  • \n

    To return event details for an event that is specific to an account in your\n organization, you must specify the awsAccountId 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.

    \n
  • \n
\n

For more information, see Event.

\n\n \n

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 Resource- and action-based conditions in the Health User Guide.

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

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 DescribeAffectedEntitiesForOrganization operation.

\n \n

Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n
\n

When you call the DescribeEventDetailsForOrganization operation, specify\n the organizationEventDetailFilters object in the request. Depending on the\n Health event type, note the following differences:

\n
    \n
  • \n

    To return event details for a public event, you must specify a null value for the\n awsAccountId 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.

    \n
  • \n
  • \n

    To return event details for an event that is specific to an account in your\n organization, you must specify the awsAccountId 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.

    \n
  • \n
\n

For more information, see Event.

\n\n \n

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 Resource- and action-based conditions in the Health User Guide.

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

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 EventType object.

\n

If you don't specify a filter criteria, the API operation returns all event types, in no\n particular order.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

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

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 EventType object.

\n

If you don't specify a filter criteria, the API operation returns all event types, in no\n particular order.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -879,7 +879,7 @@ "healthServiceAccessStatusForOrganization": { "target": "com.amazonaws.health#healthServiceAccessStatusForOrganization", "traits": { - "smithy.api#documentation": "

Information about the status of enabling or disabling the Health organizational\n view feature in\n your organization.

\n

Valid values are ENABLED | DISABLED | PENDING.

" + "smithy.api#documentation": "

Information about the status of enabling or disabling the Health organizational\n view feature in your organization.

\n

Valid values are ENABLED | DISABLED | PENDING.

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

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 Aggregating\n Health events in the\n Health User Guide.

\n

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 Deleting a Service-Linked Role in the\n IAM User Guide.

\n \n

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess 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.

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

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 Aggregating\n Health events in the Health User Guide.

\n

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 Deleting a Service-Linked Role in the\n IAM User Guide.

\n \n

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess 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.

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

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.

\n

This operation also creates a service-linked role for the management account in the\n organization.

\n \n

To call this operation, you must meet the following requirements:

\n
    \n
  • \n

    You must have a Business or Enterprise Support plan from Amazon Web Services Support 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 SubscriptionRequiredException error.

    \n
  • \n
  • \n

    You must have permission to call this operation from the organization's\n management account. For example IAM policies, see Health\n identity-based policy examples.

    \n
  • \n
\n
\n

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 Aggregating\n Health events in the Health User Guide.

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

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.

\n

This operation also creates a service-linked role for the management account in the\n organization.

\n \n

To call this operation, you must meet the following requirements:

\n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support 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 SubscriptionRequiredException error.

    \n
  • \n
  • \n

    You must have permission to call this operation from the organization's\n management account. For example IAM policies, see Health\n identity-based policy examples.

    \n
  • \n
\n
\n

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 Aggregating\n Health events in the Health User Guide.

", "smithy.api#idempotent": {} } }, @@ -976,7 +976,7 @@ } }, "traits": { - "smithy.api#documentation": "

The values to use to filter results from the DescribeAffectedEntities\n operation.

" + "smithy.api#documentation": "

The values to use to filter results from the DescribeAffectedEntities operation.

" } }, "com.amazonaws.health#EntityList": { @@ -1056,7 +1056,7 @@ } }, "traits": { - "smithy.api#documentation": "

Summary information about an Health event.

\n

Health events can be public or account-specific:

\n
    \n
  • \n

    \n Public events 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.

    \n
  • \n
  • \n

    \n Account-specific 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.

    \n
  • \n
\n

You can determine if an event is public or account-specific by using the\n eventScopeCode parameter. For more information, see eventScopeCode.

" + "smithy.api#documentation": "

Summary information about an Health event.

\n

Health events can be public or account-specific:

\n
    \n
  • \n

    \n Public events 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.

    \n
  • \n
  • \n

    \n Account-specific 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.

    \n
  • \n
\n

You can determine if an event is public or account-specific by using the\n eventScopeCode parameter. For more information, see eventScopeCode.

" } }, "com.amazonaws.health#EventAccountFilter": { @@ -1557,7 +1557,7 @@ "errorMessage": { "target": "com.amazonaws.health#string", "traits": { - "smithy.api#documentation": "

A message that describes the error.

\n

If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:

\n
    \n
  • \n

    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.

    \n
  • \n
  • \n

    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.

    \n
  • \n
  • \n

    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.

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

A message that describes the error.

\n

If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:

\n
    \n
  • \n

    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.

    \n
  • \n
  • \n

    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.

    \n
  • \n
  • \n

    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.

    \n
  • \n
" } } }, diff --git a/aws/sdk/aws-models/imagebuilder.json b/aws/sdk/aws-models/imagebuilder.json index f6285fd1f3..1eee9f9140 100644 --- a/aws/sdk/aws-models/imagebuilder.json +++ b/aws/sdk/aws-models/imagebuilder.json @@ -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": "

The idempotency token used to make this request idempotent.

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

Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -262,7 +281,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "

The idempotency token used to make this request idempotent.

" + "smithy.api#documentation": "

The idempotency token that was used for this request.

" } }, "imageBuildVersionArn": { @@ -2018,7 +2037,7 @@ "snsTopicArn": { "target": "com.amazonaws.imagebuilder#SnsTopicArn", "traits": { - "smithy.api#documentation": "

The SNS topic on which to send image build events.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

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

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.

\n\t\t
" } }, "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": "

A group of launchTemplateConfiguration settings that apply to image distribution \n\t\t\tfor specified accounts.

" } + }, + "s3ExportConfiguration": { + "target": "com.amazonaws.imagebuilder#S3ExportConfiguration", + "traits": { + "smithy.api#documentation": "

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.

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

The tags of the image.

" } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:

\n\t\t
    \n
  • \n\t\t\t\t

    \n USER_INITIATED – A manual \n\t\t\t\t\tpipeline build request.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    \n SCHEDULED – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    \n IMPORT – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.

    \n\t\t\t
  • \n
" + } } }, "traits": { @@ -4285,6 +4335,12 @@ "traits": { "smithy.api#documentation": "

The tags of the image.

" } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:

\n\t\t
    \n
  • \n\t\t\t\t

    \n USER_INITIATED – A manual \n\t\t\t\t\tpipeline build request.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    \n SCHEDULED – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    \n IMPORT – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.

    \n\t\t\t
  • \n
" + } } }, "traits": { @@ -4303,7 +4359,7 @@ "imageTestsEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "

Defines if tests should be executed when building this image.

" + "smithy.api#documentation": "

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.

" } }, "timeoutMinutes": { @@ -4314,7 +4370,7 @@ } }, "traits": { - "smithy.api#documentation": "

Image tests configuration.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes": { @@ -4392,6 +4448,12 @@ "traits": { "smithy.api#documentation": "

The date on which this specific version of the Image Builder image was created.

" } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "

Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:

\n\t\t
    \n
  • \n\t\t\t\t

    \n USER_INITIATED – A manual \n\t\t\t\t\tpipeline build request.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    \n SCHEDULED – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    \n IMPORT – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.

    \n\t\t\t
  • \n
" + } } }, "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": "

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\tImportImage \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 import-image\n\t\t

\n\t\t

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.

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

The name of the base image that is created by the import process.

", + "smithy.api#required": {} + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "

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.

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

The semantic version has four nodes: ../. \n\tYou can assign values for the first three, and can filter on all of them.

\n\t\t\t

\n Assignment: 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.

\n\t\t\t

\n Patterns: 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.

\n\t\t
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description for the base image that is created by the import process.

" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "

The operating system platform for the imported VM.

", + "smithy.api#required": {} + } + }, + "osVersion": { + "target": "com.amazonaws.imagebuilder#OsVersion", + "traits": { + "smithy.api#documentation": "

The operating system version for the imported VM.

" + } + }, + "vmImportTaskId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The importTaskId (API) or ImportTaskId (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.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.imagebuilder#TagMap", + "traits": { + "smithy.api#documentation": "

Tags that are attached to the import resources.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.imagebuilder#ImportVmImageResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The request ID that uniquely identifies this request.

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

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.

" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token that was used for this request.

" + } + } + } + }, "com.amazonaws.imagebuilder#InfrastructureConfiguration": { "type": "structure", "members": { @@ -4638,7 +4810,7 @@ "snsTopicArn": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

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

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.

\n\t\t
" } }, "dateCreated": { @@ -6759,19 +6931,54 @@ } } }, + "com.amazonaws.imagebuilder#S3ExportConfiguration": { + "type": "structure", + "members": { + "roleName": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the role that grants VM Import/Export permission to \n\t\t\texport images to your S3 bucket.

", + "smithy.api#required": {} + } + }, + "diskImageFormat": { + "target": "com.amazonaws.imagebuilder#DiskImageFormat", + "traits": { + "smithy.api#documentation": "

Export the updated image to one of the following supported disk \n\t\t\timage formats:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Virtual Hard Disk (VHD) – \n\t\t\t\t\tCompatible with Citrix Xen and Microsoft Hyper-V virtualization products.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    \n Stream-optimized ESX Virtual Machine Disk \n\t\t\t\t\t(VMDK) – Compatible with VMware ESX and \n\t\t\t\t\tVMware vSphere versions 4, 5, and 6.

    \n\t\t\t
  • \n
  • \n\t\t\t\t

    \n Raw – Raw format.

    \n\t\t\t
  • \n
", + "smithy.api#required": {} + } + }, + "s3Bucket": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The S3 bucket in which to store the output disk images for your VM.

", + "smithy.api#required": {} + } + }, + "s3Prefix": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon S3 path for the bucket where the output disk images for your VM are stored.

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

Properties that configure export from your build instance \n\t\t\tto a compatible file format for your VM.

" + } + }, "com.amazonaws.imagebuilder#S3Logs": { "type": "structure", "members": { "s3BucketName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket in which to store the logs.

" + "smithy.api#documentation": "

The S3 bucket in which to store the logs.

" } }, "s3KeyPrefix": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon S3 path in which to store the logs.

" + "smithy.api#documentation": "

The Amazon S3 path to the bucket where the logs are stored.

" } } }, @@ -7496,7 +7703,7 @@ "snsTopicArn": { "target": "com.amazonaws.imagebuilder#SnsTopicArn", "traits": { - "smithy.api#documentation": "

The SNS topic on which to send image build events.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

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

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.

\n\t\t
" } }, "clientToken": { @@ -7663,6 +7870,9 @@ { "target": "com.amazonaws.imagebuilder#ImportComponent" }, + { + "target": "com.amazonaws.imagebuilder#ImportVmImage" + }, { "target": "com.amazonaws.imagebuilder#ListComponentBuildVersions" }, diff --git a/aws/sdk/aws-models/iot.json b/aws/sdk/aws-models/iot.json index 2141166c1b..561e153b39 100644 --- a/aws/sdk/aws-models/iot.json +++ b/aws/sdk/aws-models/iot.json @@ -2827,6 +2827,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether IoT validates the token signature in an authorization request.

" } + }, + "enableCachingForHttp": { + "target": "com.amazonaws.iot#EnableCachingForHttp", + "traits": { + "smithy.api#documentation": "

When true, the result from the authorizer’s Lambda function is\n\t cached for the time specified in refreshAfterInSeconds. The cached\n\t result is used while the device reuses the same HTTP connection.

" + } } }, "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": "

Specifies whether IoT validates the token signature in an authorization request.

" } + }, + "enableCachingForHttp": { + "target": "com.amazonaws.iot#EnableCachingForHttp", + "traits": { + "smithy.api#documentation": "

When true, 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 refreshAfterInSeconds. This value\n does not affect authorization of clients that use MQTT connections.

\n

The default value is false.

" + } } } }, @@ -5801,7 +5817,7 @@ "abortConfig": { "target": "com.amazonaws.iot#AbortConfig", "traits": { - "smithy.api#documentation": "

Allows you to create criteria to abort a job.

" + "smithy.api#documentation": "

Allows you to create the criteria to abort a job.

" } }, "timeoutConfig": { @@ -5828,6 +5844,12 @@ "smithy.api#documentation": "

The ARN of the job template used to create the job.

" } }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "

Allows you to create the criteria to retry a job.

" + } + }, "documentParameters": { "target": "com.amazonaws.iot#ParameterMap", "traits": { @@ -5949,6 +5971,12 @@ "traits": { "smithy.api#documentation": "

Metadata that can be used to manage the job template.

" } + }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "

Allows you to create the criteria to retry a job.

" + } } } }, @@ -11130,6 +11158,12 @@ }, "timeoutConfig": { "target": "com.amazonaws.iot#TimeoutConfig" + }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "

The configuration that determines how many retries are allowed for each failure type\n for a job.

" + } } } }, @@ -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": "

The ARN of the job template used to create the job.

" } }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "

The configuration for the criteria to retry the job.

" + } + }, "documentParameters": { "target": "com.amazonaws.iot#ParameterMap", "traits": { @@ -16079,6 +16130,12 @@ "traits": { "smithy.api#documentation": "

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.

" } + }, + "retryAttempt": { + "target": "com.amazonaws.iot#RetryAttempt", + "traits": { + "smithy.api#documentation": "

The number that indicates how many retry attempts have been completed for this \n job on this device.

" + } } }, "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": "

The list of criteria that determines how many retries are allowed for each failure\n type for a job.

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

The configuration that determines how many retries are allowed for each failure \n type for a job.

" + } + }, "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": "

The token to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } + }, + "jobId": { + "target": "com.amazonaws.iot#JobId", + "traits": { + "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

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

The type of job execution failures that can initiate a job retry.

", + "smithy.api#required": {} + } + }, + "numberOfRetries": { + "target": "com.amazonaws.iot#NumberOfRetries", + "traits": { + "smithy.api#documentation": "

The number of retries allowed for a failure type for the job.

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

The criteria that determines how many retries are allowed for each failure\n type for a job.

" + } + }, + "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": "

The status of the update authorizer request.

" } + }, + "enableCachingForHttp": { + "target": "com.amazonaws.iot#EnableCachingForHttp", + "traits": { + "smithy.api#documentation": "

When true, the result from the authorizer’s Lambda function is\n\t cached for the time specified in refreshAfterInSeconds. The cached\n\t result is used while the device reuses the same HTTP connection.

" + } } } }, @@ -29081,6 +29263,12 @@ "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

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.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
", "smithy.api#httpQuery": "namespaceId" } + }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "

Allows you to create the criteria to retry a job.

" + } } } }, @@ -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" diff --git a/aws/sdk/aws-models/lakeformation.json b/aws/sdk/aws-models/lakeformation.json index e1563a317b..20b8a32677 100644 --- a/aws/sdk/aws-models/lakeformation.json +++ b/aws/sdk/aws-models/lakeformation.json @@ -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": "

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.

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

A structure used to include auditing information on the privileged API.

" + } + }, + "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": "

A wildcard with exclusions.

" + "smithy.api#documentation": "

A wildcard with exclusions.

\n \n

You must specify either a ColumnNames list or the\n ColumnWildCard.

" } } }, @@ -977,7 +1026,7 @@ } }, "traits": { - "smithy.api#documentation": "

The AWS Lake Formation principal. Supported principals are IAM users or IAM roles.

" + "smithy.api#documentation": "

The Lake Formation principal. Supported principals are IAM users\n or IAM roles.

" } }, "com.amazonaws.lakeformation#DataLakePrincipalList": { @@ -1066,6 +1115,24 @@ "traits": { "smithy.api#documentation": "

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.

\n\t\n\t

You may want to specify this property when you are in a high-trust boundary, such as the same team or company.

" } + }, + "AllowExternalDataFiltering": { + "target": "com.amazonaws.lakeformation#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Whether to allow Amazon EMR clusters to access data managed by Lake Formation.

\n\t\n

If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.

\n\t\n

If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.

\n \n

For more information, see (Optional) Allow Data Filtering on Amazon EMR.

" + } + }, + "ExternalDataFilteringAllowList": { + "target": "com.amazonaws.lakeformation#DataLakePrincipalList", + "traits": { + "smithy.api#documentation": "

A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>

" + } + }, + "AuthorizedSessionTagValueList": { + "target": "com.amazonaws.lakeformation#AuthorizedSessionTagValueList", + "traits": { + "smithy.api#documentation": "

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.

" + } } }, "traits": { @@ -1615,6 +1682,9 @@ "smithy.api#documentation": "

Statistics related to the processing of a query statement.

" } }, + "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": "

This API is identical to GetTemporaryTableCredentials 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.

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

The ARN of the partitions' table.

", + "smithy.api#required": {} + } + }, + "Partition": { + "target": "com.amazonaws.lakeformation#PartitionValueList", + "traits": { + "smithy.api#documentation": "

A list of partition values identifying a single partition.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.lakeformation#PermissionList", + "traits": { + "smithy.api#documentation": "

Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).

" + } + }, + "DurationSeconds": { + "target": "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger", + "traits": { + "smithy.api#documentation": "

The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.

" + } + }, + "AuditContext": { + "target": "com.amazonaws.lakeformation#AuditContext", + "traits": { + "smithy.api#documentation": "

A structure representing context to access a resource (column names, query ID, etc).

" + } + }, + "SupportedPermissionTypes": { + "target": "com.amazonaws.lakeformation#PermissionTypeList", + "traits": { + "smithy.api#documentation": "

A list of supported permission types for the partition. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentialsResponse": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.lakeformation#AccessKeyIdString", + "traits": { + "smithy.api#documentation": "

The access key ID for the temporary credentials.

" + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.lakeformation#SecretAccessKeyString", + "traits": { + "smithy.api#documentation": "

The secret key for the temporary credentials.

" + } + }, + "SessionToken": { + "target": "com.amazonaws.lakeformation#SessionTokenString", + "traits": { + "smithy.api#documentation": "

The session token for the temporary credentials.

" + } + }, + "Expiration": { + "target": "com.amazonaws.lakeformation#ExpirationTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the temporary credentials expire.

" + } + } + } + }, + "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": "

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.

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

The ARN identifying a table in the Data Catalog for the temporary credentials request.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.lakeformation#PermissionList", + "traits": { + "smithy.api#documentation": "

Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).

" + } + }, + "DurationSeconds": { + "target": "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger", + "traits": { + "smithy.api#documentation": "

The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.

" + } + }, + "AuditContext": { + "target": "com.amazonaws.lakeformation#AuditContext", + "traits": { + "smithy.api#documentation": "

A structure representing context to access a resource (column names, query ID, etc).

" + } + }, + "SupportedPermissionTypes": { + "target": "com.amazonaws.lakeformation#PermissionTypeList", + "traits": { + "smithy.api#documentation": "

A list of supported permission types for the table. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentialsResponse": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.lakeformation#AccessKeyIdString", + "traits": { + "smithy.api#documentation": "

The access key ID for the temporary credentials.

" + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.lakeformation#SecretAccessKeyString", + "traits": { + "smithy.api#documentation": "

The secret key for the temporary credentials.

" + } + }, + "SessionToken": { + "target": "com.amazonaws.lakeformation#SessionTokenString", + "traits": { + "smithy.api#documentation": "

The session token for the temporary credentials.

" + } + }, + "Expiration": { + "target": "com.amazonaws.lakeformation#ExpirationTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the temporary credentials expire.

" + } + } + } + }, "com.amazonaws.lakeformation#GetWorkUnitResults": { "type": "operation", "input": { @@ -3421,6 +3704,21 @@ "smithy.api#documentation": "

A structure containing a list of partition values and table objects.

" } }, + "com.amazonaws.lakeformation#PartitionValueList": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.lakeformation#ValueStringList", + "traits": { + "smithy.api#documentation": "

The list of partition values.

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

Contains a list of values defining partitions.

" + } + }, "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": "

A message describing the problem.

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

The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission, but cell-level permissions exist on the table, this exception is thrown.

", + "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": { diff --git a/aws/sdk/aws-models/location.json b/aws/sdk/aws-models/location.json index a390969c25..67c1c0d959 100644 --- a/aws/sdk/aws-models/location.json +++ b/aws/sdk/aws-models/location.json @@ -328,8 +328,7 @@ } ], "traits": { - "smithy.api#auth": [], - "smithy.api#documentation": "

Evaluates device positions against the geofence geometries from a given geofence\n collection.

\n

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:

\n
    \n
  • \n

    \n ENTER if Amazon Location determines that the tracked device has entered\n a geofenced area.

    \n
  • \n
  • \n

    \n EXIT if Amazon Location determines that the tracked device has exited a\n geofenced area.

    \n
  • \n
\n \n

The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.

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

Evaluates device positions against the geofence geometries from a given geofence\n collection.

\n

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:

\n
    \n
  • \n

    \n ENTER if Amazon Location determines that the tracked device has entered\n a geofenced area.

    \n
  • \n
  • \n

    \n EXIT if Amazon Location determines that the tracked device has exited a\n geofenced area.

    \n
  • \n
\n \n

The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.

\n
\n \n

Geofence evaluation uses the given device position. It does not account for the \n optional Accuracy of a DevicePositionUpdate.

\n
", "smithy.api#endpoint": { "hostPrefix": "geofencing." }, @@ -771,7 +770,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n \n

Position updates are handled based on the PositionFiltering property of the tracker. \n When PositionFiltering is set to TimeBased, 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 PositionFiltering is set to DistanceBased 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).

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

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.

\n \n

Position updates are handled based on the PositionFiltering property of the tracker. \n When PositionFiltering is set to TimeBased, 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 PositionFiltering is set to DistanceBased 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).

\n

When PositionFiltering is set to AccuracyBased 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 PositionFiltering is set to AccuracyBased filtering, Amazon Location\n uses the default value { \"Horizontal\": 0} when accuracy is not provided on\n a DevicePositionUpdate.

\n
", "smithy.api#endpoint": { "hostPrefix": "tracking." }, @@ -1194,8 +1193,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "

Specifies the pricing plan for the geofence collection.

\n

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing\n page.

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

Optionally specifies the pricing plan for the geofence collection. Defaults to\n RequestBasedUsage.

\n

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing\n page.

" } }, "PricingPlanDataSource": { @@ -1308,8 +1306,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "

Specifies the pricing plan for your map resource.

\n

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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

Optionally specifies the pricing plan for the map resource. Defaults to\n RequestBasedUsage.

\n

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

" } }, "Description": { @@ -1378,7 +1375,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 SearchPlaceIndexForText operation,\n and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation.

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

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 SearchPlaceIndexForText operation,\n and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and\n enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -1410,8 +1407,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "

Specifies the pricing plan for your place index resource.

\n

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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

Optionally specifies the pricing plan for the place index resource. Defaults to\n RequestBasedUsage.

\n

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

" } }, "Description": { @@ -1518,8 +1514,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "

Specifies the pricing plan for your route calculator resource.

\n

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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

Optionally specifies the pricing plan for the route calculator resource. Defaults to\n RequestBasedUsage.

\n

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

" } }, "Description": { @@ -1613,8 +1608,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "

Specifies the pricing plan for the tracker resource.

\n

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

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

Optionally specifies the pricing plan for the tracker resource. Defaults to\n RequestBasedUsage.

\n

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

" } }, "KmsKeyId": { @@ -1644,7 +1638,7 @@ "PositionFiltering": { "target": "com.amazonaws.location#PositionFiltering", "traits": { - "smithy.api#documentation": "

Specifies the position filtering for the tracker resource.

\n

Valid values:

\n
    \n
  • \n

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

    \n
  • \n
  • \n

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

    \n
  • \n
\n

This field is optional. If not specified, the default value is TimeBased.

" + "smithy.api#documentation": "

Specifies the position filtering for the tracker resource.

\n

Valid values:

\n
    \n
  • \n

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

    \n
  • \n
  • \n

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

    \n
  • \n
  • \n

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

    \n
  • \n
\n

This field is optional. If not specified, the default value is TimeBased.

" } } } @@ -1990,7 +1984,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "

Retrieves the geofence collection details.

", "smithy.api#endpoint": { "hostPrefix": "geofencing." @@ -2107,7 +2100,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "

Retrieves the map resource details.

", "smithy.api#endpoint": { "hostPrefix": "maps." @@ -2226,7 +2218,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "

Retrieves the place index resource details.

", "smithy.api#endpoint": { "hostPrefix": "places." @@ -2345,7 +2336,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "

Retrieves the route calculator resource details.

", "smithy.api#endpoint": { "hostPrefix": "routes." @@ -2457,7 +2447,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "

Retrieves the tracker resource details.

", "smithy.api#endpoint": { "hostPrefix": "tracking." @@ -2589,6 +2578,18 @@ "smithy.api#documentation": "

The last known device position.

", "smithy.api#required": {} } + }, + "Accuracy": { + "target": "com.amazonaws.location#PositionalAccuracy", + "traits": { + "smithy.api#documentation": "

The accuracy of the device position.

" + } + }, + "PositionProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

The properties associated with the position.

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

The latest device position defined in WGS 84 format:\n [X or longitude, Y or latitude].

", "smithy.api#required": {} } + }, + "Accuracy": { + "target": "com.amazonaws.location#PositionalAccuracy", + "traits": { + "smithy.api#documentation": "

The accuracy of the device position.

" + } + }, + "PositionProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

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.

\n

Format: \"key\" : \"value\"\n

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

The last known device position.

", "smithy.api#required": {} } + }, + "Accuracy": { + "target": "com.amazonaws.location#PositionalAccuracy", + "traits": { + "smithy.api#documentation": "

The accuracy of the device position.

" + } + }, + "PositionProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

The properties associated with the position.

" + } } } }, @@ -3735,6 +3760,18 @@ "smithy.api#documentation": "

The last known device position. Empty if no positions currently stored.

", "smithy.api#required": {} } + }, + "Accuracy": { + "target": "com.amazonaws.location#PositionalAccuracy", + "traits": { + "smithy.api#documentation": "

The accuracy of the device position.

" + } + }, + "PositionProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

The properties associated with the position.

" + } } }, "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": "

Estimated maximum distance, in meters, between the measured position and the true\n position of a device, along the Earth's surface.

", + "smithy.api#range": { + "min": 0, + "max": 10000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the level of certainty of the position.

" + } + }, "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": "

The text of the place suggestion, typically formatted as an address string.

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

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

" + } + }, + "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": "

A summary of the request sent by using SearchPlaceIndexForPosition.

" } }, + "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": "

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.

\n

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.

\n \n

You can search for suggested place names near a specified position by using BiasPosition, or\n filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; \n using both BiasPosition and FilterBBox in the same command returns an error.

\n
", + "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": "

The name of the place index resource you want to use for the search.

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

The free-form partial text to use to generate place suggestions. For example,\n eiffel tow.

", + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#required": {}, + "smithy.api#sensitive": {} + } + }, + "BiasPosition": { + "target": "com.amazonaws.location#Position", + "traits": { + "smithy.api#documentation": "

An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

\n

\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.

\n

For example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and\n latitude 49.2847.

\n \n

\n BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.\n

\n
" + } + }, + "FilterBBox": { + "target": "com.amazonaws.location#BoundingBox", + "traits": { + "smithy.api#documentation": "

An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

\n

\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.

\n

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents\n a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, \n and the northeast corner has longitude -12.0684 and latitude -36.9542.

\n \n

\n FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.\n

\n
" + } + }, + "FilterCountries": { + "target": "com.amazonaws.location#CountryCodeList", + "traits": { + "smithy.api#documentation": "

An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

\n
    \n
  • \n

    Use the ISO 3166 3-digit\n country code. For example, Australia uses three upper-case characters:\n AUS.

    \n
  • \n
" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

The default: 5\n

", + "smithy.api#range": { + "min": 1, + "max": 15 + } + } + }, + "Language": { + "target": "com.amazonaws.location#LanguageTag", + "traits": { + "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

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.

\n

Used only when the partner selected is Here.

" + } + } + } + }, + "com.amazonaws.location#SearchPlaceIndexForSuggestionsResponse": { + "type": "structure", + "members": { + "Summary": { + "target": "com.amazonaws.location#SearchPlaceIndexForSuggestionsSummary", + "traits": { + "smithy.api#documentation": "

Contains a summary of the request. Echoes the input values for BiasPosition,\n FilterBBox, FilterCountries, Language, MaxResults,\n and Text. Also includes the DataSource of the place index.\n

", + "smithy.api#required": {} + } + }, + "Results": { + "target": "com.amazonaws.location#SearchForSuggestionsResultList", + "traits": { + "smithy.api#documentation": "

A list of place suggestions that best match the search text.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.location#SearchPlaceIndexForSuggestionsSummary": { + "type": "structure", + "members": { + "Text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The free-form partial text input specified in the request.

", + "smithy.api#required": {}, + "smithy.api#sensitive": {} + } + }, + "BiasPosition": { + "target": "com.amazonaws.location#Position", + "traits": { + "smithy.api#documentation": "

Contains the coordinates for the optional bias position specified in the request.

\n

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.

\n

For example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and latitude 49.2847.

" + } + }, + "FilterBBox": { + "target": "com.amazonaws.location#BoundingBox", + "traits": { + "smithy.api#documentation": "

Contains the coordinates for the optional bounding box specified in the request.

" + } + }, + "FilterCountries": { + "target": "com.amazonaws.location#CountryCodeList", + "traits": { + "smithy.api#documentation": "

Contains the optional country filter specified in the request.

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

Contains the optional result count limit specified in the request.

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

The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:

\n
    \n
  • \n

    Esri

    \n
  • \n
  • \n

    Here

    \n
  • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#required": {} + } + }, + "Language": { + "target": "com.amazonaws.location#LanguageTag", + "traits": { + "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.

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

A summary of the request sent by using SearchPlaceIndexForSuggestions.

" + } + }, "com.amazonaws.location#SearchPlaceIndexForText": { "type": "operation", "input": { @@ -5501,7 +5778,7 @@ "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

Contains the coordinates for the optional bias position specified in the request.

" + "smithy.api#documentation": "

Contains the coordinates for the optional bias position specified in the request.

\n

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.

\n

For example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and latitude 49.2847.

" } }, "FilterBBox": { @@ -6427,7 +6704,7 @@ "PositionFiltering": { "target": "com.amazonaws.location#PositionFiltering", "traits": { - "smithy.api#documentation": "

Updates the position filtering for the tracker resource.

\n

Valid values:

\n
    \n
  • \n

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

    \n
  • \n
  • \n

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

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

Updates the position filtering for the tracker resource.

\n

Valid values:

\n
    \n
  • \n

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

    \n
  • \n
  • \n

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

    \n
  • \n
  • \n

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

    \n
  • \n
" } } } diff --git a/aws/sdk/aws-models/logs.json b/aws/sdk/aws-models/logs.json index 7eac2d48c1..d29784bab3 100644 --- a/aws/sdk/aws-models/logs.json +++ b/aws/sdk/aws-models/logs.json @@ -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": "

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.

", "smithy.api#required": {} } + }, + "forceUpdate": { + "target": "com.amazonaws.cloudwatchlogs#ForceUpdate", + "traits": { + "smithy.api#documentation": "

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 true\n for forceUpdate, you are affirming that you have already updated the subscription \n filters.\n For more information, see \n Updating an existing cross-account subscription\n

\n

If you omit this parameter, the default of false is used.

" + } } } }, @@ -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": "

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.

\n

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 \"logArn\" with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.

\n

CloudWatch Logs also supports aws:SourceArn\n and aws:SourceAccount\ncondition context keys.

\n

In the example resource policy, you would replace the value of SourceArn with the resource making the\n call from Route 53 to CloudWatch Logs and replace the value of SourceAccount with \n the Amazon Web Services account ID making that call.

\n

\n

\n {\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}\n \n

" + "smithy.api#documentation": "

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.

\n

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 \"logArn\" with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.

\n

CloudWatch Logs also supports aws:SourceArn\n and aws:SourceAccount\ncondition context keys.

\n

In the example resource policy, you would replace the value of SourceArn with the resource making the\n call from RouteΒ 53 to CloudWatch Logs and replace the value of SourceAccount with \n the Amazon Web Services account ID making that call.

\n

\n

\n {\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}\n \n

" } } } diff --git a/aws/sdk/aws-models/lookoutmetrics.json b/aws/sdk/aws-models/lookoutmetrics.json index 34a4825b8b..44b7951dc1 100644 --- a/aws/sdk/aws-models/lookoutmetrics.json +++ b/aws/sdk/aws-models/lookoutmetrics.json @@ -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": "

The name of the measure.

" + } + }, + "AnomalyGroupId": { + "target": "com.amazonaws.lookoutmetrics#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the anomaly group.

" + } + }, + "RelationshipType": { + "target": "com.amazonaws.lookoutmetrics#RelationshipType", + "traits": { + "smithy.api#documentation": "

Whether a measure is a potential cause of the anomaly group\n (CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the\n anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP).

" + } + }, + "ContributionPercentage": { + "target": "com.amazonaws.lookoutmetrics#MetricChangePercentage", + "traits": { + "smithy.api#documentation": "

For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage\n contribution the measure has in causing the anomalies.

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

Aggregated details about the measures contributing to the anomaly group, and the measures\n potentially impacted by the anomaly group.

\n

" + } + }, + "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": "

Returns a list of measures that are potential causes or effects of an\n anomaly group.

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

The Amazon Resource Name (ARN) of the anomaly detector.

", + "smithy.api#required": {} + } + }, + "AnomalyGroupId": { + "target": "com.amazonaws.lookoutmetrics#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the anomaly group.

", + "smithy.api#required": {} + } + }, + "RelationshipTypeFilter": { + "target": "com.amazonaws.lookoutmetrics#RelationshipType", + "traits": { + "smithy.api#documentation": "

Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or\n downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.

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

The maximum number of results to return.

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

Specify the pagination token that's returned by a previous request to retrieve the next\n page of results.

" + } + } + } + }, + "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsResponse": { + "type": "structure", + "members": { + "InterMetricImpactList": { + "target": "com.amazonaws.lookoutmetrics#InterMetricImpactList", + "traits": { + "smithy.api#documentation": "

Aggregated details about the measures contributing to the anomaly group, and the measures\n potentially impacted by the anomaly group.

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

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

" + } + } + } + }, "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": "

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service\n with tutorials for getting started, visit Amazon\n Lookout for Metrics Developer Guide.

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

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service\n with tutorials for getting started, visit Amazon\n Lookout for Metrics Developer Guide.

", - "smithy.api#title": "Amazon Lookout for Metrics" - } + ] }, "com.amazonaws.lookoutmetrics#MaxResults": { "type": "integer", @@ -2908,6 +3043,16 @@ "smithy.api#documentation": "

A calculation made by contrasting a measure and a dimension from your source data.

" } }, + "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": "

Provides information about the Amazon Redshift database configuration.

" } }, + "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" }, diff --git a/aws/sdk/aws-models/lookoutvision.json b/aws/sdk/aws-models/lookoutvision.json index 563e754300..1a7529defe 100644 --- a/aws/sdk/aws-models/lookoutvision.json +++ b/aws/sdk/aws-models/lookoutvision.json @@ -52,7 +52,7 @@ "min": 1, "max": 10 }, - "smithy.api#pattern": "(normal|anomaly)" + "smithy.api#pattern": "^(normal|anomaly)$" } }, "com.amazonaws.lookoutvision#Boolean": { @@ -68,6 +68,52 @@ "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, + "com.amazonaws.lookoutvision#CompilerOptions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.lookoutvision#ComponentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_. ()':,;?]+$" + } + }, + "com.amazonaws.lookoutvision#ComponentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_.]+$" + } + }, + "com.amazonaws.lookoutvision#ComponentVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^([0-9]{1,6})\\.([0-9]{1,6})\\.([0-9]{1,6})$" + } + }, + "com.amazonaws.lookoutvision#ComponentVersionArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[^:]*:greengrass:[^:]*:aws:components:[^:]+$" + } + }, "com.amazonaws.lookoutvision#ConflictException": { "type": "structure", "members": { @@ -175,7 +221,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutvision#ClientToken", "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to CreateDataset\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from CreateDataset.\n In this case, safely retry your call\n to CreateDataset by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateDataset. An idempotency\n token is active for 8 hours.\n

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

ClientToken is an idempotency token that ensures a call to CreateDataset\n completes only once. You choose the value to pass. For example, An issue might prevent you\n from getting a response from CreateDataset.\n In this case, safely retry your call\n to CreateDataset by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple dataset creation requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateDataset. An idempotency\n token is active for 8 hours.\n

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -253,7 +299,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutvision#ClientToken", "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to CreateModel\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from CreateModel.\n In this case, safely retry your call\n to CreateModel by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateModel. An idempotency\n token is active for 8 hours.

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

ClientToken is an idempotency token that ensures a call to CreateModel\n completes only once. You choose the value to pass. For example, An issue\n might prevent you from getting a response from CreateModel.\n In this case, safely retry your call\n to CreateModel by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from starting multiple training jobs. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateModel. An idempotency\n token is active for 8 hours.

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -268,7 +314,7 @@ "KmsKeyId": { "target": "com.amazonaws.lookoutvision#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK).\n The key is used to encrypt training and test images copied into the service for model training. Your \n source images are unaffected.\n If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

" + "smithy.api#documentation": "

The identifier for your AWS KMS key.\n The key is used to encrypt training and test images copied into the service for model training. Your \n source images are unaffected.\n If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

" } }, "Tags": { @@ -343,7 +389,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutvision#ClientToken", "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to CreateProject\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from CreateProject.\n In this case, safely retry your call\n to CreateProject by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateProject. An idempotency\n token is active for 8 hours.

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

ClientToken is an idempotency token that ensures a call to CreateProject\n completes only once. You choose the value to pass. For example, An issue might prevent you from \n getting a response from CreateProject.\n In this case, safely retry your call\n to CreateProject by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple project creation requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateProject. An idempotency\n token is active for 8 hours.

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -412,7 +458,7 @@ "ImageStats": { "target": "com.amazonaws.lookoutvision#DatasetImageStats", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Statistics about the images in a dataset.

" } } }, @@ -511,7 +557,7 @@ } }, "traits": { - "smithy.api#documentation": "

Sumary information for an Amazon Lookout for Vision dataset.

" + "smithy.api#documentation": "

Summary information for an Amazon Lookout for Vision dataset. For more information,\n see DescribeDataset and ProjectDescription.

" } }, "com.amazonaws.lookoutvision#DatasetMetadataList": { @@ -591,7 +637,7 @@ "min": 1, "max": 10 }, - "smithy.api#pattern": "train|test" + "smithy.api#pattern": "^train|test$" } }, "com.amazonaws.lookoutvision#DateTime": { @@ -656,7 +702,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutvision#ClientToken", "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to DeleteDataset\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from DeleteDataset.\n In this case, safely retry your call\n to DeleteDataset by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteDataset. An idempotency\n token is active for 8 hours.

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

ClientToken is an idempotency token that ensures a call to DeleteDataset\n completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteDataset.\n In this case, safely retry your call\n to DeleteDataset by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple deletetion requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteDataset. An idempotency\n token is active for 8 hours.

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -696,7 +742,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model,\n use the StopModel operation.

\n

It might take a few seconds to delete a model. To determine if a model has been deleted, call\n ListProjects and check if the version of the model (ModelVersion) is in the\n Models array.

\n

This operation requires permissions to perform the\n lookoutvision:DeleteModel operation.

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

Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model,\n use the StopModel operation.

\n

It might take a few seconds to delete a model. To determine if a model has been deleted, call\n ListModels and check if the version of the model (ModelVersion) is in the\n Models array.

\n

\n

This operation requires permissions to perform the\n lookoutvision:DeleteModel operation.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-11-20/projects/{ProjectName}/models/{ModelVersion}", @@ -716,7 +762,7 @@ } }, "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", + "target": "com.amazonaws.lookoutvision#ModelVersionNoLatest", "traits": { "smithy.api#documentation": "

The version of the model that you want to delete.

", "smithy.api#httpLabel": {}, @@ -726,7 +772,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutvision#ClientToken", "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to DeleteModel\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from DeleteModel.\n In this case, safely retry your call\n to DeleteModel by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteModel. An idempotency\n token is active for 8 hours.

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

ClientToken is an idempotency token that ensures a call to DeleteModel\n completes only once. You choose the value to pass. For example, an issue might prevent\n you from getting a response from DeleteModel.\n In this case, safely retry your call\n to DeleteModel by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple model deletion requests. You'll need to\n provide your own value for other use cases.

\n \n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteModel. An idempotency\n token is active for 8 hours.

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -795,7 +841,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutvision#ClientToken", "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to DeleteProject\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from DeleteProject.\n In this case, safely retry your call\n to DeleteProject by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteProject. An idempotency\n token is active for 8 hours.

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

ClientToken is an idempotency token that ensures a call to DeleteProject\n completes only once. You choose the value to pass. For example, An issue\n might prevent you from getting a response from DeleteProject.\n In this case, safely retry your call\n to DeleteProject by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple project deletion requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteProject. An idempotency\n token is active for 8 hours.

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -919,6 +965,72 @@ } } }, + "com.amazonaws.lookoutvision#DescribeModelPackagingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutvision#DescribeModelPackagingJobRequest" + }, + "output": { + "target": "com.amazonaws.lookoutvision#DescribeModelPackagingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutvision#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutvision#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutvision#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutvision#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lookout for Vision model packaging job.\n

\n

This operation requires permissions to perform the\n lookoutvision:DescribeModelPackagingJob operation.

\n \n

For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-11-20/projects/{ProjectName}/modelpackagingjobs/{JobName}", + "code": 200 + } + } + }, + "com.amazonaws.lookoutvision#DescribeModelPackagingJobRequest": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.lookoutvision#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project that contains the model packaging job that you want to describe. \n

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

The job name for the model packaging job. \n\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lookoutvision#DescribeModelPackagingJobResponse": { + "type": "structure", + "members": { + "ModelPackagingDescription": { + "target": "com.amazonaws.lookoutvision#ModelPackagingDescription", + "traits": { + "smithy.api#documentation": "

The description of the model packaging job.\n

" + } + } + } + }, "com.amazonaws.lookoutvision#DescribeModelRequest": { "type": "structure", "members": { @@ -1132,6 +1244,91 @@ "smithy.api#box": {} } }, + "com.amazonaws.lookoutvision#GreengrassConfiguration": { + "type": "structure", + "members": { + "CompilerOptions": { + "target": "com.amazonaws.lookoutvision#CompilerOptions", + "traits": { + "smithy.api#documentation": "

Additional compiler options for the Greengrass component. Currently, \n only NVIDIA Graphics Processing Units (GPU) are supported.

\n \n \n

For more information, see \n Compiler options in the Amazon Lookout for Vision Developer Guide.

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

The target device for the model. Currently the only supported value is jetson_xavier.\n If you specify TargetDevice, you can't specify\n TargetPlatform.\n\n

" + } + }, + "TargetPlatform": { + "target": "com.amazonaws.lookoutvision#TargetPlatform", + "traits": { + "smithy.api#documentation": "

The target platform for the model. If you specify TargetPlatform, you can't specify\n TargetDevice.\n

" + } + }, + "S3OutputLocation": { + "target": "com.amazonaws.lookoutvision#S3Location", + "traits": { + "smithy.api#documentation": "

\n An S3 location in which Lookout for Vision stores the component artifacts. \n

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

\n A name for the AWS IoT Greengrass component. \n

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

A Version for the AWS IoT Greengrass component. If you don't provide a\n value, a default value of \n Model Version.0.0 is used.\n

" + } + }, + "ComponentDescription": { + "target": "com.amazonaws.lookoutvision#ComponentDescription", + "traits": { + "smithy.api#documentation": "

\n A description for the AWS IoT Greengrass component.\n

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

\n A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.\n

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

Configuration information for the AWS IoT Greengrass component created in a model packaging job. \n For more information, see StartModelPackagingJob.\n

\n \n

You can't specify a component with the same ComponentName and Componentversion as\n an existing component with the same component name and component version.

\n
" + } + }, + "com.amazonaws.lookoutvision#GreengrassOutputDetails": { + "type": "structure", + "members": { + "ComponentVersionArn": { + "target": "com.amazonaws.lookoutvision#ComponentVersionArn", + "traits": { + "smithy.api#documentation": "

\nThe Amazon Resource Name (ARN) of the component.\n

" + } + }, + "ComponentName": { + "target": "com.amazonaws.lookoutvision#ComponentName", + "traits": { + "smithy.api#documentation": "

\nThe name of the component.\n

" + } + }, + "ComponentVersion": { + "target": "com.amazonaws.lookoutvision#ComponentVersion", + "traits": { + "smithy.api#documentation": "

\nThe version of the component.\n

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

Information about the AWS IoT Greengrass component created by a model packaging job.\n\n

" + } + }, "com.amazonaws.lookoutvision#ImageSource": { "type": "structure", "members": { @@ -1149,7 +1346,7 @@ "com.amazonaws.lookoutvision#ImageSourceType": { "type": "string", "traits": { - "smithy.api#pattern": "direct" + "smithy.api#pattern": "^direct$" } }, "com.amazonaws.lookoutvision#InferenceUnits": { @@ -1363,6 +1560,89 @@ } } }, + "com.amazonaws.lookoutvision#ListModelPackagingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutvision#ListModelPackagingJobsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutvision#ListModelPackagingJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutvision#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutvision#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutvision#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutvision#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nLists the model packaging jobs created for an Amazon Lookout for Vision project.\n

\n

This operation requires permissions to perform the\n lookoutvision:ListModelPackagingJobs operation.\n

\n \n

For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-11-20/projects/{ProjectName}/modelpackagingjobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutvision#ListModelPackagingJobsRequest": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.lookoutvision#ProjectName", + "traits": { + "smithy.api#documentation": "

\nThe name of the project for which you want to list the model packaging jobs.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutvision#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutvision#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per paginated call. The largest value you can specify is 100. \n If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.lookoutvision#ListModelPackagingJobsResponse": { + "type": "structure", + "members": { + "ModelPackagingJobs": { + "target": "com.amazonaws.lookoutvision#ModelPackagingJobsList", + "traits": { + "smithy.api#documentation": "

\nA list of the model packaging jobs created for the specified Amazon Lookout for Vision project.\n

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

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results.\n

" + } + } + } + }, "com.amazonaws.lookoutvision#ListModels": { "type": "operation", "input": { @@ -1392,7 +1672,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the versions of a model in an Amazon Lookout for Vision project.

\n

This operation requires permissions to perform the\n lookoutvision:ListModels operation.

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

Lists the versions of a model in an Amazon Lookout for Vision project.

\n

The ListModels operation is eventually consistent. \n Recent calls to CreateModel might\n take a while to appear in the response from ListProjects.

\n

This operation requires permissions to perform the\n lookoutvision:ListModels operation.

", "smithy.api#http": { "method": "GET", "uri": "/2020-11-20/projects/{ProjectName}/models", @@ -1478,7 +1758,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon Lookout for Vision projects in your AWS account.

\n

This operation requires permissions to perform the\n lookoutvision:ListProjects operation.

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

Lists the Amazon Lookout for Vision projects in your AWS account.

\n

The ListProjects operation is eventually consistent. \n Recent calls to CreateProject and DeleteProject might\n take a while to appear in the response from ListProjects.

\n

This operation requires permissions to perform the\n lookoutvision:ListProjects operation.

", "smithy.api#http": { "method": "GET", "uri": "/2020-11-20/projects", @@ -1590,6 +1870,21 @@ }, "com.amazonaws.lookoutvision#LookoutVisionService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "LookoutVision", + "arnNamespace": "lookoutvision", + "cloudFormationName": "LookoutVision", + "cloudTrailEventSource": "lookoutvision.amazonaws.com", + "endpointPrefix": "lookoutvision" + }, + "aws.auth#sigv4": { + "name": "lookoutvision" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, \n data types, common parameters, and common errors.

\n

Amazon Lookout for Vision enables you to find visual defects in industrial products,\n accurately and at scale. It uses computer vision to identify missing components in an industrial product,\n damage to vehicles or structures, irregularities in production lines, and even minuscule defects in\n silicon wafers β€” or any other physical item where quality is important such as a missing capacitor\n on printed circuit boards.

", + "smithy.api#title": "Amazon Lookout for Vision" + }, "version": "2020-11-20", "operations": [ { @@ -1616,6 +1911,9 @@ { "target": "com.amazonaws.lookoutvision#DescribeModel" }, + { + "target": "com.amazonaws.lookoutvision#DescribeModelPackagingJob" + }, { "target": "com.amazonaws.lookoutvision#DescribeProject" }, @@ -1625,6 +1923,9 @@ { "target": "com.amazonaws.lookoutvision#ListDatasetEntries" }, + { + "target": "com.amazonaws.lookoutvision#ListModelPackagingJobs" + }, { "target": "com.amazonaws.lookoutvision#ListModels" }, @@ -1637,6 +1938,9 @@ { "target": "com.amazonaws.lookoutvision#StartModel" }, + { + "target": "com.amazonaws.lookoutvision#StartModelPackagingJob" + }, { "target": "com.amazonaws.lookoutvision#StopModel" }, @@ -1649,22 +1953,7 @@ { "target": "com.amazonaws.lookoutvision#UpdateDatasetEntries" } - ], - "traits": { - "aws.api#service": { - "sdkId": "LookoutVision", - "arnNamespace": "lookoutvision", - "cloudFormationName": "LookoutVision", - "cloudTrailEventSource": "lookoutvision.amazonaws.com", - "endpointPrefix": "lookoutvision" - }, - "aws.auth#sigv4": { - "name": "lookoutvision" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, \n data types, common parameters, and common errors.

\n

Amazon Lookout for Vision enables you to find visual defects in industrial products,\n accurately and at scale. It uses computer vision to identify missing components in an industrial product,\n damage to vehicles or structures, irregularities in production lines, and even minuscule defects in\n silicon wafers β€” or any other physical item where quality is important such as a missing capacitor\n on printed circuit boards.

", - "smithy.api#title": "Amazon Lookout for Vision" - } + ] }, "com.amazonaws.lookoutvision#ModelArn": { "type": "string" @@ -1756,7 +2045,7 @@ "min": 1, "max": 500 }, - "smithy.api#pattern": "[0-9A-Za-z\\.\\-_]*" + "smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*$" } }, "com.amazonaws.lookoutvision#ModelHostingStatus": { @@ -1842,18 +2131,245 @@ "target": "com.amazonaws.lookoutvision#ModelMetadata" } }, - "com.amazonaws.lookoutvision#ModelPerformance": { + "com.amazonaws.lookoutvision#ModelPackagingConfiguration": { "type": "structure", "members": { - "F1Score": { - "target": "com.amazonaws.lookoutvision#Float", + "Greengrass": { + "target": "com.amazonaws.lookoutvision#GreengrassConfiguration", "traits": { - "smithy.api#documentation": "

The overall F1 score metric for the trained model.

" + "smithy.api#documentation": "

\nConfiguration information for the AWS IoT Greengrass component in a model packaging job.\n

", + "smithy.api#required": {} } - }, - "Recall": { - "target": "com.amazonaws.lookoutvision#Float", - "traits": { + } + }, + "traits": { + "smithy.api#documentation": "

\nConfiguration information for a Amazon Lookout for Vision model packaging job. For more information,\nsee StartModelPackagingJob.\n

" + } + }, + "com.amazonaws.lookoutvision#ModelPackagingDescription": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.lookoutvision#ModelPackagingJobName", + "traits": { + "smithy.api#documentation": "

\nThe name of the model packaging job.\n

" + } + }, + "ProjectName": { + "target": "com.amazonaws.lookoutvision#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project that's associated with a model that's in the model package.\n\n

" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutvision#ModelVersion", + "traits": { + "smithy.api#documentation": "

The version of the model used in the model packaging job.\n\n

" + } + }, + "ModelPackagingConfiguration": { + "target": "com.amazonaws.lookoutvision#ModelPackagingConfiguration", + "traits": { + "smithy.api#documentation": "

\nThe configuration information used in the model packaging job.\n

" + } + }, + "ModelPackagingJobDescription": { + "target": "com.amazonaws.lookoutvision#ModelPackagingJobDescription", + "traits": { + "smithy.api#documentation": "

The description for the model packaging job.\n\n

" + } + }, + "ModelPackagingMethod": { + "target": "com.amazonaws.lookoutvision#ModelPackagingMethod", + "traits": { + "smithy.api#documentation": "

The AWS service used to package the job. Currently Lookout for Vision can package\njobs with AWS IoT Greengrass.\n

" + } + }, + "ModelPackagingOutputDetails": { + "target": "com.amazonaws.lookoutvision#ModelPackagingOutputDetails", + "traits": { + "smithy.api#documentation": "

Information about the output of the model packaging job. For more information,\n see DescribeModelPackagingJob.\n

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

\nThe status of the model packaging job.\n

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.lookoutvision#ModelPackagingStatusMessage", + "traits": { + "smithy.api#documentation": "

\nThe status message for the model packaging job.\n

" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.lookoutvision#DateTime", + "traits": { + "smithy.api#documentation": "

\n The Unix timestamp for the time and date that the model packaging job was created.\n

" + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.lookoutvision#DateTime", + "traits": { + "smithy.api#documentation": "

\n The Unix timestamp for the time and date that the model packaging job was last updated.\n

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

\nInformation about a model packaging job. For more information, see \nDescribeModelPackagingJob.\n

" + } + }, + "com.amazonaws.lookoutvision#ModelPackagingJobDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_. ()':,;?]+$" + } + }, + "com.amazonaws.lookoutvision#ModelPackagingJobMetadata": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.lookoutvision#ModelPackagingJobName", + "traits": { + "smithy.api#documentation": "

\nThe name of the model packaging job.\n

" + } + }, + "ProjectName": { + "target": "com.amazonaws.lookoutvision#ProjectName", + "traits": { + "smithy.api#documentation": "

\nThe project that contains the model that is in the model package.\n

" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutvision#ModelVersion", + "traits": { + "smithy.api#documentation": "

\nThe version of the model that is in the model package.\n

" + } + }, + "ModelPackagingJobDescription": { + "target": "com.amazonaws.lookoutvision#ModelPackagingJobDescription", + "traits": { + "smithy.api#documentation": "

\nThe description for the model packaging job.\n

" + } + }, + "ModelPackagingMethod": { + "target": "com.amazonaws.lookoutvision#ModelPackagingMethod", + "traits": { + "smithy.api#documentation": "

\nThe AWS service used to package the job. Currently Lookout for Vision can package\n jobs with AWS IoT Greengrass.\n

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

The status of the model packaging job.\n

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.lookoutvision#ModelPackagingStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message for the model packaging job.\n

" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.lookoutvision#DateTime", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for the time and date that the model packaging job was created.

" + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.lookoutvision#DateTime", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for the time and date that the model packaging job was last updated.

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

\n Metadata for a model packaging job. For more information, see ListModelPackagingJobs.\n

" + } + }, + "com.amazonaws.lookoutvision#ModelPackagingJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.lookoutvision#ModelPackagingJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.lookoutvision#ModelPackagingJobsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutvision#ModelPackagingJobMetadata" + } + }, + "com.amazonaws.lookoutvision#ModelPackagingMethod": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.lookoutvision#ModelPackagingOutputDetails": { + "type": "structure", + "members": { + "Greengrass": { + "target": "com.amazonaws.lookoutvision#GreengrassOutputDetails", + "traits": { + "smithy.api#documentation": "

\nInformation about the AWS IoT Greengrass component in a model packaging job.\n

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

\nInformation about the output from a model packaging job.\n

" + } + }, + "com.amazonaws.lookoutvision#ModelPackagingStatusMessage": { + "type": "string" + }, + "com.amazonaws.lookoutvision#ModelPerformance": { + "type": "structure", + "members": { + "F1Score": { + "target": "com.amazonaws.lookoutvision#Float", + "traits": { + "smithy.api#documentation": "

The overall F1 score metric for the trained model.

" + } + }, + "Recall": { + "target": "com.amazonaws.lookoutvision#Float", + "traits": { "smithy.api#documentation": "

The overall recall metric value for the trained model.

" } }, @@ -1921,7 +2437,17 @@ "min": 1, "max": 10 }, - "smithy.api#pattern": "([1-9][0-9]*|latest)" + "smithy.api#pattern": "^([1-9][0-9]*|latest)$" + } + }, + "com.amazonaws.lookoutvision#ModelVersionNoLatest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#pattern": "^([1-9][0-9]*)$" } }, "com.amazonaws.lookoutvision#OutputConfig": { @@ -2055,7 +2581,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[a-zA-Z0-9][a-zA-Z0-9_\\-]*" + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-]*$" } }, "com.amazonaws.lookoutvision#QueryString": { @@ -2065,7 +2591,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.lookoutvision#ResourceNotFoundException": { @@ -2117,6 +2643,10 @@ { "value": "TRIAL", "name": "TRIAL" + }, + { + "value": "MODEL_PACKAGE_JOB", + "name": "MODEL_PACKAGE_JOB" } ] } @@ -2131,7 +2661,7 @@ "min": 3, "max": 63 }, - "smithy.api#pattern": "[0-9A-Za-z\\.\\-_]*" + "smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*$" } }, "com.amazonaws.lookoutvision#S3KeyPrefix": { @@ -2150,19 +2680,19 @@ "Bucket": { "target": "com.amazonaws.lookoutvision#S3BucketName", "traits": { - "smithy.api#documentation": "

The S3 bucket that contains the training output.

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

The S3 bucket that contains the training or model packaging job output. If you are training a model,\n the bucket must in your AWS account. If you use an S3 bucket for a model packaging job,\n the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

", "smithy.api#required": {} } }, "Prefix": { "target": "com.amazonaws.lookoutvision#S3KeyPrefix", "traits": { - "smithy.api#documentation": "

The path of the folder, within the S3 bucket, that contains the training output.

" + "smithy.api#documentation": "

The path of the folder, within the S3 bucket, that contains the output.

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

Information about the location training output.

" + "smithy.api#documentation": "

Information about the location of training output or the output of a model packaging job.

" } }, "com.amazonaws.lookoutvision#S3ObjectKey": { @@ -2267,6 +2797,104 @@ } } }, + "com.amazonaws.lookoutvision#StartModelPackagingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutvision#StartModelPackagingJobRequest" + }, + "output": { + "target": "com.amazonaws.lookoutvision#StartModelPackagingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutvision#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutvision#ConflictException" + }, + { + "target": "com.amazonaws.lookoutvision#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutvision#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutvision#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutvision#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for\n a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.\n

\n \n

Use the DescribeModelPackagingJob API to determine the current status of the job.\n \n The model packaging job is complete if the value of Status is SUCCEEDED.

\n

To deploy the component\n to the target device, use the component name and component version\n with the AWS IoT Greengrass CreateDeployment API.

\n\n

This operation requires the following permissions:

\n
    \n
  • \n

    \n lookoutvision:StartModelPackagingJobs\n

    \n
  • \n
  • \n

    \n s3:PutObject\n

    \n
  • \n
  • \n

    \n s3:GetBucketLocation\n

    \n
  • \n
  • \n

    \n greengrass:CreateComponentVersion\n

    \n
  • \n
  • \n

    \n greengrass:DescribeComponent\n

    \n
  • \n
  • \n

    (Optional) greengrass:TagResource. Only required if you want to tag the component.

    \n
  • \n
\n \n \n

For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-11-20/projects/{ProjectName}/modelpackagingjobs", + "code": 200 + } + } + }, + "com.amazonaws.lookoutvision#StartModelPackagingJobRequest": { + "type": "structure", + "members": { + "ProjectName": { + "target": "com.amazonaws.lookoutvision#ProjectName", + "traits": { + "smithy.api#documentation": "

\nThe name of the project which contains the version of the model that you want to package.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutvision#ModelVersion", + "traits": { + "smithy.api#documentation": "

\nThe version of the model within the project that you want to package.\n

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

A name for the model packaging job. If you don't supply a value, the service creates\n a job name for you.\n

" + } + }, + "Configuration": { + "target": "com.amazonaws.lookoutvision#ModelPackagingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the model packaging job.\n

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

A description for the model packaging job.\n

" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutvision#ClientToken", + "traits": { + "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to StartModelPackagingJob\n completes only once. You choose the value to pass. For example, An issue might prevent you\n from getting a response from StartModelPackagingJob.\n In this case, safely retry your call\n to StartModelPackagingJob by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple dataset creation requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to StartModelPackagingJob. An idempotency\n token is active for 8 hours.\n

", + "smithy.api#httpHeader": "X-Amzn-Client-Token", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.lookoutvision#StartModelPackagingJobResponse": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.lookoutvision#ModelPackagingJobName", + "traits": { + "smithy.api#documentation": "

The job name for the model packaging job. If you don't supply a job name in the JobName input parameter,\n the service creates a job name for you.\n\n

" + } + } + } + }, "com.amazonaws.lookoutvision#StartModelRequest": { "type": "structure", "members": { @@ -2289,14 +2917,14 @@ "MinInferenceUnits": { "target": "com.amazonaws.lookoutvision#InferenceUnits", "traits": { - "smithy.api#documentation": "

The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS).\n Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n

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

The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing. \n Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n

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

ClientToken is an idempotency token that ensures a call to StartModel\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from StartModel.\n In this case, safely retry your call\n to StartModel by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to StartModel. An idempotency\n token is active for 8 hours.\n

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

ClientToken is an idempotency token that ensures a call to StartModel\n completes only once. You choose the value to pass. For example, An issue might prevent \n you from getting a response from StartModel.\n In this case, safely retry your call\n to StartModel by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple start requests. You'll need to\n provide your own value for other use cases.

\n \n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to StartModel. An idempotency\n token is active for 8 hours.\n

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -2373,7 +3001,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutvision#ClientToken", "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to StopModel\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from StopModel.\n In this case, safely retry your call\n to StopModel by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to StopModel. An idempotency\n token is active for 8 hours.\n \n \n

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

ClientToken is an idempotency token that ensures a call to StopModel\n completes only once. You choose the value to pass. For example, An issue \n might prevent you from getting a response from StopModel.\n In this case, safely retry your call\n to StopModel by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple stop requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to StopModel. An idempotency\n token is active for 8 hours.\n \n \n

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } @@ -2537,6 +3165,83 @@ "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, + "com.amazonaws.lookoutvision#TargetDevice": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "jetson_xavier", + "name": "JETSON_XAVIER" + } + ] + } + }, + "com.amazonaws.lookoutvision#TargetPlatform": { + "type": "structure", + "members": { + "Os": { + "target": "com.amazonaws.lookoutvision#TargetPlatformOs", + "traits": { + "smithy.api#documentation": "

The target operating system for the model. Linux is the only operating system\n that is currently supported.\n

", + "smithy.api#required": {} + } + }, + "Arch": { + "target": "com.amazonaws.lookoutvision#TargetPlatformArch", + "traits": { + "smithy.api#documentation": "

The target architecture for the model. The currently supported architectures are\n X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).\n

", + "smithy.api#required": {} + } + }, + "Accelerator": { + "target": "com.amazonaws.lookoutvision#TargetPlatformAccelerator", + "traits": { + "smithy.api#documentation": "

The target accelerator for the model. NVIDIA (Nvidia graphics processing unit) \n is the only accelerator that is currently supported. You must also specify the gpu-code, trt-ver,\n and cuda-ver compiler options.\n \n

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

The platform on which a model runs on an AWS IoT Greengrass core device.

" + } + }, + "com.amazonaws.lookoutvision#TargetPlatformAccelerator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NVIDIA", + "name": "NVIDIA" + } + ] + } + }, + "com.amazonaws.lookoutvision#TargetPlatformArch": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ARM64", + "name": "ARM64" + }, + { + "value": "X86_64", + "name": "X86_64" + } + ] + } + }, + "com.amazonaws.lookoutvision#TargetPlatformOs": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LINUX", + "name": "LINUX" + } + ] + } + }, "com.amazonaws.lookoutvision#ThrottlingException": { "type": "structure", "members": { @@ -2663,7 +3368,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more JSON Line entries to a dataset. A JSON Line includes information about an image\n used for training or testing an Amazon Lookout for Vision model. The following is an example JSON Line.

\n \n \n

Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and\n check the Status field in the response.

\n

This operation requires permissions to perform the\n lookoutvision:UpdateDatasetEntries operation.

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

Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image\n used for training or testing an Amazon Lookout for Vision model.

\n

To update an existing JSON Line, use the source-ref field to identify the JSON Line. The JSON line\n that you supply replaces the existing JSON line. Any existing annotations that are not in the new JSON line are removed from the dataset.\n

\n \n \n

For more information, see \n Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer Guide.

\n \n \n

The images you reference in the source-ref field of a JSON line, must be \n in the same S3 bucket as the existing images in the dataset.

\n
\n \n

Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and\n check the Status field in the response.

\n

This operation requires permissions to perform the\n lookoutvision:UpdateDatasetEntries operation.

", "smithy.api#http": { "method": "PATCH", "uri": "/2020-11-20/projects/{ProjectName}/datasets/{DatasetType}/entries", @@ -2700,7 +3405,7 @@ "ClientToken": { "target": "com.amazonaws.lookoutvision#ClientToken", "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries\n completes only once. You choose the value to pass. For example, An issue, \n such as an network outage, might prevent you from getting a response from UpdateDatasetEntries.\n In this case, safely retry your call\n to UpdateDatasetEntries by using the same ClientToken parameter value. An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to UpdateDatasetEntries. An idempotency\n token is active for 8 hours.\n

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

ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries\n completes only once. You choose the value to pass. For example, An issue \n might prevent you from getting a response from UpdateDatasetEntries.\n In this case, safely retry your call\n to UpdateDatasetEntries by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple updates with the same dataset entries. You'll need to\n provide your own value for other use cases.

\n

An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to UpdateDatasetEntries. An idempotency\n token is active for 8 hours.\n

", "smithy.api#httpHeader": "X-Amzn-Client-Token", "smithy.api#idempotencyToken": {} } diff --git a/aws/sdk/aws-models/mediaconnect.json b/aws/sdk/aws-models/mediaconnect.json index c7e7e7e640..02e6b48bb7 100644 --- a/aws/sdk/aws-models/mediaconnect.json +++ b/aws/sdk/aws-models/mediaconnect.json @@ -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": {} } diff --git a/aws/sdk/aws-models/mediaconvert.json b/aws/sdk/aws-models/mediaconvert.json index 320ee32e24..5a745df5e7 100644 --- a/aws/sdk/aws-models/mediaconvert.json +++ b/aws/sdk/aws-models/mediaconvert.json @@ -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": { diff --git a/aws/sdk/aws-models/models.lex.v2.json b/aws/sdk/aws-models/models.lex.v2.json index b4dd730e10..d6eac96c83 100644 --- a/aws/sdk/aws-models/models.lex.v2.json +++ b/aws/sdk/aws-models/models.lex.v2.json @@ -3073,8 +3073,7 @@ "valueSelectionSetting": { "target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting", "traits": { - "smithy.api#documentation": "

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:

\n
    \n
  • \n

    \n OriginalValue - Returns the value entered by the\n user, if the user value is similar to the slot value.

    \n
  • \n
  • \n

    \n TopResolution - 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.

    \n
  • \n
\n

If you don't specify the valueSelectionSetting\n parameter, the default is OriginalValue.

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

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:

\n
    \n
  • \n

    \n OriginalValue - Returns the value entered by the\n user, if the user value is similar to the slot value.

    \n
  • \n
  • \n

    \n TopResolution - 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.

    \n
  • \n
\n

If you don't specify the valueSelectionSetting\n parameter, the default is OriginalValue.

" } }, "parentSlotTypeSignature": { @@ -3106,6 +3105,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting", + "traits": { + "smithy.api#documentation": "

Sets the type of external information used to create the slot\n type.

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

A timestamp of the date and time that the slot type was\n created.

" } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting", + "traits": { + "smithy.api#documentation": "

The type of external information used to create the slot\n type.

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

History of changes, such as when a locale is used in an alias, that\n have taken place for the locale.

" } + }, + "recommendedActions": { + "target": "com.amazonaws.lexmodelsv2#RecommendedActions", + "traits": { + "smithy.api#documentation": "

Recommended actions to take to resolve an error in the\n failureReasons field.

" + } } } }, @@ -5961,6 +5978,9 @@ "traits": { "smithy.api#documentation": "

A timestamp of the date and time that the slot type was last\n updated.

" } + }, + "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": "

Settings required for a slot type based on a grammar that you\n provide.

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

Provides information about the external source of the slot type's\n definition.

" + } + }, "com.amazonaws.lexmodelsv2#FailureReason": { "type": "string" }, @@ -6422,6 +6456,48 @@ "smithy.api#documentation": "

Provides information for updating the user on the progress of\n fulfilling an intent.

" } }, + "com.amazonaws.lexmodelsv2#GrammarSlotTypeSetting": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.lexmodelsv2#GrammarSlotTypeSource", + "traits": { + "smithy.api#documentation": "

The source of the grammar used to create the slot type.

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

Settings requried for a slot type based on a grammar that you\n provide.

" + } + }, + "com.amazonaws.lexmodelsv2#GrammarSlotTypeSource": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.lexmodelsv2#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket that contains the grammar source.

", + "smithy.api#required": {} + } + }, + "s3ObjectKey": { + "target": "com.amazonaws.lexmodelsv2#S3ObjectPath", + "traits": { + "smithy.api#documentation": "

The path to the grammar in the S3 bucket.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon KMS key required to decrypt the contents of the grammar,\n if any.

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

Describes the Amazon S3 bucket name and location for the grammar\n that is the source for the slot type.

" + } + }, "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": "

The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.

" } }, + "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": "

A timestamp of the date and time that the slot type was last\n updated.

" } + }, + "slotTypeCategory": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeCategory", + "traits": { + "smithy.api#documentation": "

Indicates the type of the slot type.

\n
    \n
  • \n

    \n Custom - A slot type that you created using\n custom values. For more information, see Creating custom slot\n types.

    \n
  • \n
  • \n

    \n Extended - A slot type created by extending the\n AMAZON.AlphaNumeric built-in slot type. For more information, see\n AMAZON.AlphaNumeric.

    \n
  • \n
  • \n

    \n ExternalGrammar - A slot type using a custom\n GRXML grammar to define values. For more information, see Using a custom grammar slot type.

    \n
  • \n
" + } } }, "traits": { @@ -11342,6 +11466,12 @@ "traits": { "smithy.api#documentation": "

A timestamp of the date and time that the locale was last\n updated.

" } + }, + "recommendedActions": { + "target": "com.amazonaws.lexmodelsv2#RecommendedActions", + "traits": { + "smithy.api#documentation": "

Recommended actions to take to resolve an error in the\n failureReasons field.

" + } } } }, @@ -12306,8 +12436,7 @@ "valueSelectionSetting": { "target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting", "traits": { - "smithy.api#documentation": "

The strategy that Amazon Lex should use when deciding on a value from the\n list of slot type values.

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

The strategy that Amazon Lex should use when deciding on a value from the\n list of slot type values.

" } }, "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": "

A timestamp of the date and time that the slot type was last\n updated.

" } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting" } } }, @@ -12484,7 +12619,7 @@ "engine": { "target": "com.amazonaws.lexmodelsv2#VoiceEngine", "traits": { - "smithy.api#documentation": "

Indicates the type of Amazon Polly\n voice that Amazon Lex should use for voice interaction with the user. \n For more information, see Voices in Amazon Polly.

" + "smithy.api#documentation": "

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more\n information, see the \n engine parameter of the\n SynthesizeSpeech operation in the\n Amazon Polly developer guide.

\n

If you do not specify a value, the default is\n standard.

" } } }, diff --git a/aws/sdk/aws-models/network-firewall.json b/aws/sdk/aws-models/network-firewall.json index ce6800cf36..3fccf706bb 100644 --- a/aws/sdk/aws-models/network-firewall.json +++ b/aws/sdk/aws-models/network-firewall.json @@ -1186,6 +1186,95 @@ "smithy.api#documentation": "

Returns the data objects for the specified rule group.

" } }, + "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": "

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 DescribeRuleGroup.\n

" + } + }, + "com.amazonaws.networkfirewall#DescribeRuleGroupMetadataRequest": { + "type": "structure", + "members": { + "RuleGroupName": { + "target": "com.amazonaws.networkfirewall#ResourceName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

\n

You must specify the ARN or the name, and you can specify both.

" + } + }, + "RuleGroupArn": { + "target": "com.amazonaws.networkfirewall#ResourceArn", + "traits": { + "smithy.api#documentation": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

\n

You must specify the ARN or the name, and you can specify both.

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

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.

\n \n

This setting is required for requests that do not include the RuleGroupARN.

\n
" + } + } + } + }, + "com.amazonaws.networkfirewall#DescribeRuleGroupMetadataResponse": { + "type": "structure", + "members": { + "RuleGroupArn": { + "target": "com.amazonaws.networkfirewall#ResourceArn", + "traits": { + "smithy.api#documentation": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

\n

You must specify the ARN or the name, and you can specify both.

", + "smithy.api#required": {} + } + }, + "RuleGroupName": { + "target": "com.amazonaws.networkfirewall#ResourceName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

\n

You must specify the ARN or the name, and you can specify both.

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

Returns the metadata objects for the specified rule group.\n

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

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.

\n \n

This setting is required for requests that do not include the RuleGroupARN.

\n
" + } + }, + "Capacity": { + "target": "com.amazonaws.networkfirewall#RuleCapacity", + "traits": { + "smithy.api#documentation": "

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.

\n

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling \n CreateRuleGroup with DryRun set to TRUE.

" + } + }, + "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": "

The default actions to take on a packet that doesn't match any stateful rules.

" + "smithy.api#documentation": "

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.

\n

Valid values of the stateful default action:

\n
    \n
  • \n

    aws:drop_strict

    \n
  • \n
  • \n

    aws:drop_established

    \n
  • \n
  • \n

    aws:alert_strict

    \n
  • \n
  • \n

    aws:alert_established

    \n
  • \n
\n

For more information, see \n Strict evaluation order in the AWS Network Firewall Developer Guide.\n

" } }, "StatefulEngineOptions": { @@ -2063,6 +2152,12 @@ "traits": { "smithy.api#documentation": "

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 NextToken value that you can use in a subsequent call to get the next batch of objects.

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

The scope of the request. The default setting of ACCOUNT or a setting of \n NULL returns all of the rule groups in your account. A setting of \n MANAGED returns all available managed rule groups.

" + } } } }, @@ -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": "

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.

\n
    \n
  • \n

    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 AWS APIs.

    \n

    To access Network Firewall using the REST API endpoint:\n https://network-firewall..amazonaws.com \n

    \n
  • \n
  • \n

    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 AWS SDKs.

    \n
  • \n
  • \n

    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 Network Firewall Developer\n Guide.

    \n
  • \n
\n

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 Suricata website.

\n

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:

\n
    \n
  • \n

    Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and\n block all other forms of traffic.

    \n
  • \n
  • \n

    Use custom lists of known bad domains to limit the types of domain names that your\n applications can access.

    \n
  • \n
  • \n

    Perform deep packet inspection on traffic entering or leaving your VPC.

    \n
  • \n
  • \n

    Use stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.

    \n
  • \n
\n

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 Amazon VPC User Guide.

\n

To start using Network Firewall, do the following:

\n
    \n
  1. \n

    (Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC.

    \n
  2. \n
  3. \n

    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.

    \n
  4. \n
  5. \n

    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.

    \n
  6. \n
  7. \n

    In Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior.

    \n
  8. \n
  9. \n

    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.

    \n
  10. \n
  11. \n

    In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.

    \n
  12. \n
", + "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": "

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.

\n
    \n
  • \n

    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 AWS APIs.

    \n

    To access Network Firewall using the REST API endpoint:\n https://network-firewall..amazonaws.com \n

    \n
  • \n
  • \n

    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 AWS SDKs.

    \n
  • \n
  • \n

    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 Network Firewall Developer\n Guide.

    \n
  • \n
\n

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 Suricata website.

\n

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:

\n
    \n
  • \n

    Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and\n block all other forms of traffic.

    \n
  • \n
  • \n

    Use custom lists of known bad domains to limit the types of domain names that your\n applications can access.

    \n
  • \n
  • \n

    Perform deep packet inspection on traffic entering or leaving your VPC.

    \n
  • \n
  • \n

    Use stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.

    \n
  • \n
\n

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 Amazon VPC User Guide.

\n

To start using Network Firewall, do the following:

\n
    \n
  1. \n

    (Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC.

    \n
  2. \n
  3. \n

    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.

    \n
  4. \n
  5. \n

    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.

    \n
  6. \n
  7. \n

    In Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior.

    \n
  8. \n
  9. \n

    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.

    \n
  10. \n
  11. \n

    In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.

    \n
  12. \n
", - "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": "

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:

\n
    \n
  • \n

    Explicit names. For example, abc.example.com matches only the domain abc.example.com.

    \n
  • \n
  • \n

    Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.

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

The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:

\n
    \n
  • \n

    Explicit names. For example, abc.example.com matches only the domain abc.example.com.

    \n
  • \n
  • \n

    Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.

    \n\t
  • \n
", "smithy.api#required": {} } }, @@ -3084,7 +3214,7 @@ "RuleOrder": { "target": "com.amazonaws.networkfirewall#RuleOrder", "traits": { - "smithy.api#documentation": "

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 STRICT_ORDER, 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.

" + "smithy.api#documentation": "

Indicates how to manage the order of stateful rule evaluation for the policy. DEFAULT_ACTION_ORDER 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 Evaluation order for stateful rules in the AWS Network Firewall Developer Guide.\n

" } } }, @@ -3136,6 +3266,20 @@ ] } }, + "com.amazonaws.networkfirewall#StatefulRuleGroupOverride": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.networkfirewall#OverrideAction", + "traits": { + "smithy.api#documentation": "

The action that changes the rule group from DROP to ALERT. This only applies to\n managed rule groups.

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

The setting that allows the policy owner to change the behavior of the rule group within a policy.

" + } + }, "com.amazonaws.networkfirewall#StatefulRuleGroupReference": { "type": "structure", "members": { @@ -3152,6 +3296,12 @@ "smithy.api#box": {}, "smithy.api#documentation": "

An integer setting that indicates the order in which to run the stateful rule groups in\n a single FirewallPolicy. This setting only applies to firewall policies\n that specify the STRICT_ORDER rule order in the stateful engine options settings.

\n

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.

\n

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.

" } + }, + "Override": { + "target": "com.amazonaws.networkfirewall#StatefulRuleGroupOverride", + "traits": { + "smithy.api#documentation": "

The action that allows the policy owner to override the behavior of the rule group within a policy.

" + } } }, "traits": { @@ -3170,7 +3320,7 @@ "RuleOrder": { "target": "com.amazonaws.networkfirewall#RuleOrder", "traits": { - "smithy.api#documentation": "

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 STRICT_ORDER, your rules are evaluated in the exact order that they're listed \n in your Suricata rules string.

" + "smithy.api#documentation": "

Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER 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 Evaluation order for stateful rules in the AWS Network Firewall Developer Guide.\n

" } } }, @@ -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": "

" + "smithy.api#documentation": "

A flag indicating whether it is possible to delete the firewall. A setting of TRUE 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 TRUE.

" } }, "UpdateToken": { @@ -3918,7 +4080,7 @@ } ], "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Modifies the flag, ChangeProtection, which indicates whether it \n is possible to change the firewall. If the flag is set to TRUE, the firewall is protected \n from changes. This setting helps protect against accidentally changing a firewall that's in use.

" } }, "com.amazonaws.networkfirewall#UpdateFirewallPolicyChangeProtectionRequest": { diff --git a/aws/sdk/aws-models/networkmanager.json b/aws/sdk/aws-models/networkmanager.json index cff1f45877..8577ac5774 100644 --- a/aws/sdk/aws-models/networkmanager.json +++ b/aws/sdk/aws-models/networkmanager.json @@ -29,17 +29,26 @@ ] }, "shapes": { + "com.amazonaws.networkmanager#AWSAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + } + } + }, "com.amazonaws.networkmanager#AWSLocation": { "type": "structure", "members": { "Zone": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The Zone that the device is located in. Specify the ID of an Availability Zone, Local\n Zone, Wavelength Zone, or an Outpost.

" } }, "SubnetArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#SubnetArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the subnet that the device is located in.

" } @@ -49,11 +58,72 @@ "smithy.api#documentation": "

Specifies a location in Amazon Web Services.

" } }, + "com.amazonaws.networkmanager#AcceptAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#AcceptAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#AcceptAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Accepts a core network attachment request.

\n

Once the attachment request is accepted by a core network owner, the attachment is\n created and connected to a core network.

", + "smithy.api#http": { + "method": "POST", + "uri": "/attachments/{AttachmentId}/accept", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#AcceptAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#AcceptAttachmentResponse": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.networkmanager#Attachment", + "traits": { + "smithy.api#documentation": "

The response to the attachment request.

" + } + } + } + }, "com.amazonaws.networkmanager#AccessDeniedException": { "type": "structure", "members": { "Message": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#required": {} } @@ -65,6 +135,90 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.networkmanager#AssociateConnectPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#AssociateConnectPeerRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#AssociateConnectPeerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a core network Connect peer with a device and optionally, with a link.

\n

If you specify a link, it must be associated with the specified device. You can only\n associate core network Connect peers that have been created on a core network Connect\n attachment on a core network.

", + "smithy.api#http": { + "method": "POST", + "uri": "/global-networks/{GlobalNetworkId}/connect-peer-associations", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#AssociateConnectPeerRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of your global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectPeerId": { + "target": "com.amazonaws.networkmanager#ConnectPeerId", + "traits": { + "smithy.api#documentation": "

The ID of the Connect peer.

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

The ID of the device.

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

The ID of the link.

" + } + } + } + }, + "com.amazonaws.networkmanager#AssociateConnectPeerResponse": { + "type": "structure", + "members": { + "ConnectPeerAssociation": { + "target": "com.amazonaws.networkmanager#ConnectPeerAssociation", + "traits": { + "smithy.api#documentation": "

The response to the Connect peer request.

" + } + } + } + }, "com.amazonaws.networkmanager#AssociateCustomerGateway": { "type": "operation", "input": { @@ -109,14 +263,14 @@ "type": "structure", "members": { "CustomerGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#CustomerGatewayArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway.

", "smithy.api#required": {} } }, "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -124,14 +278,14 @@ } }, "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { "smithy.api#documentation": "

The ID of the device.

", "smithy.api#required": {} } }, "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#LinkId", "traits": { "smithy.api#documentation": "

The ID of the link.

" } @@ -193,7 +347,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -201,14 +355,14 @@ } }, "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { "smithy.api#documentation": "

The ID of the device.

", "smithy.api#required": {} } }, "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#LinkId", "traits": { "smithy.api#documentation": "

The ID of the link.

", "smithy.api#required": {} @@ -271,7 +425,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -279,21 +433,21 @@ } }, "TransitGatewayConnectPeerArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Connect peer.

", "smithy.api#required": {} } }, "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { "smithy.api#documentation": "

The ID of the device.

", "smithy.api#required": {} } }, "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#LinkId", "traits": { "smithy.api#documentation": "

The ID of the link.

" } @@ -311,729 +465,794 @@ } } }, - "com.amazonaws.networkmanager#Bandwidth": { + "com.amazonaws.networkmanager#Attachment": { "type": "structure", "members": { - "UploadSpeed": { - "target": "com.amazonaws.networkmanager#Integer", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

Upload speed in Mbps.

" + "smithy.api#documentation": "

A core network ID.

" } }, - "DownloadSpeed": { - "target": "com.amazonaws.networkmanager#Integer", + "CoreNetworkArn": { + "target": "com.amazonaws.networkmanager#CoreNetworkArn", "traits": { - "smithy.api#documentation": "

Download speed in Mbps.

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

Describes bandwidth information.

" - } - }, - "com.amazonaws.networkmanager#Boolean": { - "type": "boolean" - }, - "com.amazonaws.networkmanager#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "

The ARN of a core network.

" } }, - "ResourceId": { - "target": "com.amazonaws.networkmanager#String", + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", "traits": { - "smithy.api#documentation": "

The ID of the resource.

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

The ID of the attachment.

" } }, - "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "OwnerAccountId": { + "target": "com.amazonaws.networkmanager#AWSAccountId", "traits": { - "smithy.api#documentation": "

The resource type.

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

The ID of the attachment account owner.

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

There was a conflict processing the request. Updating or deleting the resource can\n cause an inconsistent state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.networkmanager#Connection": { - "type": "structure", - "members": { - "ConnectionId": { - "target": "com.amazonaws.networkmanager#String", + }, + "AttachmentType": { + "target": "com.amazonaws.networkmanager#AttachmentType", "traits": { - "smithy.api#documentation": "

The ID of the connection.

" + "smithy.api#documentation": "

The type of attachment.

" } }, - "ConnectionArn": { - "target": "com.amazonaws.networkmanager#String", + "State": { + "target": "com.amazonaws.networkmanager#AttachmentState", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection.

" + "smithy.api#documentation": "

The state of the attachment.

" } }, - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", "traits": { - "smithy.api#documentation": "

The ID of the global network.

" + "smithy.api#documentation": "

The Region where the edge is located.

" } }, - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { - "smithy.api#documentation": "

The ID of the first device in the connection.

" + "smithy.api#documentation": "

The attachment resource ARN.

" } }, - "ConnectedDeviceId": { - "target": "com.amazonaws.networkmanager#String", + "AttachmentPolicyRuleNumber": { + "target": "com.amazonaws.networkmanager#Integer", "traits": { - "smithy.api#documentation": "

The ID of the second device in the connection.

" + "smithy.api#documentation": "

The policy rule number associated with the attachment.

" } }, - "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "SegmentName": { + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { - "smithy.api#documentation": "

The ID of the link for the first device in the connection.

" + "smithy.api#documentation": "

The name of the segment attachment.

" } }, - "ConnectedLinkId": { - "target": "com.amazonaws.networkmanager#String", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The ID of the link for the second device in the connection.

" + "smithy.api#documentation": "

The tags associated with the attachment.

" } }, - "Description": { - "target": "com.amazonaws.networkmanager#String", + "ProposedSegmentChange": { + "target": "com.amazonaws.networkmanager#ProposedSegmentChange", "traits": { - "smithy.api#documentation": "

The description of the connection.

" + "smithy.api#documentation": "

The attachment to move from one segment to another.

" } }, "CreatedAt": { "target": "com.amazonaws.networkmanager#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the connection was created.

" - } - }, - "State": { - "target": "com.amazonaws.networkmanager#ConnectionState", - "traits": { - "smithy.api#documentation": "

The state of the connection.

" + "smithy.api#documentation": "

The timestamp when the attachment was created.

" } }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "UpdatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", "traits": { - "smithy.api#documentation": "

The tags for the connection.

" + "smithy.api#documentation": "

The timestamp when the attachment was last updated.

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

Describes a connection.

" + "smithy.api#documentation": "

Describes a core network attachment.

" } }, - "com.amazonaws.networkmanager#ConnectionHealth": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.networkmanager#ConnectionType", - "traits": { - "smithy.api#documentation": "

The connection type.

" - } - }, - "Status": { - "target": "com.amazonaws.networkmanager#ConnectionStatus", - "traits": { - "smithy.api#documentation": "

The connection status.

" - } - }, - "Timestamp": { - "target": "com.amazonaws.networkmanager#DateTime", - "traits": { - "smithy.api#documentation": "

The time the status was last updated.

" - } - } - }, + "com.amazonaws.networkmanager#AttachmentId": { + "type": "string", "traits": { - "smithy.api#documentation": "

Describes connection health.

" + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^attachment-([0-9a-f]{8,17})$" } }, - "com.amazonaws.networkmanager#ConnectionList": { + "com.amazonaws.networkmanager#AttachmentList": { "type": "list", "member": { - "target": "com.amazonaws.networkmanager#Connection" + "target": "com.amazonaws.networkmanager#Attachment" } }, - "com.amazonaws.networkmanager#ConnectionState": { + "com.amazonaws.networkmanager#AttachmentState": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "PENDING", - "name": "pending" + "value": "REJECTED", + "name": "REJECTED" }, { - "value": "AVAILABLE", - "name": "available" + "value": "PENDING_ATTACHMENT_ACCEPTANCE", + "name": "PENDING_ATTACHMENT_ACCEPTANCE" }, { - "value": "DELETING", - "name": "deleting" + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" }, { "value": "UPDATING", - "name": "updating" + "name": "UPDATING" + }, + { + "value": "PENDING_NETWORK_UPDATE", + "name": "PENDING_NETWORK_UPDATE" + }, + { + "value": "PENDING_TAG_ACCEPTANCE", + "name": "PENDING_TAG_ACCEPTANCE" + }, + { + "value": "DELETING", + "name": "DELETING" } ] } }, - "com.amazonaws.networkmanager#ConnectionStatus": { + "com.amazonaws.networkmanager#AttachmentType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "UP", - "name": "UP" + "value": "CONNECT", + "name": "CONNECT" }, { - "value": "DOWN", - "name": "DOWN" + "value": "SITE_TO_SITE_VPN", + "name": "SITE_TO_SITE_VPN" + }, + { + "value": "VPC", + "name": "VPC" } ] } }, - "com.amazonaws.networkmanager#ConnectionType": { - "type": "string", + "com.amazonaws.networkmanager#Bandwidth": { + "type": "structure", + "members": { + "UploadSpeed": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

Upload speed in Mbps.

" + } + }, + "DownloadSpeed": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

Download speed in Mbps.

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

Describes bandwidth information.

" + } + }, + "com.amazonaws.networkmanager#BgpOptions": { + "type": "structure", + "members": { + "PeerAsn": { + "target": "com.amazonaws.networkmanager#Long", + "traits": { + "smithy.api#documentation": "

The Peer ASN of the BGP.

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

Describes the BGP options.

" + } + }, + "com.amazonaws.networkmanager#Boolean": { + "type": "boolean" + }, + "com.amazonaws.networkmanager#ChangeAction": { + "type": "string", "traits": { "smithy.api#enum": [ { - "value": "BGP", - "name": "BGP" + "value": "ADD", + "name": "ADD" }, { - "value": "IPSEC", - "name": "IPSEC" + "value": "MODIFY", + "name": "MODIFY" + }, + { + "value": "REMOVE", + "name": "REMOVE" } ] } }, - "com.amazonaws.networkmanager#CreateConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#CreateConnectionRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#CreateConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" - }, - { - "target": "com.amazonaws.networkmanager#ConflictException" - }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" - }, - { - "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" - }, - { - "target": "com.amazonaws.networkmanager#ValidationException" - } - ], + "com.amazonaws.networkmanager#ChangeSetState": { + "type": "string", "traits": { - "smithy.api#documentation": "

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

", - "smithy.api#http": { - "method": "POST", - "uri": "/global-networks/{GlobalNetworkId}/connections", - "code": 200 + "smithy.api#enum": [ + { + "value": "PENDING_GENERATION", + "name": "PENDING_GENERATION" + }, + { + "value": "FAILED_GENERATION", + "name": "FAILED_GENERATION" + }, + { + "value": "READY_TO_EXECUTE", + "name": "READY_TO_EXECUTE" + }, + { + "value": "EXECUTING", + "name": "EXECUTING" + }, + { + "value": "EXECUTION_SUCCEEDED", + "name": "EXECUTION_SUCCEEDED" + }, + { + "value": "OUT_OF_DATE", + "name": "OUT_OF_DATE" + } + ] + } + }, + "com.amazonaws.networkmanager#ChangeType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CORE_NETWORK_SEGMENT", + "name": "CORE_NETWORK_SEGMENT" + }, + { + "value": "CORE_NETWORK_EDGE", + "name": "CORE_NETWORK_EDGE" + }, + { + "value": "ATTACHMENT_MAPPING", + "name": "ATTACHMENT_MAPPING" + }, + { + "value": "ATTACHMENT_ROUTE_PROPAGATION", + "name": "ATTACHMENT_ROUTE_PROPAGATION" + }, + { + "value": "ATTACHMENT_ROUTE_STATIC", + "name": "ATTACHMENT_ROUTE_STATIC" + } + ] + } + }, + "com.amazonaws.networkmanager#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 } } }, - "com.amazonaws.networkmanager#CreateConnectionRequest": { + "com.amazonaws.networkmanager#ConflictException": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "Message": { + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "ResourceId": { + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { - "smithy.api#documentation": "

The ID of the first device in the connection.

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

The ID of the resource.

", "smithy.api#required": {} } }, - "ConnectedDeviceId": { - "target": "com.amazonaws.networkmanager#String", + "ResourceType": { + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { - "smithy.api#documentation": "

The ID of the second device in the connection.

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

The resource type.

", "smithy.api#required": {} } - }, - "LinkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the link for the first device.

" - } - }, - "ConnectedLinkId": { - "target": "com.amazonaws.networkmanager#String", + } + }, + "traits": { + "smithy.api#documentation": "

There was a conflict processing the request. Updating or deleting the resource can\n cause an inconsistent state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.networkmanager#ConnectAttachment": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.networkmanager#Attachment", "traits": { - "smithy.api#documentation": "

The ID of the link for the second device.

" + "smithy.api#documentation": "

The attachment details.

" } }, - "Description": { - "target": "com.amazonaws.networkmanager#String", + "TransportAttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", "traits": { - "smithy.api#documentation": "

A description of the connection.

\n

Length Constraints: Maximum length of 256 characters.

" + "smithy.api#documentation": "

The ID of the transport attachment.

" } }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "Options": { + "target": "com.amazonaws.networkmanager#ConnectAttachmentOptions", "traits": { - "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + "smithy.api#documentation": "

Options for connecting an attachment.

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

Describes a core network Connect attachment.

" } }, - "com.amazonaws.networkmanager#CreateConnectionResponse": { + "com.amazonaws.networkmanager#ConnectAttachmentOptions": { "type": "structure", "members": { - "Connection": { - "target": "com.amazonaws.networkmanager#Connection", + "Protocol": { + "target": "com.amazonaws.networkmanager#TunnelProtocol", "traits": { - "smithy.api#documentation": "

Information about the connection.

" + "smithy.api#documentation": "

The protocol used for the attachment connection.

" } } - } - }, - "com.amazonaws.networkmanager#CreateDevice": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#CreateDeviceRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#CreateDeviceResponse" }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" - }, - { - "target": "com.amazonaws.networkmanager#ConflictException" - }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" - }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" - }, - { - "target": "com.amazonaws.networkmanager#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "

Creates a new device in a global network. If you specify both a site ID and a\n location, the location of the site is used for visualization in the Network Manager console.

", - "smithy.api#http": { - "method": "POST", - "uri": "/global-networks/{GlobalNetworkId}/devices", - "code": 200 - } + "smithy.api#documentation": "

Describes a core network Connect attachment options.

" } }, - "com.amazonaws.networkmanager#CreateDeviceRequest": { + "com.amazonaws.networkmanager#ConnectPeer": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AWSLocation": { - "target": "com.amazonaws.networkmanager#AWSLocation", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

" - } - }, - "Description": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

A description of the device.

\n

Constraints: Maximum length of 256 characters.

" + "smithy.api#documentation": "

The ID of a core network.

" } }, - "Type": { - "target": "com.amazonaws.networkmanager#String", + "ConnectAttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", "traits": { - "smithy.api#documentation": "

The type of the device.

" + "smithy.api#documentation": "

The ID of the attachment to connect.

" } }, - "Vendor": { - "target": "com.amazonaws.networkmanager#String", + "ConnectPeerId": { + "target": "com.amazonaws.networkmanager#ConnectPeerId", "traits": { - "smithy.api#documentation": "

The vendor of the device.

\n

Constraints: Maximum length of 128 characters.

" + "smithy.api#documentation": "

The ID of the Connect peer.

" } }, - "Model": { - "target": "com.amazonaws.networkmanager#String", + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", "traits": { - "smithy.api#documentation": "

The model of the device.

\n

Constraints: Maximum length of 128 characters.

" + "smithy.api#documentation": "

The Connect peer Regions where edges are located.

" } }, - "SerialNumber": { - "target": "com.amazonaws.networkmanager#String", + "State": { + "target": "com.amazonaws.networkmanager#ConnectPeerState", "traits": { - "smithy.api#documentation": "

The serial number of the device.

\n

Constraints: Maximum length of 128 characters.

" + "smithy.api#documentation": "

The state of the Connect peer.

" } }, - "Location": { - "target": "com.amazonaws.networkmanager#Location", + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", "traits": { - "smithy.api#documentation": "

The location of the device.

" + "smithy.api#documentation": "

The timestamp when the Connect peer was created.

" } }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "Configuration": { + "target": "com.amazonaws.networkmanager#ConnectPeerConfiguration", "traits": { - "smithy.api#documentation": "

The ID of the site.

" + "smithy.api#documentation": "

The configuration of the Connect peer.

" } }, "Tags": { "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + "smithy.api#documentation": "

The tags associated with the Connect peer.

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

Describes a core network Connect peer.

" } }, - "com.amazonaws.networkmanager#CreateDeviceResponse": { + "com.amazonaws.networkmanager#ConnectPeerAssociation": { "type": "structure", "members": { - "Device": { - "target": "com.amazonaws.networkmanager#Device", + "ConnectPeerId": { + "target": "com.amazonaws.networkmanager#ConnectPeerId", "traits": { - "smithy.api#documentation": "

Information about the device.

" + "smithy.api#documentation": "

The ID of the Connect peer.

" } - } - } - }, - "com.amazonaws.networkmanager#CreateGlobalNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#CreateGlobalNetworkRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#CreateGlobalNetworkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" }, - { - "target": "com.amazonaws.networkmanager#ConflictException" + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

" + } }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the device to connect to.

" + } }, - { - "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" - }, - { - "target": "com.amazonaws.networkmanager#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new, empty global network.

", - "smithy.api#http": { - "method": "POST", - "uri": "/global-networks", - "code": 200 - } - } - }, - "com.amazonaws.networkmanager#CreateGlobalNetworkRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.networkmanager#String", + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", "traits": { - "smithy.api#documentation": "

A description of the global network.

\n

Constraints: Maximum length of 256 characters.

" + "smithy.api#documentation": "

The ID of the link.

" } }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "State": { + "target": "com.amazonaws.networkmanager#ConnectPeerAssociationState", "traits": { - "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + "smithy.api#documentation": "

The state of the Connect peer association.

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

Describes a core network Connect peer association.

" } }, - "com.amazonaws.networkmanager#CreateGlobalNetworkResponse": { - "type": "structure", - "members": { - "GlobalNetwork": { - "target": "com.amazonaws.networkmanager#GlobalNetwork", - "traits": { - "smithy.api#documentation": "

Information about the global network object.

" - } - } + "com.amazonaws.networkmanager#ConnectPeerAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#ConnectPeerAssociation" } }, - "com.amazonaws.networkmanager#CreateLink": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#CreateLinkRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#CreateLinkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" - }, - { - "target": "com.amazonaws.networkmanager#ConflictException" - }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" - }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" - }, - { - "target": "com.amazonaws.networkmanager#ValidationException" - } - ], + "com.amazonaws.networkmanager#ConnectPeerAssociationState": { + "type": "string", "traits": { - "smithy.api#documentation": "

Creates a new link for a specified site.

", - "smithy.api#http": { - "method": "POST", - "uri": "/global-networks/{GlobalNetworkId}/links", - "code": 200 - } + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "pending" + }, + { + "value": "AVAILABLE", + "name": "available" + }, + { + "value": "DELETING", + "name": "deleting" + }, + { + "value": "DELETED", + "name": "deleted" + } + ] } }, - "com.amazonaws.networkmanager#CreateLinkRequest": { + "com.amazonaws.networkmanager#ConnectPeerBgpConfiguration": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkAsn": { + "target": "com.amazonaws.networkmanager#Long", "traits": { - "smithy.api#documentation": "

The ID of the global network.

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

The ASN of the Coret Network.

" } }, - "Description": { - "target": "com.amazonaws.networkmanager#String", + "PeerAsn": { + "target": "com.amazonaws.networkmanager#Long", "traits": { - "smithy.api#documentation": "

A description of the link.

\n

Constraints: Maximum length of 256 characters.

" + "smithy.api#documentation": "

The ASN of the Connect peer.

" } }, - "Type": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkAddress": { + "target": "com.amazonaws.networkmanager#IPAddress", "traits": { - "smithy.api#documentation": "

The type of the link.

\n

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^

" + "smithy.api#documentation": "

The address of a core network.

" } }, - "Bandwidth": { - "target": "com.amazonaws.networkmanager#Bandwidth", + "PeerAddress": { + "target": "com.amazonaws.networkmanager#IPAddress", "traits": { - "smithy.api#documentation": "

The upload speed and download speed in Mbps.

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

The address of a core network Connect peer.

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

Describes a core network BGP configuration.

" + } + }, + "com.amazonaws.networkmanager#ConnectPeerBgpConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#ConnectPeerBgpConfiguration" + } + }, + "com.amazonaws.networkmanager#ConnectPeerConfiguration": { + "type": "structure", + "members": { + "CoreNetworkAddress": { + "target": "com.amazonaws.networkmanager#IPAddress", + "traits": { + "smithy.api#documentation": "

The IP address of a core network.

" } }, - "Provider": { - "target": "com.amazonaws.networkmanager#String", + "PeerAddress": { + "target": "com.amazonaws.networkmanager#IPAddress", "traits": { - "smithy.api#documentation": "

The provider of the link.

\n

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^

" + "smithy.api#documentation": "

The IP address of the Connect peer.

" } }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "InsideCidrBlocks": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", "traits": { - "smithy.api#documentation": "

The ID of the site.

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

The inside IP addresses used for a Connect peer configuration.

" } }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "Protocol": { + "target": "com.amazonaws.networkmanager#TunnelProtocol", "traits": { - "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + "smithy.api#documentation": "

The protocol used for a Connect peer configuration.

" } - } - } - }, - "com.amazonaws.networkmanager#CreateLinkResponse": { - "type": "structure", - "members": { - "Link": { - "target": "com.amazonaws.networkmanager#Link", + }, + "BgpConfigurations": { + "target": "com.amazonaws.networkmanager#ConnectPeerBgpConfigurationList", "traits": { - "smithy.api#documentation": "

Information about the link.

" + "smithy.api#documentation": "

The Connect peer BGP configurations.

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

Describes a core network Connect peer configuration.

" } }, - "com.amazonaws.networkmanager#CreateSite": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#CreateSiteRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#CreateSiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" - }, - { - "target": "com.amazonaws.networkmanager#ConflictException" - }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" - }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" + "com.amazonaws.networkmanager#ConnectPeerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 }, - { - "target": "com.amazonaws.networkmanager#ValidationException" - } - ], + "smithy.api#pattern": "^connect-peer-([0-9a-f]{8,17})$" + } + }, + "com.amazonaws.networkmanager#ConnectPeerIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#ConnectPeerId" + } + }, + "com.amazonaws.networkmanager#ConnectPeerState": { + "type": "string", "traits": { - "smithy.api#documentation": "

Creates a new site in a global network.

", - "smithy.api#http": { - "method": "POST", - "uri": "/global-networks/{GlobalNetworkId}/sites", - "code": 200 - } + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] } }, - "com.amazonaws.networkmanager#CreateSiteRequest": { + "com.amazonaws.networkmanager#ConnectPeerSummary": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

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

The ID of a core network.

" } }, - "Description": { - "target": "com.amazonaws.networkmanager#String", + "ConnectAttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", "traits": { - "smithy.api#documentation": "

A description of your site.

\n

Constraints: Maximum length of 256 characters.

" + "smithy.api#documentation": "

The ID of a Connect peer attachment.

" } }, - "Location": { - "target": "com.amazonaws.networkmanager#Location", + "ConnectPeerId": { + "target": "com.amazonaws.networkmanager#ConnectPeerId", "traits": { - "smithy.api#documentation": "

The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

\n
    \n
  • \n

    \n Address: The physical address of the site.

    \n
  • \n
  • \n

    \n Latitude: The latitude of the site.

    \n
  • \n
  • \n

    \n Longitude: The longitude of the site.

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

The ID of a Connect peer.

" + } + }, + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "

The Region where the edge is located.

" + } + }, + "ConnectPeerState": { + "target": "com.amazonaws.networkmanager#ConnectPeerState", + "traits": { + "smithy.api#documentation": "

The state of a Connect peer.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when a Connect peer was created.

" } }, "Tags": { "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + "smithy.api#documentation": "

The tags associated with a Connect peer summary.

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

Summary description of a Connect peer.

" } }, - "com.amazonaws.networkmanager#CreateSiteResponse": { - "type": "structure", - "members": { - "Site": { - "target": "com.amazonaws.networkmanager#Site", - "traits": { - "smithy.api#documentation": "

Information about the site.

" - } - } + "com.amazonaws.networkmanager#ConnectPeerSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#ConnectPeerSummary" } }, - "com.amazonaws.networkmanager#CustomerGatewayAssociation": { + "com.amazonaws.networkmanager#Connection": { "type": "structure", "members": { - "CustomerGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "ConnectionId": { + "target": "com.amazonaws.networkmanager#ConnectionId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway.

" + "smithy.api#documentation": "

The ID of the connection.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.networkmanager#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection.

" } }, "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

" } }, "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { - "smithy.api#documentation": "

The ID of the device.

" + "smithy.api#documentation": "

The ID of the first device in the connection.

" } }, - "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "ConnectedDeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { - "smithy.api#documentation": "

The ID of the link.

" + "smithy.api#documentation": "

The ID of the second device in the connection.

" } }, - "State": { - "target": "com.amazonaws.networkmanager#CustomerGatewayAssociationState", + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", "traits": { - "smithy.api#documentation": "

The association state.

" + "smithy.api#documentation": "

The ID of the link for the first device in the connection.

" + } + }, + "ConnectedLinkId": { + "target": "com.amazonaws.networkmanager#LinkId", + "traits": { + "smithy.api#documentation": "

The ID of the link for the second device in the connection.

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

The description of the connection.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that the connection was created.

" + } + }, + "State": { + "target": "com.amazonaws.networkmanager#ConnectionState", + "traits": { + "smithy.api#documentation": "

The state of the connection.

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

The tags for the connection.

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

Describes the association between a customer gateway, a device, and a link.

" + "smithy.api#documentation": "

Describes a connection.

" } }, - "com.amazonaws.networkmanager#CustomerGatewayAssociationList": { + "com.amazonaws.networkmanager#ConnectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#ConnectionHealth": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.networkmanager#ConnectionType", + "traits": { + "smithy.api#documentation": "

The connection type.

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

The connection status.

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

The time the status was last updated.

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

Describes connection health.

" + } + }, + "com.amazonaws.networkmanager#ConnectionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#ConnectionIdList": { "type": "list", "member": { - "target": "com.amazonaws.networkmanager#CustomerGatewayAssociation" + "target": "com.amazonaws.networkmanager#ConnectionId" } }, - "com.amazonaws.networkmanager#CustomerGatewayAssociationState": { + "com.amazonaws.networkmanager#ConnectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#Connection" + } + }, + "com.amazonaws.networkmanager#ConnectionState": { "type": "string", "traits": { "smithy.api#enum": [ @@ -1050,359 +1269,588 @@ "name": "deleting" }, { - "value": "DELETED", - "name": "deleted" + "value": "UPDATING", + "name": "updating" } ] } }, - "com.amazonaws.networkmanager#DateTime": { - "type": "timestamp" + "com.amazonaws.networkmanager#ConnectionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UP", + "name": "UP" + }, + { + "value": "DOWN", + "name": "DOWN" + } + ] + } }, - "com.amazonaws.networkmanager#DeleteConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#DeleteConnectionRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#DeleteConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" - }, - { - "target": "com.amazonaws.networkmanager#ConflictException" - }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" - }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" - }, - { - "target": "com.amazonaws.networkmanager#ValidationException" - } - ], + "com.amazonaws.networkmanager#ConnectionType": { + "type": "string", "traits": { - "smithy.api#documentation": "

Deletes the specified connection in your global network.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}/connections/{ConnectionId}", - "code": 200 + "smithy.api#enum": [ + { + "value": "BGP", + "name": "BGP" + }, + { + "value": "IPSEC", + "name": "IPSEC" + } + ] + } + }, + "com.amazonaws.networkmanager#ConstrainedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 } } }, - "com.amazonaws.networkmanager#DeleteConnectionRequest": { + "com.amazonaws.networkmanager#ConstrainedStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#ConstrainedString" + } + }, + "com.amazonaws.networkmanager#CoreNetwork": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

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

The ID of the global network that your core network is a part of.

" } }, - "ConnectionId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the connection.

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

The ID of a core network.

" } - } - } - }, - "com.amazonaws.networkmanager#DeleteConnectionResponse": { - "type": "structure", - "members": { - "Connection": { - "target": "com.amazonaws.networkmanager#Connection", + }, + "CoreNetworkArn": { + "target": "com.amazonaws.networkmanager#CoreNetworkArn", "traits": { - "smithy.api#documentation": "

Information about the connection.

" + "smithy.api#documentation": "

The ARN of a core network.

" } - } - } - }, - "com.amazonaws.networkmanager#DeleteDevice": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#DeleteDeviceRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#DeleteDeviceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" }, - { - "target": "com.amazonaws.networkmanager#ConflictException" + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The description of a core network.

" + } }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when a core network was created.

" + } }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + "State": { + "target": "com.amazonaws.networkmanager#CoreNetworkState", + "traits": { + "smithy.api#documentation": "

The current state of a core network.

" + } }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" + "Segments": { + "target": "com.amazonaws.networkmanager#CoreNetworkSegmentList", + "traits": { + "smithy.api#documentation": "

The segments within a core network.

" + } }, - { - "target": "com.amazonaws.networkmanager#ValidationException" + "Edges": { + "target": "com.amazonaws.networkmanager#CoreNetworkEdgeList", + "traits": { + "smithy.api#documentation": "

The edges within a core network.

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

The tags associated with a core network.

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

Deletes an existing device. You must first disassociate the device from any links and\n customer gateways.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}/devices/{DeviceId}", - "code": 200 + "smithy.api#documentation": "

Describes a core network.

" + } + }, + "com.amazonaws.networkmanager#CoreNetworkArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 } } }, - "com.amazonaws.networkmanager#DeleteDeviceRequest": { + "com.amazonaws.networkmanager#CoreNetworkChange": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "Type": { + "target": "com.amazonaws.networkmanager#ChangeType", "traits": { - "smithy.api#documentation": "

The ID of the global network.

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

The type of change.

" } }, - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "Action": { + "target": "com.amazonaws.networkmanager#ChangeAction", "traits": { - "smithy.api#documentation": "

The ID of the device.

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

The action to take for a core network.

" + } + }, + "Identifier": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The resource identifier.

" + } + }, + "PreviousValues": { + "target": "com.amazonaws.networkmanager#CoreNetworkChangeValues", + "traits": { + "smithy.api#documentation": "

The previous values for a core network.

" + } + }, + "NewValues": { + "target": "com.amazonaws.networkmanager#CoreNetworkChangeValues", + "traits": { + "smithy.api#documentation": "

The new value for a core network

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

Details describing a core network change.

" } }, - "com.amazonaws.networkmanager#DeleteDeviceResponse": { + "com.amazonaws.networkmanager#CoreNetworkChangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CoreNetworkChange" + } + }, + "com.amazonaws.networkmanager#CoreNetworkChangeValues": { "type": "structure", "members": { - "Device": { - "target": "com.amazonaws.networkmanager#Device", + "SegmentName": { + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { - "smithy.api#documentation": "

Information about the device.

" + "smithy.api#documentation": "

The names of the segments in a core network.

" } - } - } - }, - "com.amazonaws.networkmanager#DeleteGlobalNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#DeleteGlobalNetworkRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#DeleteGlobalNetworkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" }, - { - "target": "com.amazonaws.networkmanager#ConflictException" + "EdgeLocations": { + "target": "com.amazonaws.networkmanager#ExternalRegionCodeList", + "traits": { + "smithy.api#documentation": "

The Regions where edges are located in a core network.

" + } }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" + "Asn": { + "target": "com.amazonaws.networkmanager#Long", + "traits": { + "smithy.api#documentation": "

The ASN of a core network.

" + } }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + "Cidr": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The IP addresses used for a core network.

" + } }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" + "DestinationIdentifier": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The ID of the destination.

" + } }, - { - "target": "com.amazonaws.networkmanager#ValidationException" + "InsideCidrBlocks": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

The inside IP addresses used for core network change values.

" + } + }, + "SharedSegments": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

The shared segments for a core network change value.

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

Deletes an existing global network. You must first delete all global network objects\n (devices, links, and sites) and deregister all transit gateways.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}", - "code": 200 - } + "smithy.api#documentation": "

Describes a core network change.

" } }, - "com.amazonaws.networkmanager#DeleteGlobalNetworkRequest": { + "com.amazonaws.networkmanager#CoreNetworkEdge": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", "traits": { - "smithy.api#documentation": "

The ID of the global network.

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

The Region where a core network edge is located.

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

The ASN of a core network edge.

" + } + }, + "InsideCidrBlocks": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

The inside IP addresses used for core network edges.

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

Describes a core network edge.

" } }, - "com.amazonaws.networkmanager#DeleteGlobalNetworkResponse": { + "com.amazonaws.networkmanager#CoreNetworkEdgeList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CoreNetworkEdge" + } + }, + "com.amazonaws.networkmanager#CoreNetworkId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^core-network-([0-9a-f]{8,17})$" + } + }, + "com.amazonaws.networkmanager#CoreNetworkPolicy": { "type": "structure", "members": { - "GlobalNetwork": { - "target": "com.amazonaws.networkmanager#GlobalNetwork", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

Information about the global network.

" + "smithy.api#documentation": "

The ID of a core network.

" } - } - } - }, - "com.amazonaws.networkmanager#DeleteLink": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#DeleteLinkRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#DeleteLinkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" }, - { - "target": "com.amazonaws.networkmanager#ConflictException" + "PolicyVersionId": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

The ID of the policy version.

" + } }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" + "Alias": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyAlias", + "traits": { + "smithy.api#documentation": "

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

" + } }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The description of a core network policy.

" + } }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when a core network policy was created.

" + } }, - { - "target": "com.amazonaws.networkmanager#ValidationException" + "ChangeSetState": { + "target": "com.amazonaws.networkmanager#ChangeSetState", + "traits": { + "smithy.api#documentation": "

The state of a core network policy.

" + } + }, + "PolicyErrors": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyErrorList", + "traits": { + "smithy.api#documentation": "

Describes any errors in a core network policy.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.networkmanager#SynthesizedJsonCoreNetworkPolicyDocument", + "traits": { + "smithy.api#documentation": "

Describes a core network policy.

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

Deletes an existing link. You must first disassociate the link from any devices and\n customer gateways.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}/links/{LinkId}", - "code": 200 - } + "smithy.api#documentation": "

Describes a core network policy. You can have only one LIVE Core Policy.

" } }, - "com.amazonaws.networkmanager#DeleteLinkRequest": { + "com.amazonaws.networkmanager#CoreNetworkPolicyAlias": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LIVE", + "name": "LIVE" + }, + { + "value": "LATEST", + "name": "LATEST" + } + ] + } + }, + "com.amazonaws.networkmanager#CoreNetworkPolicyDocument": { + "type": "string" + }, + "com.amazonaws.networkmanager#CoreNetworkPolicyError": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "ErrorCode": { + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { - "smithy.api#documentation": "

The ID of the global network.

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

The error code associated with a core network policy error.

", "smithy.api#required": {} } }, - "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "Message": { + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { - "smithy.api#documentation": "

The ID of the link.

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

The message associated with a core network policy error code.

", "smithy.api#required": {} } + }, + "Path": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#documentation": "

The JSON path where the error was discovered in the policy document.

" + } } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an error in a core network policy.

" } }, - "com.amazonaws.networkmanager#DeleteLinkResponse": { + "com.amazonaws.networkmanager#CoreNetworkPolicyErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyError" + } + }, + "com.amazonaws.networkmanager#CoreNetworkPolicyException": { "type": "structure", "members": { - "Link": { - "target": "com.amazonaws.networkmanager#Link", + "Message": { + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { - "smithy.api#documentation": "

Information about the link.

" + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyErrorList", + "traits": { + "smithy.api#documentation": "

Describes a core network policy exception.

" } } + }, + "traits": { + "smithy.api#documentation": "

Describes a core network policy exception.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, - "com.amazonaws.networkmanager#DeleteSite": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#DeleteSiteRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#DeleteSiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" + "com.amazonaws.networkmanager#CoreNetworkPolicyVersion": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

" + } }, - { - "target": "com.amazonaws.networkmanager#ConflictException" + "PolicyVersionId": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

The ID of the policy version.

" + } }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" + "Alias": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyAlias", + "traits": { + "smithy.api#documentation": "

Whether a core network policy is the current policy or the most recently submitted policy.

" + } }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The description of a core network policy version.

" + } }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The timestamp when a core network policy version was created.

" + } }, - { - "target": "com.amazonaws.networkmanager#ValidationException" + "ChangeSetState": { + "target": "com.amazonaws.networkmanager#ChangeSetState", + "traits": { + "smithy.api#documentation": "

The status of the policy version change set.

" + } } - ], + }, "traits": { - "smithy.api#documentation": "

Deletes an existing site. The site cannot be associated with any device or link.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}/sites/{SiteId}", - "code": 200 - } + "smithy.api#documentation": "

Describes a core network policy version.

" } }, - "com.amazonaws.networkmanager#DeleteSiteRequest": { + "com.amazonaws.networkmanager#CoreNetworkPolicyVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyVersion" + } + }, + "com.amazonaws.networkmanager#CoreNetworkSegment": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "Name": { + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The name of a core network segment.

" } }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "EdgeLocations": { + "target": "com.amazonaws.networkmanager#ExternalRegionCodeList", "traits": { - "smithy.api#documentation": "

The ID of the site.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The Regions where the edges are located.

" + } + }, + "SharedSegments": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

The shared segments of a core network.

" } } + }, + "traits": { + "smithy.api#documentation": "

Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

" } }, - "com.amazonaws.networkmanager#DeleteSiteResponse": { + "com.amazonaws.networkmanager#CoreNetworkSegmentEdgeIdentifier": { "type": "structure", "members": { - "Site": { - "target": "com.amazonaws.networkmanager#Site", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

Information about the site.

" + "smithy.api#documentation": "

The ID of a core network.

" + } + }, + "SegmentName": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The name of the segment edge.

" + } + }, + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "

The Region where the segment edge is located.

" } } + }, + "traits": { + "smithy.api#documentation": "

Returns details about a core network edge.

" } }, - "com.amazonaws.networkmanager#DeregisterTransitGateway": { - "type": "operation", + "com.amazonaws.networkmanager#CoreNetworkSegmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CoreNetworkSegment" + } + }, + "com.amazonaws.networkmanager#CoreNetworkState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.networkmanager#CoreNetworkSummary": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.networkmanager#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "

a core network ARN.

" + } + }, + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The global network ID.

" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.networkmanager#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account owner.

" + } + }, + "State": { + "target": "com.amazonaws.networkmanager#CoreNetworkState", + "traits": { + "smithy.api#documentation": "

The state of a core network.

" + } + }, + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The description of a core network.

" + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The key-value tags associated with a core network summary.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns summary information about a core network.

" + } + }, + "com.amazonaws.networkmanager#CoreNetworkSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CoreNetworkSummary" + } + }, + "com.amazonaws.networkmanager#CreateConnectAttachment": { + "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#DeregisterTransitGatewayRequest" + "target": "com.amazonaws.networkmanager#CreateConnectAttachmentRequest" }, "output": { - "target": "com.amazonaws.networkmanager#DeregisterTransitGatewayResponse" + "target": "com.amazonaws.networkmanager#CreateConnectAttachmentResponse" }, "errors": [ { @@ -1425,58 +1873,86 @@ } ], "traits": { - "smithy.api#documentation": "

Deregisters a transit gateway from your global network. This action does not delete\n your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

", + "smithy.api#documentation": "

Creates a core network Connect attachment from a specified core network attachment.

\n

A core network Connect attachment is a GRE-based tunnel attachment that you can use to\n establish a connection between a core network and an appliance. A core network Connect\n attachment uses an existing VPC attachment as the underlying transport mechanism.

", "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}/transit-gateway-registrations/{TransitGatewayArn}", + "method": "POST", + "uri": "/connect-attachments", "code": 200 } } }, - "com.amazonaws.networkmanager#DeregisterTransitGatewayRequest": { + "com.amazonaws.networkmanager#CreateConnectAttachmentRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The ID of a core network where you want to create the attachment.

", "smithy.api#required": {} } }, - "TransitGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The Region where the edge is located.

", + "smithy.api#required": {} + } + }, + "TransportAttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment between the two connections.

", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.networkmanager#ConnectAttachmentOptions", + "traits": { + "smithy.api#documentation": "

Options for creating an attachment.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The list of key-value tags associated with the request.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.networkmanager#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token associated with the request.

", + "smithy.api#idempotencyToken": {} + } } } }, - "com.amazonaws.networkmanager#DeregisterTransitGatewayResponse": { + "com.amazonaws.networkmanager#CreateConnectAttachmentResponse": { "type": "structure", "members": { - "TransitGatewayRegistration": { - "target": "com.amazonaws.networkmanager#TransitGatewayRegistration", + "ConnectAttachment": { + "target": "com.amazonaws.networkmanager#ConnectAttachment", "traits": { - "smithy.api#documentation": "

The transit gateway registration information.

" + "smithy.api#documentation": "

The response to a Connect attachment request.

" } } } }, - "com.amazonaws.networkmanager#DescribeGlobalNetworks": { + "com.amazonaws.networkmanager#CreateConnectPeer": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#DescribeGlobalNetworksRequest" + "target": "com.amazonaws.networkmanager#CreateConnectPeerRequest" }, "output": { - "target": "com.amazonaws.networkmanager#DescribeGlobalNetworksResponse" + "target": "com.amazonaws.networkmanager#CreateConnectPeerResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, @@ -1491,190 +1967,83 @@ } ], "traits": { - "smithy.api#documentation": "

Describes one or more global networks. By default, all global networks are\n described. To describe the objects in your global network, you must use the appropriate\n Get* action. For example, to list the transit gateways in your global\n network, use GetTransitGatewayRegistrations.

", + "smithy.api#documentation": "

Creates a core network connect peer for a specified core network connect attachment between a core network and an appliance.\n The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks", + "method": "POST", + "uri": "/connect-peers", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.networkmanager#DescribeGlobalNetworksRequest": { - "type": "structure", - "members": { - "GlobalNetworkIds": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

The IDs of one or more global networks. The maximum is 10.

", - "smithy.api#httpQuery": "globalNetworkIds" - } - }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.networkmanager#DescribeGlobalNetworksResponse": { - "type": "structure", - "members": { - "GlobalNetworks": { - "target": "com.amazonaws.networkmanager#GlobalNetworkList", - "traits": { - "smithy.api#documentation": "

Information about the global networks.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } } } }, - "com.amazonaws.networkmanager#Device": { + "com.amazonaws.networkmanager#CreateConnectPeerRequest": { "type": "structure", "members": { - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the device.

" - } - }, - "DeviceArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device.

" - } - }, - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the global network.

" - } - }, - "AWSLocation": { - "target": "com.amazonaws.networkmanager#AWSLocation", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services location of the device.

" - } - }, - "Description": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The description of the device.

" - } - }, - "Type": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The device type.

" - } - }, - "Vendor": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The device vendor.

" - } - }, - "Model": { - "target": "com.amazonaws.networkmanager#String", + "ConnectAttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", "traits": { - "smithy.api#documentation": "

The device model.

" + "smithy.api#documentation": "

The ID of the connection attachment.

", + "smithy.api#required": {} } }, - "SerialNumber": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkAddress": { + "target": "com.amazonaws.networkmanager#IPAddress", "traits": { - "smithy.api#documentation": "

The device serial number.

" + "smithy.api#documentation": "

A Connect peer core network address.

" } }, - "Location": { - "target": "com.amazonaws.networkmanager#Location", + "PeerAddress": { + "target": "com.amazonaws.networkmanager#IPAddress", "traits": { - "smithy.api#documentation": "

The site location.

" + "smithy.api#documentation": "

The Connect peer address.

", + "smithy.api#required": {} } }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "BgpOptions": { + "target": "com.amazonaws.networkmanager#BgpOptions", "traits": { - "smithy.api#documentation": "

The site ID.

" + "smithy.api#documentation": "

The Connect peer BGP options.

" } }, - "CreatedAt": { - "target": "com.amazonaws.networkmanager#DateTime", + "InsideCidrBlocks": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", "traits": { - "smithy.api#documentation": "

The date and time that the site was created.

" + "smithy.api#documentation": "

The inside IP addresses used for BGP peering.

", + "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.networkmanager#DeviceState", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The device state.

" + "smithy.api#documentation": "

The tags associated with the peer request.

" } }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "ClientToken": { + "target": "com.amazonaws.networkmanager#ClientToken", "traits": { - "smithy.api#documentation": "

The tags for the device.

" + "smithy.api#documentation": "

The client token associated with the request.

", + "smithy.api#idempotencyToken": {} } } - }, - "traits": { - "smithy.api#documentation": "

Describes a device.

" - } - }, - "com.amazonaws.networkmanager#DeviceList": { - "type": "list", - "member": { - "target": "com.amazonaws.networkmanager#Device" } }, - "com.amazonaws.networkmanager#DeviceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "com.amazonaws.networkmanager#CreateConnectPeerResponse": { + "type": "structure", + "members": { + "ConnectPeer": { + "target": "com.amazonaws.networkmanager#ConnectPeer", + "traits": { + "smithy.api#documentation": "

The response to the request.

" } - ] + } } }, - "com.amazonaws.networkmanager#DisassociateCustomerGateway": { + "com.amazonaws.networkmanager#CreateConnection": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#DisassociateCustomerGatewayRequest" + "target": "com.amazonaws.networkmanager#CreateConnectionRequest" }, "output": { - "target": "com.amazonaws.networkmanager#DisassociateCustomerGatewayResponse" + "target": "com.amazonaws.networkmanager#CreateConnectionResponse" }, "errors": [ { @@ -1687,7 +2056,7 @@ "target": "com.amazonaws.networkmanager#InternalServerException" }, { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkmanager#ThrottlingException" @@ -1697,53 +2066,83 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a customer gateway from a device and a link.

", + "smithy.api#documentation": "

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

", "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}/customer-gateway-associations/{CustomerGatewayArn}", + "method": "POST", + "uri": "/global-networks/{GlobalNetworkId}/connections", "code": 200 } } }, - "com.amazonaws.networkmanager#DisassociateCustomerGatewayRequest": { + "com.amazonaws.networkmanager#CreateConnectionRequest": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "CustomerGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The ID of the first device in the connection.

", + "smithy.api#required": {} + } + }, + "ConnectedDeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the second device in the connection.

", "smithy.api#required": {} } + }, + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", + "traits": { + "smithy.api#documentation": "

The ID of the link for the first device.

" + } + }, + "ConnectedLinkId": { + "target": "com.amazonaws.networkmanager#LinkId", + "traits": { + "smithy.api#documentation": "

The ID of the link for the second device.

" + } + }, + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

A description of the connection.

\n

Length Constraints: Maximum length of 256 characters.

" + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource during creation.

" + } } } }, - "com.amazonaws.networkmanager#DisassociateCustomerGatewayResponse": { + "com.amazonaws.networkmanager#CreateConnectionResponse": { "type": "structure", "members": { - "CustomerGatewayAssociation": { - "target": "com.amazonaws.networkmanager#CustomerGatewayAssociation", + "Connection": { + "target": "com.amazonaws.networkmanager#Connection", "traits": { - "smithy.api#documentation": "

Information about the customer gateway association.

" + "smithy.api#documentation": "

Information about the connection.

" } } } }, - "com.amazonaws.networkmanager#DisassociateLink": { + "com.amazonaws.networkmanager#CreateCoreNetwork": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#DisassociateLinkRequest" + "target": "com.amazonaws.networkmanager#CreateCoreNetworkRequest" }, "output": { - "target": "com.amazonaws.networkmanager#DisassociateLinkResponse" + "target": "com.amazonaws.networkmanager#CreateCoreNetworkResponse" }, "errors": [ { @@ -1752,11 +2151,14 @@ { "target": "com.amazonaws.networkmanager#ConflictException" }, + { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkmanager#ThrottlingException" @@ -1766,61 +2168,69 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates an existing device from a link. You must first disassociate any customer\n gateways that are associated with the link.

", + "smithy.api#documentation": "

Creates a core network as part of your global network, and optionally, with a core network policy.

", "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}/link-associations", + "method": "POST", + "uri": "/core-networks", "code": 200 } } }, - "com.amazonaws.networkmanager#DisassociateLinkRequest": { + "com.amazonaws.networkmanager#CreateCoreNetworkRequest": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The ID of the global network that a core network will be a part of.

", "smithy.api#required": {} } }, - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { - "smithy.api#documentation": "

The ID of the device.

", - "smithy.api#httpQuery": "deviceId", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of a core network.

" } }, - "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The ID of the link.

", - "smithy.api#httpQuery": "linkId", - "smithy.api#required": {} + "smithy.api#documentation": "

Key-value tags associated with a core network request.

" + } + }, + "PolicyDocument": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy document for creating a core network.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.networkmanager#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token associated with a core network request.

", + "smithy.api#idempotencyToken": {} } } } }, - "com.amazonaws.networkmanager#DisassociateLinkResponse": { + "com.amazonaws.networkmanager#CreateCoreNetworkResponse": { "type": "structure", "members": { - "LinkAssociation": { - "target": "com.amazonaws.networkmanager#LinkAssociation", + "CoreNetwork": { + "target": "com.amazonaws.networkmanager#CoreNetwork", "traits": { - "smithy.api#documentation": "

Information about the link association.

" + "smithy.api#documentation": "

Returns details about a core network.

" } } } }, - "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeer": { + "com.amazonaws.networkmanager#CreateDevice": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeerRequest" + "target": "com.amazonaws.networkmanager#CreateDeviceRequest" }, "output": { - "target": "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeerResponse" + "target": "com.amazonaws.networkmanager#CreateDeviceResponse" }, "errors": [ { @@ -1835,6 +2245,9 @@ { "target": "com.amazonaws.networkmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.networkmanager#ThrottlingException" }, @@ -1843,113 +2256,112 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a transit gateway Connect peer from a device and link.

", + "smithy.api#documentation": "

Creates a new device in a global network. If you specify both a site ID and a\n location, the location of the site is used for visualization in the Network Manager console.

", "smithy.api#http": { - "method": "DELETE", - "uri": "/global-networks/{GlobalNetworkId}/transit-gateway-connect-peer-associations/{TransitGatewayConnectPeerArn}", + "method": "POST", + "uri": "/global-networks/{GlobalNetworkId}/devices", "code": 200 } } }, - "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeerRequest": { + "com.amazonaws.networkmanager#CreateDeviceRequest": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "TransitGatewayConnectPeerArn": { - "target": "com.amazonaws.networkmanager#String", + "AWSLocation": { + "target": "com.amazonaws.networkmanager#AWSLocation", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

" + } + }, + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

A description of the device.

\n

Constraints: Maximum length of 256 characters.

" + } + }, + "Type": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The type of the device.

" + } + }, + "Vendor": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The vendor of the device.

\n

Constraints: Maximum length of 128 characters.

" + } + }, + "Model": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The model of the device.

\n

Constraints: Maximum length of 128 characters.

" + } + }, + "SerialNumber": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The serial number of the device.

\n

Constraints: Maximum length of 128 characters.

" + } + }, + "Location": { + "target": "com.amazonaws.networkmanager#Location", + "traits": { + "smithy.api#documentation": "

The location of the device.

" + } + }, + "SiteId": { + "target": "com.amazonaws.networkmanager#SiteId", + "traits": { + "smithy.api#documentation": "

The ID of the site.

" + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource during creation.

" } } } }, - "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeerResponse": { + "com.amazonaws.networkmanager#CreateDeviceResponse": { "type": "structure", "members": { - "TransitGatewayConnectPeerAssociation": { - "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerAssociation", + "Device": { + "target": "com.amazonaws.networkmanager#Device", "traits": { - "smithy.api#documentation": "

The transit gateway Connect peer association.

" + "smithy.api#documentation": "

Information about the device.

" } } } }, - "com.amazonaws.networkmanager#ExceptionContextKey": { - "type": "string" - }, - "com.amazonaws.networkmanager#ExceptionContextMap": { - "type": "map", - "key": { - "target": "com.amazonaws.networkmanager#ExceptionContextKey" - }, - "value": { - "target": "com.amazonaws.networkmanager#ExceptionContextValue" - } - }, - "com.amazonaws.networkmanager#ExceptionContextValue": { - "type": "string" - }, - "com.amazonaws.networkmanager#FilterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.networkmanager#FilterName" - }, - "value": { - "target": "com.amazonaws.networkmanager#FilterValues" - } - }, - "com.amazonaws.networkmanager#FilterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^[0-9a-zA-Z\\.-]*$" - } - }, - "com.amazonaws.networkmanager#FilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[0-9a-zA-Z\\*\\.\\\\/\\?-]*$" - } - }, - "com.amazonaws.networkmanager#FilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.networkmanager#FilterValue" - } - }, - "com.amazonaws.networkmanager#GetConnections": { + "com.amazonaws.networkmanager#CreateGlobalNetwork": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetConnectionsRequest" + "target": "com.amazonaws.networkmanager#CreateGlobalNetworkRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetConnectionsResponse" + "target": "com.amazonaws.networkmanager#CreateGlobalNetworkResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networkmanager#ThrottlingException" @@ -1959,84 +2371,49 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about one or more of your connections in a global network.

", + "smithy.api#documentation": "

Creates a new, empty global network.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/connections", + "method": "POST", + "uri": "/global-networks", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.networkmanager#GetConnectionsRequest": { + "com.amazonaws.networkmanager#CreateGlobalNetworkRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ConnectionIds": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

One or more connection IDs.

", - "smithy.api#httpQuery": "connectionIds" - } - }, - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the device.

", - "smithy.api#httpQuery": "deviceId" - } - }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

A description of the global network.

\n

Constraints: Maximum length of 256 characters.

" } }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The tags to apply to the resource during creation.

" } } } }, - "com.amazonaws.networkmanager#GetConnectionsResponse": { + "com.amazonaws.networkmanager#CreateGlobalNetworkResponse": { "type": "structure", "members": { - "Connections": { - "target": "com.amazonaws.networkmanager#ConnectionList", - "traits": { - "smithy.api#documentation": "

Information about the connections.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "GlobalNetwork": { + "target": "com.amazonaws.networkmanager#GlobalNetwork", "traits": { - "smithy.api#documentation": "

The token to use for the next page of results.

" + "smithy.api#documentation": "

Information about the global network object.

" } } } }, - "com.amazonaws.networkmanager#GetCustomerGatewayAssociations": { + "com.amazonaws.networkmanager#CreateLink": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsRequest" + "target": "com.amazonaws.networkmanager#CreateLinkRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsResponse" + "target": "com.amazonaws.networkmanager#CreateLinkResponse" }, "errors": [ { @@ -2051,6 +2428,9 @@ { "target": "com.amazonaws.networkmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.networkmanager#ThrottlingException" }, @@ -2059,88 +2439,100 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the association information for customer gateways that are associated with\n devices and links in your global network.

", + "smithy.api#documentation": "

Creates a new link for a specified site.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/customer-gateway-associations", + "method": "POST", + "uri": "/global-networks/{GlobalNetworkId}/links", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsRequest": { + "com.amazonaws.networkmanager#CreateLinkRequest": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "CustomerGatewayArns": { - "target": "com.amazonaws.networkmanager#StringList", + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { - "smithy.api#documentation": "

One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

", - "smithy.api#httpQuery": "customerGatewayArns" + "smithy.api#documentation": "

A description of the link.

\n

Constraints: Maximum length of 256 characters.

" } }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", + "Type": { + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The type of the link.

\n

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^

" } }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "Bandwidth": { + "target": "com.amazonaws.networkmanager#Bandwidth", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The upload speed and download speed in Mbps.

", + "smithy.api#required": {} + } + }, + "Provider": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The provider of the link.

\n

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^

" + } + }, + "SiteId": { + "target": "com.amazonaws.networkmanager#SiteId", + "traits": { + "smithy.api#documentation": "

The ID of the site.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the resource during creation.

" } } } }, - "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsResponse": { + "com.amazonaws.networkmanager#CreateLinkResponse": { "type": "structure", "members": { - "CustomerGatewayAssociations": { - "target": "com.amazonaws.networkmanager#CustomerGatewayAssociationList", - "traits": { - "smithy.api#documentation": "

The customer gateway associations.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "Link": { + "target": "com.amazonaws.networkmanager#Link", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Information about the link.

" } } } }, - "com.amazonaws.networkmanager#GetDevices": { + "com.amazonaws.networkmanager#CreateSite": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetDevicesRequest" + "target": "com.amazonaws.networkmanager#CreateSiteRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetDevicesResponse" + "target": "com.amazonaws.networkmanager#CreateSiteResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, { "target": "com.amazonaws.networkmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.networkmanager#ThrottlingException" }, @@ -2149,89 +2541,71 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about one or more of your devices in a global network.

", + "smithy.api#documentation": "

Creates a new site in a global network.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/devices", + "method": "POST", + "uri": "/global-networks/{GlobalNetworkId}/sites", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.networkmanager#GetDevicesRequest": { + "com.amazonaws.networkmanager#CreateSiteRequest": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DeviceIds": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

One or more device IDs. The maximum is 10.

", - "smithy.api#httpQuery": "deviceIds" - } - }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { - "smithy.api#documentation": "

The ID of the site.

", - "smithy.api#httpQuery": "siteId" + "smithy.api#documentation": "

A description of your site.

\n

Constraints: Maximum length of 256 characters.

" } }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", + "Location": { + "target": "com.amazonaws.networkmanager#Location", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

\n
    \n
  • \n

    \n Address: The physical address of the site.

    \n
  • \n
  • \n

    \n Latitude: The latitude of the site.

    \n
  • \n
  • \n

    \n Longitude: The longitude of the site.

    \n
  • \n
" } }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The tags to apply to the resource during creation.

" } } } }, - "com.amazonaws.networkmanager#GetDevicesResponse": { + "com.amazonaws.networkmanager#CreateSiteResponse": { "type": "structure", "members": { - "Devices": { - "target": "com.amazonaws.networkmanager#DeviceList", - "traits": { - "smithy.api#documentation": "

The devices.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "Site": { + "target": "com.amazonaws.networkmanager#Site", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Information about the site.

" } } } }, - "com.amazonaws.networkmanager#GetLinkAssociations": { + "com.amazonaws.networkmanager#CreateSiteToSiteVpnAttachment": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetLinkAssociationsRequest" + "target": "com.amazonaws.networkmanager#CreateSiteToSiteVpnAttachmentRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetLinkAssociationsResponse" + "target": "com.amazonaws.networkmanager#CreateSiteToSiteVpnAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, @@ -2246,89 +2620,72 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the link associations for a device or a link. Either the device ID or the link ID\n must be specified.

", + "smithy.api#documentation": "

Creates a site-to-site VPN attachment on an edge location of a core network.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/link-associations", + "method": "POST", + "uri": "/site-to-site-vpn-attachments", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.networkmanager#GetLinkAssociationsRequest": { + "com.amazonaws.networkmanager#CreateSiteToSiteVpnAttachmentRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The ID of a core network where you're creating a site-to-site VPN attachment.

", "smithy.api#required": {} } }, - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the device.

", - "smithy.api#httpQuery": "deviceId" - } - }, - "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "VpnConnectionArn": { + "target": "com.amazonaws.networkmanager#VpnConnectionArn", "traits": { - "smithy.api#documentation": "

The ID of the link.

", - "smithy.api#httpQuery": "linkId" + "smithy.api#documentation": "

The ARN identifying the VPN attachment.

", + "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The tags associated with the request.

" } }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "ClientToken": { + "target": "com.amazonaws.networkmanager#ClientToken", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The client token associated with the request.

", + "smithy.api#idempotencyToken": {} } } } }, - "com.amazonaws.networkmanager#GetLinkAssociationsResponse": { + "com.amazonaws.networkmanager#CreateSiteToSiteVpnAttachmentResponse": { "type": "structure", "members": { - "LinkAssociations": { - "target": "com.amazonaws.networkmanager#LinkAssociationList", + "SiteToSiteVpnAttachment": { + "target": "com.amazonaws.networkmanager#SiteToSiteVpnAttachment", "traits": { - "smithy.api#documentation": "

The link associations.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Details about a site-to-site VPN attachment.

" } } } }, - "com.amazonaws.networkmanager#GetLinks": { + "com.amazonaws.networkmanager#CreateVpcAttachment": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetLinksRequest" + "target": "com.amazonaws.networkmanager#CreateVpcAttachmentRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetLinksResponse" + "target": "com.amazonaws.networkmanager#CreateVpcAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, @@ -2343,190 +2700,170 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about one or more links in a specified global network.

\n

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

", + "smithy.api#documentation": "

Creates a VPC attachment on an edge location of a core network.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/links", + "method": "POST", + "uri": "/vpc-attachments", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.networkmanager#GetLinksRequest": { + "com.amazonaws.networkmanager#CreateVpcAttachmentRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The ID of a core network for the VPC attachment.

", "smithy.api#required": {} } }, - "LinkIds": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

One or more link IDs. The maximum is 10.

", - "smithy.api#httpQuery": "linkIds" - } - }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "VpcArn": { + "target": "com.amazonaws.networkmanager#VpcArn", "traits": { - "smithy.api#documentation": "

The ID of the site.

", - "smithy.api#httpQuery": "siteId" + "smithy.api#documentation": "

The ARN of the VPC.

", + "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.networkmanager#String", + "SubnetArns": { + "target": "com.amazonaws.networkmanager#SubnetArnList", "traits": { - "smithy.api#documentation": "

The link type.

", - "smithy.api#httpQuery": "type" + "smithy.api#documentation": "

The subnet ARN of the VPC attachment.

", + "smithy.api#required": {} } }, - "Provider": { - "target": "com.amazonaws.networkmanager#String", + "Options": { + "target": "com.amazonaws.networkmanager#VpcOptions", "traits": { - "smithy.api#documentation": "

The link provider.

", - "smithy.api#httpQuery": "provider" + "smithy.api#documentation": "

Options for the VPC attachment.

" } }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The key-value tags associated with the request.

" } }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "ClientToken": { + "target": "com.amazonaws.networkmanager#ClientToken", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The client token associated with the request.

", + "smithy.api#idempotencyToken": {} } } } }, - "com.amazonaws.networkmanager#GetLinksResponse": { + "com.amazonaws.networkmanager#CreateVpcAttachmentResponse": { "type": "structure", "members": { - "Links": { - "target": "com.amazonaws.networkmanager#LinkList", - "traits": { - "smithy.api#documentation": "

The links.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "VpcAttachment": { + "target": "com.amazonaws.networkmanager#VpcAttachment", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Provides details about the VPC attachment.

" } } } }, - "com.amazonaws.networkmanager#GetNetworkResourceCounts": { - "type": "operation", - "input": { - "target": "com.amazonaws.networkmanager#GetNetworkResourceCountsRequest" - }, - "output": { - "target": "com.amazonaws.networkmanager#GetNetworkResourceCountsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.networkmanager#AccessDeniedException" - }, - { - "target": "com.amazonaws.networkmanager#InternalServerException" - }, - { - "target": "com.amazonaws.networkmanager#ThrottlingException" - }, - { - "target": "com.amazonaws.networkmanager#ValidationException" - } - ], + "com.amazonaws.networkmanager#CustomerGatewayArn": { + "type": "string", "traits": { - "smithy.api#documentation": "

Gets the count of network resources, by resource type, for the specified global network.

", - "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/network-resource-count", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" + "smithy.api#length": { + "min": 0, + "max": 500 } } }, - "com.amazonaws.networkmanager#GetNetworkResourceCountsRequest": { + "com.amazonaws.networkmanager#CustomerGatewayArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CustomerGatewayArn" + } + }, + "com.amazonaws.networkmanager#CustomerGatewayAssociation": { "type": "structure", "members": { + "CustomerGatewayArn": { + "target": "com.amazonaws.networkmanager#CustomerGatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway.

" + } + }, "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the global network.

" } }, - "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { - "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n
    \n
  • \n

    \n dxcon\n

    \n
  • \n
  • \n

    \n dx-gateway\n

    \n
  • \n
  • \n

    \n dx-vif\n

    \n
  • \n
\n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection\n

    \n
  • \n
  • \n

    \n device\n

    \n
  • \n
  • \n

    \n link\n

    \n
  • \n
  • \n

    \n site\n

    \n
  • \n
\n\n

The following are the supported resource types for Amazon VPC:

\n
    \n
  • \n

    \n customer-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway-attachment\n

    \n
  • \n
  • \n

    \n transit-gateway-connect-peer\n

    \n
  • \n
  • \n

    \n transit-gateway-route-table\n

    \n
  • \n
  • \n

    \n vpn-connection\n

    \n
  • \n
", - "smithy.api#httpQuery": "resourceType" + "smithy.api#documentation": "

The ID of the device.

" } }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The ID of the link.

" } }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "State": { + "target": "com.amazonaws.networkmanager#CustomerGatewayAssociationState", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The association state.

" } } + }, + "traits": { + "smithy.api#documentation": "

Describes the association between a customer gateway, a device, and a link.

" } }, - "com.amazonaws.networkmanager#GetNetworkResourceCountsResponse": { - "type": "structure", - "members": { - "NetworkResourceCounts": { - "target": "com.amazonaws.networkmanager#NetworkResourceCountList", - "traits": { - "smithy.api#documentation": "

The count of resources.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "com.amazonaws.networkmanager#CustomerGatewayAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CustomerGatewayAssociation" + } + }, + "com.amazonaws.networkmanager#CustomerGatewayAssociationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "pending" + }, + { + "value": "AVAILABLE", + "name": "available" + }, + { + "value": "DELETING", + "name": "deleting" + }, + { + "value": "DELETED", + "name": "deleted" } - } + ] } }, - "com.amazonaws.networkmanager#GetNetworkResourceRelationships": { + "com.amazonaws.networkmanager#DateTime": { + "type": "timestamp" + }, + "com.amazonaws.networkmanager#DeleteAttachment": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetNetworkResourceRelationshipsRequest" + "target": "com.amazonaws.networkmanager#DeleteAttachmentRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetNetworkResourceRelationshipsResponse" + "target": "com.amazonaws.networkmanager#DeleteAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, @@ -2541,110 +2878,53 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the network resource relationships for the specified global network.

", + "smithy.api#documentation": "

Deletes an attachment. Supports all attachment types.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/network-resource-relationships", + "method": "DELETE", + "uri": "/attachments/{AttachmentId}", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.networkmanager#GetNetworkResourceRelationshipsRequest": { + "com.amazonaws.networkmanager#DeleteAttachmentRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#documentation": "

The ID of the attachment to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "RegisteredGatewayArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ARN of the registered gateway.

", - "smithy.api#httpQuery": "registeredGatewayArn" - } - }, - "AwsRegion": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region.

", - "smithy.api#httpQuery": "awsRegion" - } - }, - "AccountId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpQuery": "accountId" - } - }, - "ResourceType": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n
    \n
  • \n

    \n dxcon\n

    \n
  • \n
  • \n

    \n dx-gateway\n

    \n
  • \n
  • \n

    \n dx-vif\n

    \n
  • \n
\n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection\n

    \n
  • \n
  • \n

    \n device\n

    \n
  • \n
  • \n

    \n link\n

    \n
  • \n
  • \n

    \n site\n

    \n
  • \n
\n\n

The following are the supported resource types for Amazon VPC:

\n
    \n
  • \n

    \n customer-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway-attachment\n

    \n
  • \n
  • \n

    \n transit-gateway-connect-peer\n

    \n
  • \n
  • \n

    \n transit-gateway-route-table\n

    \n
  • \n
  • \n

    \n vpn-connection\n

    \n
  • \n
", - "smithy.api#httpQuery": "resourceType" - } - }, - "ResourceArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ARN of the gateway.

", - "smithy.api#httpQuery": "resourceArn" - } - }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" - } } } }, - "com.amazonaws.networkmanager#GetNetworkResourceRelationshipsResponse": { + "com.amazonaws.networkmanager#DeleteAttachmentResponse": { "type": "structure", "members": { - "Relationships": { - "target": "com.amazonaws.networkmanager#RelationshipList", - "traits": { - "smithy.api#documentation": "

The resource relationships.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "Attachment": { + "target": "com.amazonaws.networkmanager#Attachment", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Information about the deleted attachment.

" } } } }, - "com.amazonaws.networkmanager#GetNetworkResources": { + "com.amazonaws.networkmanager#DeleteConnectPeer": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetNetworkResourcesRequest" + "target": "com.amazonaws.networkmanager#DeleteConnectPeerRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetNetworkResourcesResponse" + "target": "com.amazonaws.networkmanager#DeleteConnectPeerResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, @@ -2659,110 +2939,53 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the network resources for the specified global network.

\n

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

", + "smithy.api#documentation": "

Deletes a Connect peer.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/network-resources", + "method": "DELETE", + "uri": "/connect-peers/{ConnectPeerId}", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.networkmanager#GetNetworkResourcesRequest": { + "com.amazonaws.networkmanager#DeleteConnectPeerRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "ConnectPeerId": { + "target": "com.amazonaws.networkmanager#ConnectPeerId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#documentation": "

The ID of the deleted Connect peer.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "RegisteredGatewayArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ARN of the gateway.

", - "smithy.api#httpQuery": "registeredGatewayArn" - } - }, - "AwsRegion": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region.

", - "smithy.api#httpQuery": "awsRegion" - } - }, - "AccountId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpQuery": "accountId" - } - }, - "ResourceType": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n \n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection - The definition model is\n Connection.

    \n
  • \n
  • \n

    \n device - The definition model is\n Device.

    \n
  • \n
  • \n

    \n link - The definition model is\n Link.

    \n
  • \n
  • \n

    \n site - The definition model is\n Site.

    \n
  • \n
\n \n

The following are the supported resource types for Amazon VPC:

\n ", - "smithy.api#httpQuery": "resourceType" - } - }, - "ResourceArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", - "smithy.api#httpQuery": "resourceArn" - } - }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" - } } } }, - "com.amazonaws.networkmanager#GetNetworkResourcesResponse": { + "com.amazonaws.networkmanager#DeleteConnectPeerResponse": { "type": "structure", "members": { - "NetworkResources": { - "target": "com.amazonaws.networkmanager#NetworkResourceList", - "traits": { - "smithy.api#documentation": "

The network resources.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "ConnectPeer": { + "target": "com.amazonaws.networkmanager#ConnectPeer", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Information about the deleted Connect peer.

" } } } }, - "com.amazonaws.networkmanager#GetNetworkRoutes": { + "com.amazonaws.networkmanager#DeleteConnection": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetNetworkRoutesRequest" + "target": "com.amazonaws.networkmanager#DeleteConnectionRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetNetworkRoutesResponse" + "target": "com.amazonaws.networkmanager#DeleteConnectionResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, @@ -2777,123 +3000,191 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the network routes of the specified global network.

", + "smithy.api#documentation": "

Deletes the specified connection in your global network.

", "smithy.api#http": { - "method": "POST", - "uri": "/global-networks/{GlobalNetworkId}/network-routes", + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/connections/{ConnectionId}", "code": 200 } } }, - "com.amazonaws.networkmanager#GetNetworkRoutesRequest": { + "com.amazonaws.networkmanager#DeleteConnectionRequest": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RouteTableIdentifier": { - "target": "com.amazonaws.networkmanager#RouteTableIdentifier", + "ConnectionId": { + "target": "com.amazonaws.networkmanager#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#documentation": "

The ID of the connection.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "ExactCidrMatches": { - "target": "com.amazonaws.networkmanager#StringList", + } + } + }, + "com.amazonaws.networkmanager#DeleteConnectionResponse": { + "type": "structure", + "members": { + "Connection": { + "target": "com.amazonaws.networkmanager#Connection", "traits": { - "smithy.api#documentation": "

An exact CIDR block.

" + "smithy.api#documentation": "

Information about the connection.

" } + } + } + }, + "com.amazonaws.networkmanager#DeleteCoreNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DeleteCoreNetworkRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DeleteCoreNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" }, - "LongestPrefixMatches": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

The most specific route that matches the traffic (longest prefix match).

" - } + { + "target": "com.amazonaws.networkmanager#ConflictException" }, - "SubnetOfMatches": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

The routes with a subnet that match the specified CIDR filter.

" - } + { + "target": "com.amazonaws.networkmanager#InternalServerException" }, - "SupernetOfMatches": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

" - } + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" }, - "PrefixListIds": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

The IDs of the prefix lists.

" - } + { + "target": "com.amazonaws.networkmanager#ThrottlingException" }, - "States": { - "target": "com.amazonaws.networkmanager#RouteStateList", - "traits": { - "smithy.api#documentation": "

The route states.

" - } + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/core-networks/{CoreNetworkId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DeleteCoreNetworkPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DeleteCoreNetworkPolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DeleteCoreNetworkPolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" }, - "Types": { - "target": "com.amazonaws.networkmanager#RouteTypeList", + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a policy version from a core network. You can't delete the current LIVE policy.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/core-networks/{CoreNetworkId}/core-network-policy-versions/{PolicyVersionId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DeleteCoreNetworkPolicyVersionRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The route types.

" + "smithy.api#documentation": "

The ID of a core network for the deleted policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "DestinationFilters": { - "target": "com.amazonaws.networkmanager#FilterMap", + "PolicyVersionId": { + "target": "com.amazonaws.networkmanager#Integer", "traits": { - "smithy.api#documentation": "

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

" + "smithy.api#documentation": "

The version ID of the deleted policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } }, - "com.amazonaws.networkmanager#GetNetworkRoutesResponse": { + "com.amazonaws.networkmanager#DeleteCoreNetworkPolicyVersionResponse": { "type": "structure", "members": { - "RouteTableArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ARN of the route table.

" - } - }, - "RouteTableType": { - "target": "com.amazonaws.networkmanager#RouteTableType", + "CoreNetworkPolicy": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicy", "traits": { - "smithy.api#documentation": "

The route table type.

" + "smithy.api#documentation": "

Returns information about the deleted policy version.

" } - }, - "RouteTableTimestamp": { - "target": "com.amazonaws.networkmanager#DateTime", + } + } + }, + "com.amazonaws.networkmanager#DeleteCoreNetworkRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The route table creation time.

" + "smithy.api#documentation": "

The network ID of the deleted core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "NetworkRoutes": { - "target": "com.amazonaws.networkmanager#NetworkRouteList", + } + } + }, + "com.amazonaws.networkmanager#DeleteCoreNetworkResponse": { + "type": "structure", + "members": { + "CoreNetwork": { + "target": "com.amazonaws.networkmanager#CoreNetwork", "traits": { - "smithy.api#documentation": "

The network routes.

" + "smithy.api#documentation": "

Information about the deleted core network.

" } } } }, - "com.amazonaws.networkmanager#GetNetworkTelemetry": { + "com.amazonaws.networkmanager#DeleteDevice": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetNetworkTelemetryRequest" + "target": "com.amazonaws.networkmanager#DeleteDeviceRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetNetworkTelemetryResponse" + "target": "com.amazonaws.networkmanager#DeleteDeviceResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, @@ -2908,110 +3199,61 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the network telemetry of the specified global network.

", + "smithy.api#documentation": "

Deletes an existing device. You must first disassociate the device from any links and\n customer gateways.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/network-telemetry", + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/devices/{DeviceId}", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.networkmanager#GetNetworkTelemetryRequest": { + "com.amazonaws.networkmanager#DeleteDeviceRequest": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RegisteredGatewayArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ARN of the gateway.

", - "smithy.api#httpQuery": "registeredGatewayArn" - } - }, - "AwsRegion": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region.

", - "smithy.api#httpQuery": "awsRegion" - } - }, - "AccountId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpQuery": "accountId" - } - }, - "ResourceType": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n
    \n
  • \n

    \n dxcon\n

    \n
  • \n
  • \n

    \n dx-gateway\n

    \n
  • \n
  • \n

    \n dx-vif\n

    \n
  • \n
\n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection\n

    \n
  • \n
  • \n

    \n device\n

    \n
  • \n
  • \n

    \n link\n

    \n
  • \n
  • \n

    \n site\n

    \n
  • \n
\n\n

The following are the supported resource types for Amazon VPC:

\n
    \n
  • \n

    \n customer-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway-attachment\n

    \n
  • \n
  • \n

    \n transit-gateway-connect-peer\n

    \n
  • \n
  • \n

    \n transit-gateway-route-table\n

    \n
  • \n
  • \n

    \n vpn-connection\n

    \n
  • \n
", - "smithy.api#httpQuery": "resourceType" - } - }, - "ResourceArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", - "smithy.api#httpQuery": "resourceArn" - } - }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The ID of the device.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } } }, - "com.amazonaws.networkmanager#GetNetworkTelemetryResponse": { + "com.amazonaws.networkmanager#DeleteDeviceResponse": { "type": "structure", "members": { - "NetworkTelemetry": { - "target": "com.amazonaws.networkmanager#NetworkTelemetryList", - "traits": { - "smithy.api#documentation": "

The network telemetry.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "Device": { + "target": "com.amazonaws.networkmanager#Device", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Information about the device.

" } } } }, - "com.amazonaws.networkmanager#GetRouteAnalysis": { + "com.amazonaws.networkmanager#DeleteGlobalNetwork": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetRouteAnalysisRequest" + "target": "com.amazonaws.networkmanager#DeleteGlobalNetworkRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetRouteAnalysisResponse" + "target": "com.amazonaws.networkmanager#DeleteGlobalNetworkResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, @@ -3026,53 +3268,3298 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the specified route analysis.

", + "smithy.api#documentation": "

Deletes an existing global network. You must first delete all global network objects\n (devices, links, and sites) and deregister all transit gateways.

", "smithy.api#http": { - "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/route-analyses/{RouteAnalysisId}", + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}", "code": 200 } } }, - "com.amazonaws.networkmanager#GetRouteAnalysisRequest": { + "com.amazonaws.networkmanager#DeleteGlobalNetworkRequest": { "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "RouteAnalysisId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the route analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, - "com.amazonaws.networkmanager#GetRouteAnalysisResponse": { + "com.amazonaws.networkmanager#DeleteGlobalNetworkResponse": { "type": "structure", "members": { - "RouteAnalysis": { - "target": "com.amazonaws.networkmanager#RouteAnalysis", + "GlobalNetwork": { + "target": "com.amazonaws.networkmanager#GlobalNetwork", "traits": { - "smithy.api#documentation": "

The route analysis.

" + "smithy.api#documentation": "

Information about the global network.

" + } + } + } + }, + "com.amazonaws.networkmanager#DeleteLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DeleteLinkRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DeleteLinkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing link. You must first disassociate the link from any devices and\n customer gateways.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/links/{LinkId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DeleteLinkRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", + "traits": { + "smithy.api#documentation": "

The ID of the link.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DeleteLinkResponse": { + "type": "structure", + "members": { + "Link": { + "target": "com.amazonaws.networkmanager#Link", + "traits": { + "smithy.api#documentation": "

Information about the link.

" + } + } + } + }, + "com.amazonaws.networkmanager#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/resource-policy/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the policy to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.networkmanager#DeleteSite": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DeleteSiteRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DeleteSiteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing site. The site cannot be associated with any device or link.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/sites/{SiteId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DeleteSiteRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SiteId": { + "target": "com.amazonaws.networkmanager#SiteId", + "traits": { + "smithy.api#documentation": "

The ID of the site.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DeleteSiteResponse": { + "type": "structure", + "members": { + "Site": { + "target": "com.amazonaws.networkmanager#Site", + "traits": { + "smithy.api#documentation": "

Information about the site.

" + } + } + } + }, + "com.amazonaws.networkmanager#DeregisterTransitGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DeregisterTransitGatewayRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DeregisterTransitGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deregisters a transit gateway from your global network. This action does not delete\n your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/transit-gateway-registrations/{TransitGatewayArn}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DeregisterTransitGatewayRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TransitGatewayArn": { + "target": "com.amazonaws.networkmanager#TransitGatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DeregisterTransitGatewayResponse": { + "type": "structure", + "members": { + "TransitGatewayRegistration": { + "target": "com.amazonaws.networkmanager#TransitGatewayRegistration", + "traits": { + "smithy.api#documentation": "

The transit gateway registration information.

" + } + } + } + }, + "com.amazonaws.networkmanager#DescribeGlobalNetworks": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DescribeGlobalNetworksRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DescribeGlobalNetworksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes one or more global networks. By default, all global networks are\n described. To describe the objects in your global network, you must use the appropriate\n Get* action. For example, to list the transit gateways in your global\n network, use GetTransitGatewayRegistrations.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#DescribeGlobalNetworksRequest": { + "type": "structure", + "members": { + "GlobalNetworkIds": { + "target": "com.amazonaws.networkmanager#GlobalNetworkIdList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more global networks. The maximum is 10.

", + "smithy.api#httpQuery": "globalNetworkIds" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#DescribeGlobalNetworksResponse": { + "type": "structure", + "members": { + "GlobalNetworks": { + "target": "com.amazonaws.networkmanager#GlobalNetworkList", + "traits": { + "smithy.api#documentation": "

Information about the global networks.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#Device": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the device.

" + } + }, + "DeviceArn": { + "target": "com.amazonaws.networkmanager#DeviceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device.

" + } + }, + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

" + } + }, + "AWSLocation": { + "target": "com.amazonaws.networkmanager#AWSLocation", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services location of the device.

" + } + }, + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The description of the device.

" + } + }, + "Type": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The device type.

" + } + }, + "Vendor": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The device vendor.

" + } + }, + "Model": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The device model.

" + } + }, + "SerialNumber": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The device serial number.

" + } + }, + "Location": { + "target": "com.amazonaws.networkmanager#Location", + "traits": { + "smithy.api#documentation": "

The site location.

" + } + }, + "SiteId": { + "target": "com.amazonaws.networkmanager#SiteId", + "traits": { + "smithy.api#documentation": "

The site ID.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that the site was created.

" + } + }, + "State": { + "target": "com.amazonaws.networkmanager#DeviceState", + "traits": { + "smithy.api#documentation": "

The device state.

" + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The tags for the device.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a device.

" + } + }, + "com.amazonaws.networkmanager#DeviceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#DeviceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#DeviceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#DeviceId" + } + }, + "com.amazonaws.networkmanager#DeviceList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#Device" + } + }, + "com.amazonaws.networkmanager#DeviceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "pending" + }, + { + "value": "AVAILABLE", + "name": "available" + }, + { + "value": "DELETING", + "name": "deleting" + }, + { + "value": "UPDATING", + "name": "updating" + } + ] + } + }, + "com.amazonaws.networkmanager#DisassociateConnectPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DisassociateConnectPeerRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DisassociateConnectPeerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a core network Connect peer from a device and a link.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/connect-peer-associations/{ConnectPeerId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DisassociateConnectPeerRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectPeerId": { + "target": "com.amazonaws.networkmanager#ConnectPeerId", + "traits": { + "smithy.api#documentation": "

The ID of the Connect peer to disassociate from a device.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DisassociateConnectPeerResponse": { + "type": "structure", + "members": { + "ConnectPeerAssociation": { + "target": "com.amazonaws.networkmanager#ConnectPeerAssociation", + "traits": { + "smithy.api#documentation": "

Describes the Connect peer association.

" + } + } + } + }, + "com.amazonaws.networkmanager#DisassociateCustomerGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DisassociateCustomerGatewayRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DisassociateCustomerGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a customer gateway from a device and a link.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/customer-gateway-associations/{CustomerGatewayArn}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DisassociateCustomerGatewayRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CustomerGatewayArn": { + "target": "com.amazonaws.networkmanager#CustomerGatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer gateway.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DisassociateCustomerGatewayResponse": { + "type": "structure", + "members": { + "CustomerGatewayAssociation": { + "target": "com.amazonaws.networkmanager#CustomerGatewayAssociation", + "traits": { + "smithy.api#documentation": "

Information about the customer gateway association.

" + } + } + } + }, + "com.amazonaws.networkmanager#DisassociateLink": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DisassociateLinkRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DisassociateLinkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an existing device from a link. You must first disassociate any customer\n gateways that are associated with the link.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/link-associations", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DisassociateLinkRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the device.

", + "smithy.api#httpQuery": "deviceId", + "smithy.api#required": {} + } + }, + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", + "traits": { + "smithy.api#documentation": "

The ID of the link.

", + "smithy.api#httpQuery": "linkId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DisassociateLinkResponse": { + "type": "structure", + "members": { + "LinkAssociation": { + "target": "com.amazonaws.networkmanager#LinkAssociation", + "traits": { + "smithy.api#documentation": "

Information about the link association.

" + } + } + } + }, + "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeerRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a transit gateway Connect peer from a device and link.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/global-networks/{GlobalNetworkId}/transit-gateway-connect-peer-associations/{TransitGatewayConnectPeerArn}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeerRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TransitGatewayConnectPeerArn": { + "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeerResponse": { + "type": "structure", + "members": { + "TransitGatewayConnectPeerAssociation": { + "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerAssociation", + "traits": { + "smithy.api#documentation": "

The transit gateway Connect peer association.

" + } + } + } + }, + "com.amazonaws.networkmanager#ExceptionContextKey": { + "type": "string" + }, + "com.amazonaws.networkmanager#ExceptionContextMap": { + "type": "map", + "key": { + "target": "com.amazonaws.networkmanager#ExceptionContextKey" + }, + "value": { + "target": "com.amazonaws.networkmanager#ExceptionContextValue" + } + }, + "com.amazonaws.networkmanager#ExceptionContextValue": { + "type": "string" + }, + "com.amazonaws.networkmanager#ExecuteCoreNetworkChangeSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#ExecuteCoreNetworkChangeSetRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#ExecuteCoreNetworkChangeSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Executes a change set on your core network. Deploys changes globally based on the policy submitted..

", + "smithy.api#http": { + "method": "POST", + "uri": "/core-networks/{CoreNetworkId}/core-network-change-sets/{PolicyVersionId}/execute", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#ExecuteCoreNetworkChangeSetRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PolicyVersionId": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

The ID of the policy version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#ExecuteCoreNetworkChangeSetResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.networkmanager#ExternalRegionCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.networkmanager#ExternalRegionCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode" + } + }, + "com.amazonaws.networkmanager#FilterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.networkmanager#FilterName" + }, + "value": { + "target": "com.amazonaws.networkmanager#FilterValues" + } + }, + "com.amazonaws.networkmanager#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[0-9a-zA-Z\\.-]*$" + } + }, + "com.amazonaws.networkmanager#FilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[0-9a-zA-Z\\*\\.\\\\/\\?-]*$" + } + }, + "com.amazonaws.networkmanager#FilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#FilterValue" + } + }, + "com.amazonaws.networkmanager#GetConnectAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetConnectAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetConnectAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a core network Connect attachment.

", + "smithy.api#http": { + "method": "GET", + "uri": "/connect-attachments/{AttachmentId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetConnectAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetConnectAttachmentResponse": { + "type": "structure", + "members": { + "ConnectAttachment": { + "target": "com.amazonaws.networkmanager#ConnectAttachment", + "traits": { + "smithy.api#documentation": "

Details about the Connect attachment.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetConnectPeer": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetConnectPeerRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetConnectPeerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a core network Connect peer.

", + "smithy.api#http": { + "method": "GET", + "uri": "/connect-peers/{ConnectPeerId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetConnectPeerAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetConnectPeerAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetConnectPeerAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a core network Connect peer associations.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/connect-peer-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetConnectPeerAssociationsRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectPeerIds": { + "target": "com.amazonaws.networkmanager#ConnectPeerIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the Connect peers.

", + "smithy.api#httpQuery": "connectPeerIds" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetConnectPeerAssociationsResponse": { + "type": "structure", + "members": { + "ConnectPeerAssociations": { + "target": "com.amazonaws.networkmanager#ConnectPeerAssociationList", + "traits": { + "smithy.api#documentation": "

Displays a list of Connect peer associations.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetConnectPeerRequest": { + "type": "structure", + "members": { + "ConnectPeerId": { + "target": "com.amazonaws.networkmanager#ConnectPeerId", + "traits": { + "smithy.api#documentation": "

The ID of the Connect peer.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetConnectPeerResponse": { + "type": "structure", + "members": { + "ConnectPeer": { + "target": "com.amazonaws.networkmanager#ConnectPeer", + "traits": { + "smithy.api#documentation": "

Returns information about a core network Connect peer.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more of your connections in a global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/connections", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetConnectionsRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectionIds": { + "target": "com.amazonaws.networkmanager#ConnectionIdList", + "traits": { + "smithy.api#documentation": "

One or more connection IDs.

", + "smithy.api#httpQuery": "connectionIds" + } + }, + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the device.

", + "smithy.api#httpQuery": "deviceId" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetConnectionsResponse": { + "type": "structure", + "members": { + "Connections": { + "target": "com.amazonaws.networkmanager#ConnectionList", + "traits": { + "smithy.api#documentation": "

Information about the connections.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetCoreNetworkRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetCoreNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a core network. By default it returns the LIVE policy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/core-networks/{CoreNetworkId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkChangeSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetCoreNetworkChangeSetRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetCoreNetworkChangeSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a change set between the LIVE core network policy and a submitted policy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/core-networks/{CoreNetworkId}/core-network-change-sets/{PolicyVersionId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkChangeSetRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PolicyVersionId": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

The ID of the policy version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkChangeSetResponse": { + "type": "structure", + "members": { + "CoreNetworkChanges": { + "target": "com.amazonaws.networkmanager#CoreNetworkChangeList", + "traits": { + "smithy.api#documentation": "

Describes a core network changes.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetCoreNetworkPolicyRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetCoreNetworkPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a core network policy. You can get details about your current live policy or any previous policy version.

", + "smithy.api#http": { + "method": "GET", + "uri": "/core-networks/{CoreNetworkId}/core-network-policy", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkPolicyRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PolicyVersionId": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

The ID of a core network policy version.

", + "smithy.api#httpQuery": "policyVersionId" + } + }, + "Alias": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyAlias", + "traits": { + "smithy.api#documentation": "

The alias of a core network policy

", + "smithy.api#httpQuery": "alias" + } + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkPolicyResponse": { + "type": "structure", + "members": { + "CoreNetworkPolicy": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicy", + "traits": { + "smithy.api#documentation": "

The details about a core network policy.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkResponse": { + "type": "structure", + "members": { + "CoreNetwork": { + "target": "com.amazonaws.networkmanager#CoreNetwork", + "traits": { + "smithy.api#documentation": "

Details about a core network.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetCustomerGatewayAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the association information for customer gateways that are associated with\n devices and links in your global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/customer-gateway-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CustomerGatewayArns": { + "target": "com.amazonaws.networkmanager#CustomerGatewayArnList", + "traits": { + "smithy.api#documentation": "

One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

", + "smithy.api#httpQuery": "customerGatewayArns" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetCustomerGatewayAssociationsResponse": { + "type": "structure", + "members": { + "CustomerGatewayAssociations": { + "target": "com.amazonaws.networkmanager#CustomerGatewayAssociationList", + "traits": { + "smithy.api#documentation": "

The customer gateway associations.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetDevicesRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetDevicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more of your devices in a global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/devices", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetDevicesRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeviceIds": { + "target": "com.amazonaws.networkmanager#DeviceIdList", + "traits": { + "smithy.api#documentation": "

One or more device IDs. The maximum is 10.

", + "smithy.api#httpQuery": "deviceIds" + } + }, + "SiteId": { + "target": "com.amazonaws.networkmanager#SiteId", + "traits": { + "smithy.api#documentation": "

The ID of the site.

", + "smithy.api#httpQuery": "siteId" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetDevicesResponse": { + "type": "structure", + "members": { + "Devices": { + "target": "com.amazonaws.networkmanager#DeviceList", + "traits": { + "smithy.api#documentation": "

The devices.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetLinkAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetLinkAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetLinkAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the link associations for a device or a link. Either the device ID or the link ID\n must be specified.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/link-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetLinkAssociationsRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the device.

", + "smithy.api#httpQuery": "deviceId" + } + }, + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", + "traits": { + "smithy.api#documentation": "

The ID of the link.

", + "smithy.api#httpQuery": "linkId" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetLinkAssociationsResponse": { + "type": "structure", + "members": { + "LinkAssociations": { + "target": "com.amazonaws.networkmanager#LinkAssociationList", + "traits": { + "smithy.api#documentation": "

The link associations.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetLinks": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetLinksRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetLinksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more links in a specified global network.

\n

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/links", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetLinksRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LinkIds": { + "target": "com.amazonaws.networkmanager#LinkIdList", + "traits": { + "smithy.api#documentation": "

One or more link IDs. The maximum is 10.

", + "smithy.api#httpQuery": "linkIds" + } + }, + "SiteId": { + "target": "com.amazonaws.networkmanager#SiteId", + "traits": { + "smithy.api#documentation": "

The ID of the site.

", + "smithy.api#httpQuery": "siteId" + } + }, + "Type": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The link type.

", + "smithy.api#httpQuery": "type" + } + }, + "Provider": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The link provider.

", + "smithy.api#httpQuery": "provider" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetLinksResponse": { + "type": "structure", + "members": { + "Links": { + "target": "com.amazonaws.networkmanager#LinkList", + "traits": { + "smithy.api#documentation": "

The links.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResourceCounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetNetworkResourceCountsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetNetworkResourceCountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the count of network resources, by resource type, for the specified global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/network-resource-count", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResourceCountsRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n
    \n
  • \n

    \n dxcon\n

    \n
  • \n
  • \n

    \n dx-gateway\n

    \n
  • \n
  • \n

    \n dx-vif\n

    \n
  • \n
\n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection\n

    \n
  • \n
  • \n

    \n device\n

    \n
  • \n
  • \n

    \n link\n

    \n
  • \n
  • \n

    \n site\n

    \n
  • \n
\n\n

The following are the supported resource types for Amazon VPC:

\n
    \n
  • \n

    \n customer-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway-attachment\n

    \n
  • \n
  • \n

    \n transit-gateway-connect-peer\n

    \n
  • \n
  • \n

    \n transit-gateway-route-table\n

    \n
  • \n
  • \n

    \n vpn-connection\n

    \n
  • \n
", + "smithy.api#httpQuery": "resourceType" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResourceCountsResponse": { + "type": "structure", + "members": { + "NetworkResourceCounts": { + "target": "com.amazonaws.networkmanager#NetworkResourceCountList", + "traits": { + "smithy.api#documentation": "

The count of resources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResourceRelationships": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetNetworkResourceRelationshipsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetNetworkResourceRelationshipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the network resource relationships for the specified global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/network-resource-relationships", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResourceRelationshipsRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpQuery": "coreNetworkId" + } + }, + "RegisteredGatewayArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the registered gateway.

", + "smithy.api#httpQuery": "registeredGatewayArn" + } + }, + "AwsRegion": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region.

", + "smithy.api#httpQuery": "awsRegion" + } + }, + "AccountId": { + "target": "com.amazonaws.networkmanager#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpQuery": "accountId" + } + }, + "ResourceType": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n
    \n
  • \n

    \n dxcon\n

    \n
  • \n
  • \n

    \n dx-gateway\n

    \n
  • \n
  • \n

    \n dx-vif\n

    \n
  • \n
\n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection\n

    \n
  • \n
  • \n

    \n device\n

    \n
  • \n
  • \n

    \n link\n

    \n
  • \n
  • \n

    \n site\n

    \n
  • \n
\n\n

The following are the supported resource types for Amazon VPC:

\n
    \n
  • \n

    \n customer-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway-attachment\n

    \n
  • \n
  • \n

    \n transit-gateway-connect-peer\n

    \n
  • \n
  • \n

    \n transit-gateway-route-table\n

    \n
  • \n
  • \n

    \n vpn-connection\n

    \n
  • \n
", + "smithy.api#httpQuery": "resourceType" + } + }, + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the gateway.

", + "smithy.api#httpQuery": "resourceArn" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResourceRelationshipsResponse": { + "type": "structure", + "members": { + "Relationships": { + "target": "com.amazonaws.networkmanager#RelationshipList", + "traits": { + "smithy.api#documentation": "

The resource relationships.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetNetworkResourcesRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetNetworkResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the network resources for the specified global network.

\n

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/network-resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResourcesRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpQuery": "coreNetworkId" + } + }, + "RegisteredGatewayArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the gateway.

", + "smithy.api#httpQuery": "registeredGatewayArn" + } + }, + "AwsRegion": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region.

", + "smithy.api#httpQuery": "awsRegion" + } + }, + "AccountId": { + "target": "com.amazonaws.networkmanager#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpQuery": "accountId" + } + }, + "ResourceType": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n \n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection - The definition model is\n Connection.

    \n
  • \n
  • \n

    \n device - The definition model is\n Device.

    \n
  • \n
  • \n

    \n link - The definition model is\n Link.

    \n
  • \n
  • \n

    \n site - The definition model is\n Site.

    \n
  • \n
\n \n

The following are the supported resource types for Amazon VPC:

\n ", + "smithy.api#httpQuery": "resourceType" + } + }, + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpQuery": "resourceArn" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkResourcesResponse": { + "type": "structure", + "members": { + "NetworkResources": { + "target": "com.amazonaws.networkmanager#NetworkResourceList", + "traits": { + "smithy.api#documentation": "

The network resources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkRoutes": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetNetworkRoutesRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetNetworkRoutesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the network routes of the specified global network.

", + "smithy.api#http": { + "method": "POST", + "uri": "/global-networks/{GlobalNetworkId}/network-routes", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetNetworkRoutesRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteTableIdentifier": { + "target": "com.amazonaws.networkmanager#RouteTableIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {} + } + }, + "ExactCidrMatches": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

An exact CIDR block.

" + } + }, + "LongestPrefixMatches": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

The most specific route that matches the traffic (longest prefix match).

" + } + }, + "SubnetOfMatches": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

The routes with a subnet that match the specified CIDR filter.

" + } + }, + "SupernetOfMatches": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

" + } + }, + "PrefixListIds": { + "target": "com.amazonaws.networkmanager#ConstrainedStringList", + "traits": { + "smithy.api#documentation": "

The IDs of the prefix lists.

" + } + }, + "States": { + "target": "com.amazonaws.networkmanager#RouteStateList", + "traits": { + "smithy.api#documentation": "

The route states.

" + } + }, + "Types": { + "target": "com.amazonaws.networkmanager#RouteTypeList", + "traits": { + "smithy.api#documentation": "

The route types.

" + } + }, + "DestinationFilters": { + "target": "com.amazonaws.networkmanager#FilterMap", + "traits": { + "smithy.api#documentation": "

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkRoutesResponse": { + "type": "structure", + "members": { + "RouteTableArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the route table.

" + } + }, + "CoreNetworkSegmentEdge": { + "target": "com.amazonaws.networkmanager#CoreNetworkSegmentEdgeIdentifier", + "traits": { + "smithy.api#documentation": "

Describes a core network segment edge.

" + } + }, + "RouteTableType": { + "target": "com.amazonaws.networkmanager#RouteTableType", + "traits": { + "smithy.api#documentation": "

The route table type.

" + } + }, + "RouteTableTimestamp": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The route table creation time.

" + } + }, + "NetworkRoutes": { + "target": "com.amazonaws.networkmanager#NetworkRouteList", + "traits": { + "smithy.api#documentation": "

The network routes.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkTelemetry": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetNetworkTelemetryRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetNetworkTelemetryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the network telemetry of the specified global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/network-telemetry", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetNetworkTelemetryRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpQuery": "coreNetworkId" + } + }, + "RegisteredGatewayArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the gateway.

", + "smithy.api#httpQuery": "registeredGatewayArn" + } + }, + "AwsRegion": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region.

", + "smithy.api#httpQuery": "awsRegion" + } + }, + "AccountId": { + "target": "com.amazonaws.networkmanager#AWSAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpQuery": "accountId" + } + }, + "ResourceType": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n
    \n
  • \n

    \n dxcon\n

    \n
  • \n
  • \n

    \n dx-gateway\n

    \n
  • \n
  • \n

    \n dx-vif\n

    \n
  • \n
\n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection\n

    \n
  • \n
  • \n

    \n device\n

    \n
  • \n
  • \n

    \n link\n

    \n
  • \n
  • \n

    \n site\n

    \n
  • \n
\n\n

The following are the supported resource types for Amazon VPC:

\n
    \n
  • \n

    \n customer-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway-attachment\n

    \n
  • \n
  • \n

    \n transit-gateway-connect-peer\n

    \n
  • \n
  • \n

    \n transit-gateway-route-table\n

    \n
  • \n
  • \n

    \n vpn-connection\n

    \n
  • \n
", + "smithy.api#httpQuery": "resourceType" + } + }, + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpQuery": "resourceArn" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetNetworkTelemetryResponse": { + "type": "structure", + "members": { + "NetworkTelemetry": { + "target": "com.amazonaws.networkmanager#NetworkTelemetryList", + "traits": { + "smithy.api#documentation": "

The network telemetry.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a resource policy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/resource-policy/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "PolicyDocument": { + "target": "com.amazonaws.networkmanager#SynthesizedJsonResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The resource policy document.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetRouteAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetRouteAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetRouteAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the specified route analysis.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/route-analyses/{RouteAnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetRouteAnalysisRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RouteAnalysisId": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The ID of the route analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetRouteAnalysisResponse": { + "type": "structure", + "members": { + "RouteAnalysis": { + "target": "com.amazonaws.networkmanager#RouteAnalysis", + "traits": { + "smithy.api#documentation": "

The route analysis.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetSiteToSiteVpnAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetSiteToSiteVpnAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetSiteToSiteVpnAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a site-to-site VPN attachment.

", + "smithy.api#http": { + "method": "GET", + "uri": "/site-to-site-vpn-attachments/{AttachmentId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetSiteToSiteVpnAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetSiteToSiteVpnAttachmentResponse": { + "type": "structure", + "members": { + "SiteToSiteVpnAttachment": { + "target": "com.amazonaws.networkmanager#SiteToSiteVpnAttachment", + "traits": { + "smithy.api#documentation": "

Describes the site-to-site attachment.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetSites": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetSitesRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetSitesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more of your sites in a global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/sites", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetSitesRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SiteIds": { + "target": "com.amazonaws.networkmanager#SiteIdList", + "traits": { + "smithy.api#documentation": "

One or more site IDs. The maximum is 10.

", + "smithy.api#httpQuery": "siteIds" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetSitesResponse": { + "type": "structure", + "members": { + "Sites": { + "target": "com.amazonaws.networkmanager#SiteList", + "traits": { + "smithy.api#documentation": "

The sites.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about one or more of your transit gateway Connect peer associations in a global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/transit-gateway-connect-peer-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociationsRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TransitGatewayConnectPeerArns": { + "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerArnList", + "traits": { + "smithy.api#documentation": "

One or more transit gateway Connect peer Amazon Resource Names (ARNs).

", + "smithy.api#httpQuery": "transitGatewayConnectPeerArns" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociationsResponse": { + "type": "structure", + "members": { + "TransitGatewayConnectPeerAssociations": { + "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerAssociationList", + "traits": { + "smithy.api#documentation": "

Information about the transit gateway Connect peer associations.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayRegistrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the transit gateway registrations in a specified\n global network.

", + "smithy.api#http": { + "method": "GET", + "uri": "/global-networks/{GlobalNetworkId}/transit-gateway-registrations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsRequest": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TransitGatewayArns": { + "target": "com.amazonaws.networkmanager#TransitGatewayArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is\n 10.

", + "smithy.api#httpQuery": "transitGatewayArns" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsResponse": { + "type": "structure", + "members": { + "TransitGatewayRegistrations": { + "target": "com.amazonaws.networkmanager#TransitGatewayRegistrationList", + "traits": { + "smithy.api#documentation": "

The transit gateway registrations.

" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + } + } + }, + "com.amazonaws.networkmanager#GetVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetVpcAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a VPC attachment.

", + "smithy.api#http": { + "method": "GET", + "uri": "/vpc-attachments/{AttachmentId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetVpcAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetVpcAttachmentResponse": { + "type": "structure", + "members": { + "VpcAttachment": { + "target": "com.amazonaws.networkmanager#VpcAttachment", + "traits": { + "smithy.api#documentation": "

Returns details about a VPC attachment.

" + } + } + } + }, + "com.amazonaws.networkmanager#GlobalNetwork": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

" + } + }, + "GlobalNetworkArn": { + "target": "com.amazonaws.networkmanager#GlobalNetworkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the global network.

" + } + }, + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The description of the global network.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that the global network was created.

" + } + }, + "State": { + "target": "com.amazonaws.networkmanager#GlobalNetworkState", + "traits": { + "smithy.api#documentation": "

The state of the global network.

" + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The tags for the global network.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-manged Core Network.

" + } + }, + "com.amazonaws.networkmanager#GlobalNetworkArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#GlobalNetworkId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#GlobalNetworkIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId" + } + }, + "com.amazonaws.networkmanager#GlobalNetworkList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#GlobalNetwork" + } + }, + "com.amazonaws.networkmanager#GlobalNetworkState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "pending" + }, + { + "value": "AVAILABLE", + "name": "available" + }, + { + "value": "DELETING", + "name": "deleting" + }, + { + "value": "UPDATING", + "name": "updating" + } + ] + } + }, + "com.amazonaws.networkmanager#IPAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#Integer": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.networkmanager#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#required": {} + } + }, + "RetryAfterSeconds": { + "target": "com.amazonaws.networkmanager#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "

Indicates when to retry the request.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request has failed due to an internal error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.networkmanager#Link": { + "type": "structure", + "members": { + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", + "traits": { + "smithy.api#documentation": "

The ID of the link.

" + } + }, + "LinkArn": { + "target": "com.amazonaws.networkmanager#LinkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the link.

" + } + }, + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

" + } + }, + "SiteId": { + "target": "com.amazonaws.networkmanager#SiteId", + "traits": { + "smithy.api#documentation": "

The ID of the site.

" + } + }, + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The description of the link.

" + } + }, + "Type": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The type of the link.

" + } + }, + "Bandwidth": { + "target": "com.amazonaws.networkmanager#Bandwidth", + "traits": { + "smithy.api#documentation": "

The bandwidth for the link.

" + } + }, + "Provider": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The provider of the link.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that the link was created.

" + } + }, + "State": { + "target": "com.amazonaws.networkmanager#LinkState", + "traits": { + "smithy.api#documentation": "

The state of the link.

" + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The tags for the link.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a link.

" + } + }, + "com.amazonaws.networkmanager#LinkArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#LinkAssociation": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "target": "com.amazonaws.networkmanager#GlobalNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of the global network.

" + } + }, + "DeviceId": { + "target": "com.amazonaws.networkmanager#DeviceId", + "traits": { + "smithy.api#documentation": "

The device ID for the link association.

" + } + }, + "LinkId": { + "target": "com.amazonaws.networkmanager#LinkId", + "traits": { + "smithy.api#documentation": "

The ID of the link.

" + } + }, + "LinkAssociationState": { + "target": "com.amazonaws.networkmanager#LinkAssociationState", + "traits": { + "smithy.api#documentation": "

The state of the association.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the association between a device and a link.

" + } + }, + "com.amazonaws.networkmanager#LinkAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#LinkAssociation" + } + }, + "com.amazonaws.networkmanager#LinkAssociationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "pending" + }, + { + "value": "AVAILABLE", + "name": "available" + }, + { + "value": "DELETING", + "name": "deleting" + }, + { + "value": "DELETED", + "name": "deleted" + } + ] + } + }, + "com.amazonaws.networkmanager#LinkId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#LinkIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#LinkId" + } + }, + "com.amazonaws.networkmanager#LinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#Link" + } + }, + "com.amazonaws.networkmanager#LinkState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "pending" + }, + { + "value": "AVAILABLE", + "name": "available" + }, + { + "value": "DELETING", + "name": "deleting" + }, + { + "value": "UPDATING", + "name": "updating" } - } + ] } }, - "com.amazonaws.networkmanager#GetSites": { + "com.amazonaws.networkmanager#ListAttachments": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetSitesRequest" + "target": "com.amazonaws.networkmanager#ListAttachmentsRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetSitesResponse" + "target": "com.amazonaws.networkmanager#ListAttachmentsResponse" }, "errors": [ { @@ -3081,9 +6568,6 @@ { "target": "com.amazonaws.networkmanager#InternalServerException" }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" - }, { "target": "com.amazonaws.networkmanager#ThrottlingException" }, @@ -3092,10 +6576,10 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about one or more of your sites in a global network.

", + "smithy.api#documentation": "

Returns a list of core network attachments.

", "smithy.api#http": { "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/sites", + "uri": "/attachments", "code": 200 }, "smithy.api#paginated": { @@ -3105,22 +6589,35 @@ } } }, - "com.amazonaws.networkmanager#GetSitesRequest": { + "com.amazonaws.networkmanager#ListAttachmentsRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpQuery": "coreNetworkId" } }, - "SiteIds": { - "target": "com.amazonaws.networkmanager#StringList", + "AttachmentType": { + "target": "com.amazonaws.networkmanager#AttachmentType", "traits": { - "smithy.api#documentation": "

One or more site IDs. The maximum is 10.

", - "smithy.api#httpQuery": "siteIds" + "smithy.api#documentation": "

The type of attachment.

", + "smithy.api#httpQuery": "attachmentType" + } + }, + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "

The Region where the edge is located.

", + "smithy.api#httpQuery": "edgeLocation" + } + }, + "State": { + "target": "com.amazonaws.networkmanager#AttachmentState", + "traits": { + "smithy.api#documentation": "

The state of the attachment.

", + "smithy.api#httpQuery": "state" } }, "MaxResults": { @@ -3131,7 +6628,7 @@ } }, "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#NextToken", "traits": { "smithy.api#documentation": "

The token for the next page of results.

", "smithy.api#httpQuery": "nextToken" @@ -3139,44 +6636,38 @@ } } }, - "com.amazonaws.networkmanager#GetSitesResponse": { + "com.amazonaws.networkmanager#ListAttachmentsResponse": { "type": "structure", "members": { - "Sites": { - "target": "com.amazonaws.networkmanager#SiteList", + "Attachments": { + "target": "com.amazonaws.networkmanager#AttachmentList", "traits": { - "smithy.api#documentation": "

The sites.

" + "smithy.api#documentation": "

Describes the list of attachments.

" } }, "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#NextToken", "traits": { "smithy.api#documentation": "

The token for the next page of results.

" } } } }, - "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociations": { + "com.amazonaws.networkmanager#ListConnectPeers": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociationsRequest" + "target": "com.amazonaws.networkmanager#ListConnectPeersRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociationsResponse" + "target": "com.amazonaws.networkmanager#ListConnectPeersResponse" }, "errors": [ { "target": "com.amazonaws.networkmanager#AccessDeniedException" }, - { - "target": "com.amazonaws.networkmanager#ConflictException" - }, { "target": "com.amazonaws.networkmanager#InternalServerException" }, - { - "target": "com.amazonaws.networkmanager#ResourceNotFoundException" - }, { "target": "com.amazonaws.networkmanager#ThrottlingException" }, @@ -3185,10 +6676,10 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about one or more of your transit gateway Connect peer associations in a global network.

", + "smithy.api#documentation": "

Returns a list of core network Connect peers.

", "smithy.api#http": { "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/transit-gateway-connect-peer-associations", + "uri": "/connect-peers", "code": 200 }, "smithy.api#paginated": { @@ -3198,22 +6689,21 @@ } } }, - "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociationsRequest": { + "com.amazonaws.networkmanager#ListConnectPeersRequest": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpQuery": "coreNetworkId" } }, - "TransitGatewayConnectPeerArns": { - "target": "com.amazonaws.networkmanager#StringList", + "ConnectAttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", "traits": { - "smithy.api#documentation": "

One or more transit gateway Connect peer Amazon Resource Names (ARNs).

", - "smithy.api#httpQuery": "transitGatewayConnectPeerArns" + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#httpQuery": "connectAttachmentId" } }, "MaxResults": { @@ -3224,7 +6714,7 @@ } }, "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#NextToken", "traits": { "smithy.api#documentation": "

The token for the next page of results.

", "smithy.api#httpQuery": "nextToken" @@ -3232,30 +6722,30 @@ } } }, - "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociationsResponse": { + "com.amazonaws.networkmanager#ListConnectPeersResponse": { "type": "structure", "members": { - "TransitGatewayConnectPeerAssociations": { - "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerAssociationList", + "ConnectPeers": { + "target": "com.amazonaws.networkmanager#ConnectPeerSummaryList", "traits": { - "smithy.api#documentation": "

Information about the transit gateway Connect peer associations.

" + "smithy.api#documentation": "

Describes the Connect peers.

" } }, "NextToken": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#NextToken", "traits": { - "smithy.api#documentation": "

The token to use for the next page of results.

" + "smithy.api#documentation": "

The token for the next page of results.

" } } } }, - "com.amazonaws.networkmanager#GetTransitGatewayRegistrations": { + "com.amazonaws.networkmanager#ListCoreNetworkPolicyVersions": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsRequest" + "target": "com.amazonaws.networkmanager#ListCoreNetworkPolicyVersionsRequest" }, "output": { - "target": "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsResponse" + "target": "com.amazonaws.networkmanager#ListCoreNetworkPolicyVersionsResponse" }, "errors": [ { @@ -3275,10 +6765,10 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the transit gateway registrations in a specified\n global network.

", + "smithy.api#documentation": "

Returns a list of core network policy versions.

", "smithy.api#http": { "method": "GET", - "uri": "/global-networks/{GlobalNetworkId}/transit-gateway-registrations", + "uri": "/core-networks/{CoreNetworkId}/core-network-policy-versions", "code": 200 }, "smithy.api#paginated": { @@ -3288,321 +6778,120 @@ } } }, - "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsRequest": { - "type": "structure", - "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the global network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TransitGatewayArns": { - "target": "com.amazonaws.networkmanager#StringList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is\n 10.

", - "smithy.api#httpQuery": "transitGatewayArns" - } - }, - "MaxResults": { - "target": "com.amazonaws.networkmanager#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.networkmanager#GetTransitGatewayRegistrationsResponse": { - "type": "structure", - "members": { - "TransitGatewayRegistrations": { - "target": "com.amazonaws.networkmanager#TransitGatewayRegistrationList", - "traits": { - "smithy.api#documentation": "

The transit gateway registrations.

" - } - }, - "NextToken": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - } - }, - "com.amazonaws.networkmanager#GlobalNetwork": { - "type": "structure", - "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the global network.

" - } - }, - "GlobalNetworkArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the global network.

" - } - }, - "Description": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The description of the global network.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.networkmanager#DateTime", - "traits": { - "smithy.api#documentation": "

The date and time that the global network was created.

" - } - }, - "State": { - "target": "com.amazonaws.networkmanager#GlobalNetworkState", - "traits": { - "smithy.api#documentation": "

The state of the global network.

" - } - }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", - "traits": { - "smithy.api#documentation": "

The tags for the global network.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a global network.

" - } - }, - "com.amazonaws.networkmanager#GlobalNetworkList": { - "type": "list", - "member": { - "target": "com.amazonaws.networkmanager#GlobalNetwork" - } - }, - "com.amazonaws.networkmanager#GlobalNetworkState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" - } - ] - } - }, - "com.amazonaws.networkmanager#Integer": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } - }, - "com.amazonaws.networkmanager#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#required": {} - } - }, - "RetryAfterSeconds": { - "target": "com.amazonaws.networkmanager#RetryAfterSeconds", - "traits": { - "smithy.api#documentation": "

Indicates when to retry the request.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request has failed due to an internal error.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.networkmanager#Link": { + "com.amazonaws.networkmanager#ListCoreNetworkPolicyVersionsRequest": { "type": "structure", - "members": { - "LinkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the link.

" - } - }, - "LinkArn": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the link.

" - } - }, - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the global network.

" - } - }, - "SiteId": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The ID of the site.

" - } - }, - "Description": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The description of the link.

" - } - }, - "Type": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The type of the link.

" - } - }, - "Bandwidth": { - "target": "com.amazonaws.networkmanager#Bandwidth", - "traits": { - "smithy.api#documentation": "

The bandwidth for the link.

" - } - }, - "Provider": { - "target": "com.amazonaws.networkmanager#String", - "traits": { - "smithy.api#documentation": "

The provider of the link.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.networkmanager#DateTime", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "

The date and time that the link was created.

" + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "State": { - "target": "com.amazonaws.networkmanager#LinkState", + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", "traits": { - "smithy.api#documentation": "

The state of the link.

" + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" } }, - "Tags": { - "target": "com.amazonaws.networkmanager#TagList", + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", "traits": { - "smithy.api#documentation": "

The tags for the link.

" + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" } } - }, - "traits": { - "smithy.api#documentation": "

Describes a link.

" } }, - "com.amazonaws.networkmanager#LinkAssociation": { + "com.amazonaws.networkmanager#ListCoreNetworkPolicyVersionsResponse": { "type": "structure", "members": { - "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "CoreNetworkPolicyVersions": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyVersionList", "traits": { - "smithy.api#documentation": "

The ID of the global network.

" + "smithy.api#documentation": "

Describes core network policy versions.

" } }, - "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", "traits": { - "smithy.api#documentation": "

The device ID for the link association.

" + "smithy.api#documentation": "

The token for the next page of results.

" } + } + } + }, + "com.amazonaws.networkmanager#ListCoreNetworks": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#ListCoreNetworksRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#ListCoreNetworksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" }, - "LinkId": { - "target": "com.amazonaws.networkmanager#String", + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of owned and shared core networks.

", + "smithy.api#http": { + "method": "GET", + "uri": "/core-networks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#ListCoreNetworksRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", "traits": { - "smithy.api#documentation": "

The ID of the link.

" + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" } }, - "LinkAssociationState": { - "target": "com.amazonaws.networkmanager#LinkAssociationState", + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", "traits": { - "smithy.api#documentation": "

The state of the association.

" + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" } } - }, - "traits": { - "smithy.api#documentation": "

Describes the association between a device and a link.

" - } - }, - "com.amazonaws.networkmanager#LinkAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.networkmanager#LinkAssociation" } }, - "com.amazonaws.networkmanager#LinkAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "com.amazonaws.networkmanager#ListCoreNetworksResponse": { + "type": "structure", + "members": { + "CoreNetworks": { + "target": "com.amazonaws.networkmanager#CoreNetworkSummaryList", + "traits": { + "smithy.api#documentation": "

Describes the list of core networks.

" } - ] - } - }, - "com.amazonaws.networkmanager#LinkList": { - "type": "list", - "member": { - "target": "com.amazonaws.networkmanager#Link" - } - }, - "com.amazonaws.networkmanager#LinkState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" } - ] + } } }, "com.amazonaws.networkmanager#ListTagsForResource": { @@ -3643,7 +6932,7 @@ "type": "structure", "members": { "ResourceArn": { - "target": "com.amazonaws.networkmanager#ResourceARN", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, @@ -3667,19 +6956,19 @@ "type": "structure", "members": { "Address": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The physical address.

" } }, "Latitude": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The latitude.

" } }, "Longitude": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The longitude.

" } @@ -3690,6 +6979,12 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.networkmanager#Long": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.networkmanager#MaxResults": { "type": "integer", "traits": { @@ -3702,8 +6997,29 @@ }, "com.amazonaws.networkmanager#NetworkManager": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "NetworkManager", + "arnNamespace": "networkmanager", + "cloudFormationName": "NetworkManager", + "cloudTrailEventSource": "networkmanager.amazonaws.com", + "endpointPrefix": "networkmanager" + }, + "aws.auth#sigv4": { + "name": "networkmanager" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your\n Amazon Web Services and on-premises networks that are built around transit gateways.

", + "smithy.api#title": "AWS Network Manager" + }, "version": "2019-07-05", "operations": [ + { + "target": "com.amazonaws.networkmanager#AcceptAttachment" + }, + { + "target": "com.amazonaws.networkmanager#AssociateConnectPeer" + }, { "target": "com.amazonaws.networkmanager#AssociateCustomerGateway" }, @@ -3713,9 +7029,18 @@ { "target": "com.amazonaws.networkmanager#AssociateTransitGatewayConnectPeer" }, + { + "target": "com.amazonaws.networkmanager#CreateConnectAttachment" + }, { "target": "com.amazonaws.networkmanager#CreateConnection" }, + { + "target": "com.amazonaws.networkmanager#CreateConnectPeer" + }, + { + "target": "com.amazonaws.networkmanager#CreateCoreNetwork" + }, { "target": "com.amazonaws.networkmanager#CreateDevice" }, @@ -3728,9 +7053,27 @@ { "target": "com.amazonaws.networkmanager#CreateSite" }, + { + "target": "com.amazonaws.networkmanager#CreateSiteToSiteVpnAttachment" + }, + { + "target": "com.amazonaws.networkmanager#CreateVpcAttachment" + }, + { + "target": "com.amazonaws.networkmanager#DeleteAttachment" + }, { "target": "com.amazonaws.networkmanager#DeleteConnection" }, + { + "target": "com.amazonaws.networkmanager#DeleteConnectPeer" + }, + { + "target": "com.amazonaws.networkmanager#DeleteCoreNetwork" + }, + { + "target": "com.amazonaws.networkmanager#DeleteCoreNetworkPolicyVersion" + }, { "target": "com.amazonaws.networkmanager#DeleteDevice" }, @@ -3740,6 +7083,9 @@ { "target": "com.amazonaws.networkmanager#DeleteLink" }, + { + "target": "com.amazonaws.networkmanager#DeleteResourcePolicy" + }, { "target": "com.amazonaws.networkmanager#DeleteSite" }, @@ -3749,6 +7095,9 @@ { "target": "com.amazonaws.networkmanager#DescribeGlobalNetworks" }, + { + "target": "com.amazonaws.networkmanager#DisassociateConnectPeer" + }, { "target": "com.amazonaws.networkmanager#DisassociateCustomerGateway" }, @@ -3758,9 +7107,30 @@ { "target": "com.amazonaws.networkmanager#DisassociateTransitGatewayConnectPeer" }, + { + "target": "com.amazonaws.networkmanager#ExecuteCoreNetworkChangeSet" + }, + { + "target": "com.amazonaws.networkmanager#GetConnectAttachment" + }, { "target": "com.amazonaws.networkmanager#GetConnections" }, + { + "target": "com.amazonaws.networkmanager#GetConnectPeer" + }, + { + "target": "com.amazonaws.networkmanager#GetConnectPeerAssociations" + }, + { + "target": "com.amazonaws.networkmanager#GetCoreNetwork" + }, + { + "target": "com.amazonaws.networkmanager#GetCoreNetworkChangeSet" + }, + { + "target": "com.amazonaws.networkmanager#GetCoreNetworkPolicy" + }, { "target": "com.amazonaws.networkmanager#GetCustomerGatewayAssociations" }, @@ -3788,24 +7158,57 @@ { "target": "com.amazonaws.networkmanager#GetNetworkTelemetry" }, + { + "target": "com.amazonaws.networkmanager#GetResourcePolicy" + }, { "target": "com.amazonaws.networkmanager#GetRouteAnalysis" }, { "target": "com.amazonaws.networkmanager#GetSites" }, + { + "target": "com.amazonaws.networkmanager#GetSiteToSiteVpnAttachment" + }, { "target": "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociations" }, { "target": "com.amazonaws.networkmanager#GetTransitGatewayRegistrations" }, + { + "target": "com.amazonaws.networkmanager#GetVpcAttachment" + }, + { + "target": "com.amazonaws.networkmanager#ListAttachments" + }, + { + "target": "com.amazonaws.networkmanager#ListConnectPeers" + }, + { + "target": "com.amazonaws.networkmanager#ListCoreNetworkPolicyVersions" + }, + { + "target": "com.amazonaws.networkmanager#ListCoreNetworks" + }, { "target": "com.amazonaws.networkmanager#ListTagsForResource" }, + { + "target": "com.amazonaws.networkmanager#PutCoreNetworkPolicy" + }, + { + "target": "com.amazonaws.networkmanager#PutResourcePolicy" + }, { "target": "com.amazonaws.networkmanager#RegisterTransitGateway" }, + { + "target": "com.amazonaws.networkmanager#RejectAttachment" + }, + { + "target": "com.amazonaws.networkmanager#RestoreCoreNetworkPolicyVersion" + }, { "target": "com.amazonaws.networkmanager#StartRouteAnalysis" }, @@ -3818,6 +7221,9 @@ { "target": "com.amazonaws.networkmanager#UpdateConnection" }, + { + "target": "com.amazonaws.networkmanager#UpdateCoreNetwork" + }, { "target": "com.amazonaws.networkmanager#UpdateDevice" }, @@ -3832,65 +7238,59 @@ }, { "target": "com.amazonaws.networkmanager#UpdateSite" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "NetworkManager", - "arnNamespace": "networkmanager", - "cloudFormationName": "NetworkManager", - "cloudTrailEventSource": "networkmanager.amazonaws.com", - "endpointPrefix": "networkmanager" - }, - "aws.auth#sigv4": { - "name": "networkmanager" }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your\n Amazon Web Services and on-premises networks that are built around transit gateways.

", - "smithy.api#title": "AWS Network Manager" - } + { + "target": "com.amazonaws.networkmanager#UpdateVpcAttachment" + } + ] }, "com.amazonaws.networkmanager#NetworkResource": { "type": "structure", "members": { "RegisteredGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the gateway.

" } }, + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

a core network ID.

" + } + }, "AwsRegion": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ExternalRegionCode", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region.

" } }, "AccountId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#AWSAccountId", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID.

" } }, "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The resource type.

\n

The following are the supported resource types for Direct Connect:

\n
    \n
  • \n

    \n dxcon\n

    \n
  • \n
  • \n

    \n dx-gateway\n

    \n
  • \n
  • \n

    \n dx-vif\n

    \n
  • \n
\n \n

The following are the supported resource types for Network Manager:

\n
    \n
  • \n

    \n connection\n

    \n
  • \n
  • \n

    \n device\n

    \n
  • \n
  • \n

    \n link\n

    \n
  • \n
  • \n

    \n site\n

    \n
  • \n
\n\n

The following are the supported resource types for Amazon VPC:

\n
    \n
  • \n

    \n customer-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway\n

    \n
  • \n
  • \n

    \n transit-gateway-attachment\n

    \n
  • \n
  • \n

    \n transit-gateway-connect-peer\n

    \n
  • \n
  • \n

    \n transit-gateway-route-table\n

    \n
  • \n
  • \n

    \n vpn-connection\n

    \n
  • \n
" } }, "ResourceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The ID of the resource.

" } }, "ResourceArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

" } }, "Definition": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

" } @@ -3922,7 +7322,7 @@ "type": "structure", "members": { "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The resource type.

" } @@ -3950,50 +7350,44 @@ "target": "com.amazonaws.networkmanager#NetworkResource" } }, - "com.amazonaws.networkmanager#NetworkResourceMetadataKey": { - "type": "string" - }, "com.amazonaws.networkmanager#NetworkResourceMetadataMap": { "type": "map", "key": { - "target": "com.amazonaws.networkmanager#NetworkResourceMetadataKey" + "target": "com.amazonaws.networkmanager#ConstrainedString" }, "value": { - "target": "com.amazonaws.networkmanager#NetworkResourceMetadataValue" + "target": "com.amazonaws.networkmanager#ConstrainedString" } }, - "com.amazonaws.networkmanager#NetworkResourceMetadataValue": { - "type": "string" - }, "com.amazonaws.networkmanager#NetworkResourceSummary": { "type": "structure", "members": { "RegisteredGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the gateway.

" } }, "ResourceArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

" } }, "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The resource type.

" } }, "Definition": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

" } }, "NameTag": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The value for the Name tag.

" } @@ -4013,7 +7407,7 @@ "type": "structure", "members": { "DestinationCidrBlock": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

A unique identifier for the route, such as a CIDR block.

" } @@ -4025,7 +7419,7 @@ } }, "PrefixListId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The ID of the prefix list.

" } @@ -4050,20 +7444,38 @@ "com.amazonaws.networkmanager#NetworkRouteDestination": { "type": "structure", "members": { + "CoreNetworkAttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of a core network attachment.

" + } + }, "TransitGatewayAttachmentId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayAttachmentId", "traits": { "smithy.api#documentation": "

The ID of the transit gateway attachment.

" } }, + "SegmentName": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The name of the segment.

" + } + }, + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "

The edge location for the network destination.

" + } + }, "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The resource type.

" } }, "ResourceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The ID of the resource.

" } @@ -4089,43 +7501,49 @@ "type": "structure", "members": { "RegisteredGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the gateway.

" } }, + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

" + } + }, "AwsRegion": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ExternalRegionCode", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region.

" } }, "AccountId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#AWSAccountId", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID.

" } }, "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The resource type.

" } }, "ResourceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The ID of the resource.

" } }, "ResourceArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

" } }, "Address": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The address.

" } @@ -4147,6 +7565,15 @@ "target": "com.amazonaws.networkmanager#NetworkTelemetry" } }, + "com.amazonaws.networkmanager#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.networkmanager#PathComponent": { "type": "structure", "members": { @@ -4163,7 +7590,7 @@ } }, "DestinationCidrBlock": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The destination CIDR block in the route table.

" } @@ -4179,6 +7606,183 @@ "target": "com.amazonaws.networkmanager#PathComponent" } }, + "com.amazonaws.networkmanager#ProposedSegmentChange": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "

The key-value tags that changed for the segment.

" + } + }, + "AttachmentPolicyRuleNumber": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

The rule number in the policy document that applies to this change.

" + } + }, + "SegmentName": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The name of the segment to change.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.

" + } + }, + "com.amazonaws.networkmanager#PutCoreNetworkPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#PutCoreNetworkPolicyRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#PutCoreNetworkPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicyException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.

", + "smithy.api#http": { + "method": "POST", + "uri": "/core-networks/{CoreNetworkId}/core-network-policy", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#PutCoreNetworkPolicyRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PolicyDocument": { + "target": "com.amazonaws.networkmanager#SynthesizedJsonCoreNetworkPolicyDocument", + "traits": { + "smithy.api#documentation": "

The policy document.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

a core network policy description.

" + } + }, + "LatestVersionId": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

The ID of a core network policy.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.networkmanager#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token associated with the request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.networkmanager#PutCoreNetworkPolicyResponse": { + "type": "structure", + "members": { + "CoreNetworkPolicy": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicy", + "traits": { + "smithy.api#documentation": "

Describes the changed core network policy.

" + } + } + } + }, + "com.amazonaws.networkmanager#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a resource policy.

", + "smithy.api#http": { + "method": "POST", + "uri": "/resource-policy/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "PolicyDocument": { + "target": "com.amazonaws.networkmanager#SynthesizedJsonResourcePolicyDocument", + "traits": { + "smithy.api#documentation": "

The JSON resource policy document.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#PutResourcePolicyResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.networkmanager#ReasonContextKey": { "type": "string" }, @@ -4235,7 +7839,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -4243,7 +7847,7 @@ } }, "TransitGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

", "smithy.api#required": {} @@ -4262,17 +7866,78 @@ } } }, + "com.amazonaws.networkmanager#RejectAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#RejectAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#RejectAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Rejects a core network attachment request.

", + "smithy.api#http": { + "method": "POST", + "uri": "/attachments/{AttachmentId}/reject", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#RejectAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#RejectAttachmentResponse": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.networkmanager#Attachment", + "traits": { + "smithy.api#documentation": "

Describes the rejected attachment request.

" + } + } + } + }, "com.amazonaws.networkmanager#Relationship": { "type": "structure", "members": { "From": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The ARN of the resource.

" } }, "To": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The ARN of the resource.

" } @@ -4288,34 +7953,43 @@ "target": "com.amazonaws.networkmanager#Relationship" } }, - "com.amazonaws.networkmanager#ResourceARN": { - "type": "string" + "com.amazonaws.networkmanager#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1500 + } + } }, "com.amazonaws.networkmanager#ResourceNotFoundException": { "type": "structure", "members": { "Message": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#required": {} } }, "ResourceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The ID of the resource.

", "smithy.api#required": {} } }, "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The resource type.

", "smithy.api#required": {} } }, "Context": { - "target": "com.amazonaws.networkmanager#ExceptionContextMap" + "target": "com.amazonaws.networkmanager#ExceptionContextMap", + "traits": { + "smithy.api#documentation": "

The specified resource could not be found.

" + } } }, "traits": { @@ -4324,6 +7998,75 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.networkmanager#RestoreCoreNetworkPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#RestoreCoreNetworkPolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#RestoreCoreNetworkPolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.

", + "smithy.api#http": { + "method": "POST", + "uri": "/core-networks/{CoreNetworkId}/core-network-policy-versions/{PolicyVersionId}/restore", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#RestoreCoreNetworkPolicyVersionRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PolicyVersionId": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "

The ID of the policy version to restore.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#RestoreCoreNetworkPolicyVersionResponse": { + "type": "structure", + "members": { + "CoreNetworkPolicy": { + "target": "com.amazonaws.networkmanager#CoreNetworkPolicy", + "traits": { + "smithy.api#documentation": "

Describes the restored core network policy.

" + } + } + } + }, "com.amazonaws.networkmanager#RetryAfterSeconds": { "type": "integer", "traits": { @@ -4334,19 +8077,19 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

" } }, "OwnerAccountId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#AWSAccountId", "traits": { "smithy.api#documentation": "

The ID of the AWS account that created the route analysis.

" } }, "RouteAnalysisId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The ID of the route analysis.

" } @@ -4500,19 +8243,19 @@ "type": "structure", "members": { "TransitGatewayAttachmentArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayAttachmentArn", "traits": { "smithy.api#documentation": "

The ARN of the transit gateway attachment.

" } }, "TransitGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayArn", "traits": { "smithy.api#documentation": "

The ARN of the transit gateway.

" } }, "IpAddress": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#IPAddress", "traits": { "smithy.api#documentation": "

The IP address.

" } @@ -4526,13 +8269,13 @@ "type": "structure", "members": { "TransitGatewayAttachmentArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayAttachmentArn", "traits": { "smithy.api#documentation": "

The ARN of the transit gateway attachment.

" } }, "IpAddress": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#IPAddress", "traits": { "smithy.api#documentation": "

The IP address.

" } @@ -4606,10 +8349,16 @@ "type": "structure", "members": { "TransitGatewayRouteTableArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayRouteTableArn", "traits": { "smithy.api#documentation": "

The ARN of the transit gateway route table.

" } + }, + "CoreNetworkSegmentEdge": { + "target": "com.amazonaws.networkmanager#CoreNetworkSegmentEdgeIdentifier", + "traits": { + "smithy.api#documentation": "

The segment edge in a core network.

" + } } }, "traits": { @@ -4623,6 +8372,10 @@ { "value": "TRANSIT_GATEWAY_ROUTE_TABLE", "name": "TRANSIT_GATEWAY_ROUTE_TABLE" + }, + { + "value": "CORE_NETWORK_SEGMENT", + "name": "CORE_NETWORK_SEGMENT" } ] } @@ -4648,37 +8401,40 @@ "target": "com.amazonaws.networkmanager#RouteType" } }, + "com.amazonaws.networkmanager#ServerSideString": { + "type": "string" + }, "com.amazonaws.networkmanager#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The error message.

", "smithy.api#required": {} } }, "ResourceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The ID of the resource.

" } }, "ResourceType": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The resource type.

" } }, "LimitCode": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The limit code.

", "smithy.api#required": {} } }, "ServiceCode": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The service code.

", "smithy.api#required": {} @@ -4695,25 +8451,25 @@ "type": "structure", "members": { "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#SiteId", "traits": { "smithy.api#documentation": "

The ID of the site.

" } }, "SiteArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#SiteArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the site.

" } }, "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

" } }, "Description": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The description of the site.

" } @@ -4747,6 +8503,30 @@ "smithy.api#documentation": "

Describes a site.

" } }, + "com.amazonaws.networkmanager#SiteArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#SiteId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#SiteIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#SiteId" + } + }, "com.amazonaws.networkmanager#SiteList": { "type": "list", "member": { @@ -4776,6 +8556,26 @@ ] } }, + "com.amazonaws.networkmanager#SiteToSiteVpnAttachment": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.networkmanager#Attachment", + "traits": { + "smithy.api#documentation": "

Provides details about a site-to-site VPN attachment.

" + } + }, + "VpnConnectionArn": { + "target": "com.amazonaws.networkmanager#VpnConnectionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the site-to-site VPN attachment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates a site-to-site VPN attachment.

" + } + }, "com.amazonaws.networkmanager#StartRouteAnalysis": { "type": "operation", "input": { @@ -4817,7 +8617,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -4863,13 +8663,32 @@ } } }, - "com.amazonaws.networkmanager#String": { - "type": "string" + "com.amazonaws.networkmanager#SubnetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\\/subnet-[0-9a-f]{8,17}$" + } }, - "com.amazonaws.networkmanager#StringList": { + "com.amazonaws.networkmanager#SubnetArnList": { "type": "list", "member": { - "target": "com.amazonaws.networkmanager#String" + "target": "com.amazonaws.networkmanager#SubnetArn" + } + }, + "com.amazonaws.networkmanager#SynthesizedJsonCoreNetworkPolicyDocument": { + "type": "string", + "traits": { + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.networkmanager#SynthesizedJsonResourcePolicyDocument": { + "type": "string", + "traits": { + "smithy.api#mediaType": "application/json" } }, "com.amazonaws.networkmanager#Tag": { @@ -4951,7 +8770,7 @@ "type": "structure", "members": { "ResourceArn": { - "target": "com.amazonaws.networkmanager#ResourceARN", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, @@ -4978,7 +8797,7 @@ "type": "structure", "members": { "Message": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#required": {} } @@ -4997,29 +8816,77 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.networkmanager#TransitGatewayArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#TransitGatewayArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#TransitGatewayArn" + } + }, + "com.amazonaws.networkmanager#TransitGatewayAttachmentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#TransitGatewayAttachmentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#TransitGatewayConnectPeerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#TransitGatewayConnectPeerArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerArn" + } + }, "com.amazonaws.networkmanager#TransitGatewayConnectPeerAssociation": { "type": "structure", "members": { "TransitGatewayConnectPeerArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayConnectPeerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

" } }, "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

" } }, "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { "smithy.api#documentation": "

The ID of the device.

" } }, "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#LinkId", "traits": { "smithy.api#documentation": "

The ID of the link.

" } @@ -5068,13 +8935,13 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

" } }, "TransitGatewayArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#TransitGatewayArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the transit gateway.

" } @@ -5133,7 +9000,7 @@ } }, "Message": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The message for the state reason.

" } @@ -5143,6 +9010,26 @@ "smithy.api#documentation": "

Describes the status of a transit gateway registration.

" } }, + "com.amazonaws.networkmanager#TransitGatewayRouteTableArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.networkmanager#TunnelProtocol": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GRE", + "name": "GRE" + } + ] + } + }, "com.amazonaws.networkmanager#UntagResource": { "type": "operation", "input": { @@ -5184,7 +9071,7 @@ "type": "structure", "members": { "ResourceArn": { - "target": "com.amazonaws.networkmanager#ResourceARN", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, @@ -5246,7 +9133,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -5254,7 +9141,7 @@ } }, "ConnectionId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConnectionId", "traits": { "smithy.api#documentation": "

The ID of the connection.

", "smithy.api#httpLabel": {}, @@ -5262,19 +9149,19 @@ } }, "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#LinkId", "traits": { "smithy.api#documentation": "

The ID of the link for the first device in the connection.

" } }, "ConnectedLinkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#LinkId", "traits": { "smithy.api#documentation": "

The ID of the link for the second device in the connection.

" } }, "Description": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

A description of the connection.

\n

Length Constraints: Maximum length of 256 characters.

" } @@ -5292,6 +9179,73 @@ } } }, + "com.amazonaws.networkmanager#UpdateCoreNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#UpdateCoreNetworkRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#UpdateCoreNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the description of a core network.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/core-networks/{CoreNetworkId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#UpdateCoreNetworkRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "

The ID of a core network.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "

The description of the update.

" + } + } + } + }, + "com.amazonaws.networkmanager#UpdateCoreNetworkResponse": { + "type": "structure", + "members": { + "CoreNetwork": { + "target": "com.amazonaws.networkmanager#CoreNetwork", + "traits": { + "smithy.api#documentation": "

Returns information about a core network update.

" + } + } + } + }, "com.amazonaws.networkmanager#UpdateDevice": { "type": "operation", "input": { @@ -5333,7 +9287,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -5341,7 +9295,7 @@ } }, "DeviceId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#DeviceId", "traits": { "smithy.api#documentation": "

The ID of the device.

", "smithy.api#httpLabel": {}, @@ -5355,31 +9309,31 @@ } }, "Description": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

A description of the device.

\n

Constraints: Maximum length of 256 characters.

" } }, "Type": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The type of the device.

" } }, "Vendor": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The vendor of the device.

\n

Constraints: Maximum length of 128 characters.

" } }, "Model": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The model of the device.

\n

Constraints: Maximum length of 128 characters.

" } }, "SerialNumber": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The serial number of the device.

\n

Constraints: Maximum length of 128 characters.

" } @@ -5388,7 +9342,7 @@ "target": "com.amazonaws.networkmanager#Location" }, "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#SiteId", "traits": { "smithy.api#documentation": "

The ID of the site.

" } @@ -5447,7 +9401,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of your global network.

", "smithy.api#httpLabel": {}, @@ -5455,7 +9409,7 @@ } }, "Description": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

A description of the global network.

\n

Constraints: Maximum length of 256 characters.

" } @@ -5517,7 +9471,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -5525,7 +9479,7 @@ } }, "LinkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#LinkId", "traits": { "smithy.api#documentation": "

The ID of the link.

", "smithy.api#httpLabel": {}, @@ -5533,13 +9487,13 @@ } }, "Description": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

A description of the link.

\n

Constraints: Maximum length of 256 characters.

" } }, "Type": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The type of the link.

\n

Constraints: Maximum length of 128 characters.

" } @@ -5551,7 +9505,7 @@ } }, "Provider": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

The provider of the link.

\n

Constraints: Maximum length of 128 characters.

" } @@ -5610,7 +9564,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -5618,7 +9572,7 @@ } }, "ResourceArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#httpLabel": {}, @@ -5638,7 +9592,7 @@ "type": "structure", "members": { "ResourceArn": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

" } @@ -5692,7 +9646,7 @@ "type": "structure", "members": { "GlobalNetworkId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#GlobalNetworkId", "traits": { "smithy.api#documentation": "

The ID of the global network.

", "smithy.api#httpLabel": {}, @@ -5700,7 +9654,7 @@ } }, "SiteId": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#SiteId", "traits": { "smithy.api#documentation": "

The ID of your site.

", "smithy.api#httpLabel": {}, @@ -5708,7 +9662,7 @@ } }, "Description": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ConstrainedString", "traits": { "smithy.api#documentation": "

A description of your site.

\n

Constraints: Maximum length of 256 characters.

" } @@ -5732,11 +9686,90 @@ } } }, + "com.amazonaws.networkmanager#UpdateVpcAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#UpdateVpcAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#UpdateVpcAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a VPC attachment.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/vpc-attachments/{AttachmentId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#UpdateVpcAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "

The ID of the attachment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AddSubnetArns": { + "target": "com.amazonaws.networkmanager#SubnetArnList", + "traits": { + "smithy.api#documentation": "

Adds a subnet ARN to the VPC attachment.

" + } + }, + "RemoveSubnetArns": { + "target": "com.amazonaws.networkmanager#SubnetArnList", + "traits": { + "smithy.api#documentation": "

Removes a subnet ARN from the attachment.

" + } + }, + "Options": { + "target": "com.amazonaws.networkmanager#VpcOptions", + "traits": { + "smithy.api#documentation": "

Additional options for updating the VPC attachment.

" + } + } + } + }, + "com.amazonaws.networkmanager#UpdateVpcAttachmentResponse": { + "type": "structure", + "members": { + "VpcAttachment": { + "target": "com.amazonaws.networkmanager#VpcAttachment", + "traits": { + "smithy.api#documentation": "

Describes the updated VPC attachment.

" + } + } + } + }, "com.amazonaws.networkmanager#ValidationException": { "type": "structure", "members": { "Message": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#required": {} } @@ -5764,14 +9797,14 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The name of the field.

", "smithy.api#required": {} } }, "Message": { - "target": "com.amazonaws.networkmanager#String", + "target": "com.amazonaws.networkmanager#ServerSideString", "traits": { "smithy.api#documentation": "

The message for the field.

", "smithy.api#required": {} @@ -5810,6 +9843,66 @@ } ] } + }, + "com.amazonaws.networkmanager#VpcArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpc\\/vpc-[0-9a-f]{8,17}$" + } + }, + "com.amazonaws.networkmanager#VpcAttachment": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.networkmanager#Attachment", + "traits": { + "smithy.api#documentation": "

Provides details about the VPC attachment.

" + } + }, + "SubnetArns": { + "target": "com.amazonaws.networkmanager#SubnetArnList", + "traits": { + "smithy.api#documentation": "

The subnet ARNs.

" + } + }, + "Options": { + "target": "com.amazonaws.networkmanager#VpcOptions", + "traits": { + "smithy.api#documentation": "

Provides details about the VPC attachment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC attachment.

" + } + }, + "com.amazonaws.networkmanager#VpcOptions": { + "type": "structure", + "members": { + "Ipv6Support": { + "target": "com.amazonaws.networkmanager#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether IPv6 is supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the VPC options.

" + } + }, + "com.amazonaws.networkmanager#VpnConnectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\\/vpn-[0-9a-f]{8,17}$" + } } } } diff --git a/aws/sdk/aws-models/nimble.json b/aws/sdk/aws-models/nimble.json index 5a94e759e5..25ec543a97 100644 --- a/aws/sdk/aws-models/nimble.json +++ b/aws/sdk/aws-models/nimble.json @@ -67,9 +67,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#AcceptEulasResponse": { @@ -81,9 +78,6 @@ "smithy.api#documentation": "

A collection of EULA acceptances.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#AccessDeniedException": { @@ -195,10 +189,7 @@ } }, "com.amazonaws.nimble#ActiveDirectoryDnsIpAddress": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#ActiveDirectoryDnsIpAddressList": { "type": "list", @@ -206,7 +197,6 @@ "target": "com.amazonaws.nimble#ActiveDirectoryDnsIpAddress" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 10 @@ -314,9 +304,18 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a launch profile", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "ec2:CreateNetworkInterface", - "ec2:RunInstances" + "ec2:RunInstances", + "ec2:DescribeSubnets", + "ec2:DescribeRouteTables", + "ec2:DescribeNetworkAcls", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeNatGateways" ], "smithy.api#documentation": "

Create a launch profile.

", "smithy.api#http": { @@ -398,7 +397,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -415,9 +413,6 @@ "smithy.api#documentation": "

The launch profile.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStreamingImage": { @@ -453,6 +448,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a streaming image", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "ec2:ModifyInstanceAttribute", "ec2:ModifySnapshotAttribute", @@ -520,7 +519,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -537,9 +535,6 @@ "smithy.api#documentation": "

The streaming image.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStreamingSession": { @@ -575,6 +570,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a streaming session", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "ec2:CreateNetworkInterface", "ec2:CreateNetworkInterfacePermission", @@ -641,7 +640,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#LaunchProfileResource" @@ -658,9 +656,6 @@ "smithy.api#documentation": "

The session.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStreamingSessionStream": { @@ -696,6 +691,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a streaming session stream", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "smithy.api#documentation": "

Creates a streaming session stream for a streaming session.

\n

After invoking this API, invoke GetStreamingSessionStream with the returned streamId\n to poll the resource until it is in state READY.

", "smithy.api#http": { "method": "POST", @@ -740,7 +738,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StreamingSessionResource" @@ -757,9 +754,6 @@ "smithy.api#documentation": "

The stream.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStudio": { @@ -795,6 +789,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a studio", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "sso:CreateManagedApplicationInstance", "iam:PassRole" @@ -840,6 +838,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a studio component. A studio component designates a network resource to which a launch profile will provide access", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "ec2:DescribeSecurityGroups", "fsx:DescribeFileSystems", @@ -934,7 +936,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -951,9 +952,6 @@ "smithy.api#documentation": "

Information about the studio component.

" } } - }, - "traits": { - "smithy.api#documentation": "

" } }, "com.amazonaws.nimble#CreateStudioRequest": { @@ -1012,9 +1010,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStudioResponse": { @@ -1026,9 +1021,6 @@ "smithy.api#documentation": "

Information about a studio.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteLaunchProfile": { @@ -1154,10 +1146,7 @@ }, "com.amazonaws.nimble#DeleteLaunchProfileMemberResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "" - } + "members": {} }, "com.amazonaws.nimble#DeleteLaunchProfileRequest": { "type": "structure", @@ -1198,9 +1187,6 @@ "smithy.api#documentation": "

The launch profile.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteStreamingImage": { @@ -1290,9 +1276,6 @@ "smithy.api#documentation": "

The streaming image.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteStreamingSession": { @@ -1328,6 +1311,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to delete a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "aws.iam#requiredActions": [ "ec2:DeleteNetworkInterface" ], @@ -1378,9 +1364,6 @@ "smithy.api#documentation": "

The session.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteStudio": { @@ -1509,9 +1492,6 @@ "smithy.api#documentation": "

Information about the studio component.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteStudioMember": { @@ -1587,10 +1567,7 @@ }, "com.amazonaws.nimble#DeleteStudioMemberResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "" - } + "members": {} }, "com.amazonaws.nimble#DeleteStudioRequest": { "type": "structure", @@ -1623,29 +1600,19 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DirectoryId": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#EC2ImageId": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#pattern": "^ami-[0-9A-z]+$" } }, "com.amazonaws.nimble#EC2SubnetId": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#EC2SubnetIdList": { "type": "list", @@ -1653,7 +1620,6 @@ "target": "com.amazonaws.nimble#EC2SubnetId" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 6 @@ -1751,9 +1717,6 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#EulaAcceptance" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#EulaAcceptanceResource": { @@ -1801,24 +1764,17 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#String" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#EulaList": { "type": "list", "member": { "target": "com.amazonaws.nimble#Eula" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#EulaName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 64 @@ -1851,7 +1807,7 @@ "aws:TagKeys" ], "aws.iam#disableConditionKeyInference": {}, - "smithy.api#documentation": "Represents a EULA" + "smithy.api#documentation": "Represents a EULA that is required to be accepted before the use of certain streaming images" } }, "com.amazonaws.nimble#ExceptionContext": { @@ -1930,9 +1886,6 @@ "smithy.api#documentation": "

The EULA.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetLaunchProfile": { @@ -2127,9 +2080,6 @@ "smithy.api#documentation": "

A collection of studio component summaries.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetLaunchProfileInitialization": { @@ -2233,9 +2183,6 @@ "smithy.api#documentation": "

The launch profile initialization.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetLaunchProfileMember": { @@ -2318,9 +2265,6 @@ "smithy.api#documentation": "

The member.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetLaunchProfileRequest": { @@ -2354,9 +2298,6 @@ "smithy.api#documentation": "

The launch profile.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStreamingImage": { @@ -2494,9 +2435,6 @@ "smithy.api#documentation": "

The streaming image.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStreamingSession": { @@ -2532,6 +2470,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "smithy.api#documentation": "

Gets StreamingSession resource.

\n

anvoke this operation to poll for a streaming session state while creating or deleting\n a session.

", "smithy.api#http": { "method": "GET", @@ -2664,9 +2605,6 @@ "smithy.api#documentation": "

The session.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStreamingSessionStream": { @@ -2702,6 +2640,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "smithy.api#documentation": "

Gets a StreamingSessionStream for a streaming session.

\n

Invoke this operation to poll the resource after invoking\n CreateStreamingSessionStream.

\n

After the StreamingSessionStream changes to the state READY, the url property will\n contain a stream to be used with the DCV streaming client.

", "smithy.api#http": { "method": "GET", @@ -2778,9 +2719,6 @@ "smithy.api#documentation": "

The stream.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStudio": { @@ -3023,9 +2961,6 @@ "smithy.api#documentation": "

Information about the studio component.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStudioMember": { @@ -3100,9 +3035,6 @@ "smithy.api#documentation": "

The member.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStudioRequest": { @@ -3129,9 +3061,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#InternalServerErrorException": { @@ -3296,7 +3225,6 @@ "com.amazonaws.nimble#LaunchProfileId": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 22 @@ -3363,7 +3291,7 @@ } }, "traits": { - "smithy.api#documentation": "

A Launch Profile Initialization contains information required for a workstation or\n server to connect to a launch profile

\n

This includes scripts, endpoints, security groups, subnets, and other\n configuration.

" + "smithy.api#documentation": "

A Launch Profile Initialization contains information required for a workstation or\n server to connect to a launch profile.

\n

This includes scripts, endpoints, security groups, subnets, and other\n configuration.

" } }, "com.amazonaws.nimble#LaunchProfileInitializationActiveDirectory": { @@ -3413,7 +3341,7 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Launch Profile Initialization Active Directory contains information required for\n the launch profile to connect to the Active Directory.

" } }, "com.amazonaws.nimble#LaunchProfileInitializationScript": { @@ -3439,25 +3367,19 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Launch Profile Initialization Script is used when start streaming session\n runs.

" } }, "com.amazonaws.nimble#LaunchProfileInitializationScriptList": { "type": "list", "member": { "target": "com.amazonaws.nimble#LaunchProfileInitializationScript" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#LaunchProfileList": { "type": "list", "member": { "target": "com.amazonaws.nimble#LaunchProfile" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#LaunchProfileMembership": { @@ -3489,7 +3411,7 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Launch profile membership enables your studio admins to delegate launch profile access\n to other studio users in the Nimble Studio portal without needing to write or\n maintain complex IAM policies. A launch profile member is a user association from your\n studio identity source who is granted permissions to a launch profile.

\n

A launch profile member (type USER) provides the following permissions to that launch\n profile:

\n
    \n
  • \n

    GetLaunchProfile

    \n
  • \n
  • \n

    GetLaunchProfileInitialization

    \n
  • \n
  • \n

    GetLaunchProfileMembers

    \n
  • \n
  • \n

    GetLaunchProfileMember

    \n
  • \n
  • \n

    CreateStreamingSession

    \n
  • \n
  • \n

    GetLaunchProfileDetails

    \n
  • \n
" } }, "com.amazonaws.nimble#LaunchProfileMembershipList": { @@ -3498,7 +3420,6 @@ "target": "com.amazonaws.nimble#LaunchProfileMembership" }, "traits": { - "smithy.api#documentation": "

", "smithy.api#length": { "min": 0, "max": 20 @@ -3508,7 +3429,6 @@ "com.amazonaws.nimble#LaunchProfileName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1, "max": 64 @@ -3519,7 +3439,6 @@ "com.amazonaws.nimble#LaunchProfilePersona": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "USER", @@ -3531,7 +3450,6 @@ "com.amazonaws.nimble#LaunchProfilePlatform": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "LINUX", @@ -3559,9 +3477,6 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#LaunchProfileProtocolVersion" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#LaunchProfileResource": { @@ -3641,7 +3556,6 @@ "target": "com.amazonaws.nimble#SecurityGroupId" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1 } @@ -3650,7 +3564,6 @@ "com.amazonaws.nimble#LaunchProfileState": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", @@ -3690,7 +3603,6 @@ "com.amazonaws.nimble#LaunchProfileStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "LAUNCH_PROFILE_CREATED", @@ -3753,7 +3665,6 @@ "target": "com.amazonaws.nimble#String" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1, "max": 100 @@ -3789,7 +3700,6 @@ "com.amazonaws.nimble#LinuxMountPoint": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 128 @@ -3887,9 +3797,6 @@ "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } } - }, - "traits": { - "smithy.api#documentation": "

" } }, "com.amazonaws.nimble#ListEulas": { @@ -3973,9 +3880,6 @@ "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListLaunchProfileMembers": { @@ -4076,9 +3980,6 @@ "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListLaunchProfiles": { @@ -4114,6 +4015,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list launch profiles", + "aws.iam#conditionKeys": [ + "nimble:principalId", + "nimble:requesterPrincipalId" + ], "smithy.api#documentation": "

List all the launch profiles a studio.

", "smithy.api#http": { "method": "GET", @@ -4185,9 +4090,6 @@ "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStreamingImages": { @@ -4279,9 +4181,6 @@ "smithy.api#documentation": "

A collection of streaming images.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStreamingSessions": { @@ -4319,7 +4218,8 @@ "aws.iam#actionPermissionDescription": "Grants permission to list streaming sessions", "aws.iam#conditionKeys": [ "nimble:createdBy", - "nimble:ownedBy" + "nimble:ownedBy", + "nimble:requesterPrincipalId" ], "smithy.api#documentation": "

Lists the streaming image resources in a studio.

", "smithy.api#http": { @@ -4391,9 +4291,6 @@ "smithy.api#documentation": "

A collection of streaming sessions.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStudioComponents": { @@ -4500,9 +4397,6 @@ "smithy.api#documentation": "

A collection of studio components.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStudioMembers": { @@ -4538,7 +4432,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list studio members", - "smithy.api#documentation": "

Get all users in a given studio membership.

", + "smithy.api#documentation": "

Get all users in a given studio membership.

\n \n

\n ListStudioMembers only returns admin members.

\n
", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios/{studioId}/membership", @@ -4586,7 +4480,7 @@ "members": { "target": "com.amazonaws.nimble#StudioMembershipList", "traits": { - "smithy.api#documentation": "

A list of members.

" + "smithy.api#documentation": "

A list of admin members.

" } }, "nextToken": { @@ -4595,9 +4489,6 @@ "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStudios": { @@ -4675,9 +4566,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListTagsForResource": { @@ -4778,9 +4666,6 @@ "smithy.api#documentation": "

A collection of labels, in the form of key:value pairs, that apply to this\n resource.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#MaxResults": { @@ -4811,7 +4696,7 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A new member that is added to a launch profile.

" } }, "com.amazonaws.nimble#NewLaunchProfileMemberList": { @@ -4820,7 +4705,6 @@ "target": "com.amazonaws.nimble#NewLaunchProfileMember" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1, "max": 20 @@ -4846,7 +4730,7 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A new studio user's membership.

" } }, "com.amazonaws.nimble#NewStudioMemberList": { @@ -4855,7 +4739,6 @@ "target": "com.amazonaws.nimble#NewStudioMember" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1, "max": 20 @@ -4947,9 +4830,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#PutLaunchProfileMembersResponse": { @@ -5033,22 +4913,15 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#PutStudioMembersResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "" - } + "members": {} }, "com.amazonaws.nimble#Region": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 50 @@ -5126,10 +4999,7 @@ } }, "com.amazonaws.nimble#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#ServiceQuotaExceededException": { "type": "structure", @@ -5232,6 +5102,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "aws.iam#requiredActions": [ "nimble:GetLaunchProfile", "nimble:GetLaunchProfileMember" @@ -5362,9 +5235,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StopStreamingSession": { @@ -5400,6 +5270,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to stop a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "aws.iam#requiredActions": [ "nimble:GetLaunchProfile" ], @@ -5472,7 +5345,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates\n or stops the session. The default length of time is 690 minutes, and the maximum length\n of time is 30 days.

" + "smithy.api#documentation": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

" } }, "streamingImageIds": { @@ -5490,6 +5363,15 @@ "stop_start_streaming_session" ] } + }, + "sessionStorage": { + "target": "com.amazonaws.nimble#StreamConfigurationSessionStorage", + "traits": { + "smithy.api#documentation": "

(Optional) The upload storage for a streaming session.

", + "smithy.api#tags": [ + "session_storage" + ] + } } }, "traits": { @@ -5516,7 +5398,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates\n or stops the session. The default length of time is 690 minutes, and the maximum length\n of time is 30 days.

" + "smithy.api#documentation": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

" } }, "streamingImageIds": { @@ -5529,11 +5411,20 @@ "maxStoppedSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "

The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.

", + "smithy.api#documentation": "

Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

\n

If the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session stays in the READY\n state exceeds the maxSessionLengthInMinutes value, the session will automatically be\n terminated by AWS (instead of stopped).

\n

If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will\n automatically be stopped by AWS (instead of terminated).

", "smithy.api#tags": [ "stop_start_streaming_session" ] } + }, + "sessionStorage": { + "target": "com.amazonaws.nimble#StreamConfigurationSessionStorage", + "traits": { + "smithy.api#documentation": "

(Optional) The upload storage for a streaming workstation that is created using this\n launch profile.

", + "smithy.api#tags": [ + "session_storage" + ] + } } }, "traits": { @@ -5543,7 +5434,6 @@ "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes": { "type": "integer", "traits": { - "smithy.api#documentation": "", "smithy.api#range": { "min": 1, "max": 43200 @@ -5559,10 +5449,30 @@ } } }, + "com.amazonaws.nimble#StreamConfigurationSessionStorage": { + "type": "structure", + "members": { + "root": { + "target": "com.amazonaws.nimble#StreamingSessionStorageRoot", + "traits": { + "smithy.api#documentation": "

The configuration for the upload storage root of the streaming session.

" + } + }, + "mode": { + "target": "com.amazonaws.nimble#StreamingSessionStorageModeList", + "traits": { + "smithy.api#documentation": "

Allows artists to upload files to their workstations. The only valid option is\n UPLOAD.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a streaming session’s upload storage.

" + } + }, "com.amazonaws.nimble#StreamingClipboardMode": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "ENABLED", @@ -5709,7 +5619,6 @@ "com.amazonaws.nimble#StreamingImageEncryptionConfigurationKeyArn": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 4 }, @@ -5719,7 +5628,6 @@ "com.amazonaws.nimble#StreamingImageEncryptionConfigurationKeyType": { "type": "string", "traits": { - "smithy.api#documentation": "

", "smithy.api#enum": [ { "value": "CUSTOMER_MANAGED_KEY", @@ -5731,7 +5639,6 @@ "com.amazonaws.nimble#StreamingImageId": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 22 @@ -5756,9 +5663,6 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#StreamingImage" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StreamingImageName": { @@ -5835,7 +5739,6 @@ "com.amazonaws.nimble#StreamingImageState": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", @@ -5900,6 +5803,10 @@ { "value": "INTERNAL_ERROR", "name": "INTERNAL_ERROR" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" } ] } @@ -5907,7 +5814,6 @@ "com.amazonaws.nimble#StreamingInstanceType": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "g4dn.xlarge", @@ -6093,18 +5999,12 @@ } }, "com.amazonaws.nimble#StreamingSessionId": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#StreamingSessionList": { "type": "list", "member": { "target": "com.amazonaws.nimble#StreamingSession" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StreamingSessionResource": { @@ -6153,7 +6053,8 @@ "nimble:createdBy", "nimble:ownedBy" ], - "aws.iam#disableConditionKeyInference": {} + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Represents a streaming session that a studio user launches applications and connects to studio components within a studio" } }, "com.amazonaws.nimble#StreamingSessionState": { @@ -6211,7 +6112,6 @@ "com.amazonaws.nimble#StreamingSessionStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "STREAMING_SESSION_READY", @@ -6276,6 +6176,70 @@ ] } }, + "com.amazonaws.nimble#StreamingSessionStorageMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPLOAD", + "name": "UPLOAD" + } + ] + } + }, + "com.amazonaws.nimble#StreamingSessionStorageModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.nimble#StreamingSessionStorageMode" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.nimble#StreamingSessionStorageRoot": { + "type": "structure", + "members": { + "linux": { + "target": "com.amazonaws.nimble#StreamingSessionStorageRootPathLinux", + "traits": { + "smithy.api#documentation": "

The folder path in Linux workstations where files are uploaded. The default path is\n $HOME/Downloads.

" + } + }, + "windows": { + "target": "com.amazonaws.nimble#StreamingSessionStorageRootPathWindows", + "traits": { + "smithy.api#documentation": "

The folder path in Windows workstations where files are uploaded. The default path is\n %HOMEPATH%\\Downloads.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The upload storage root location (folder) on streaming workstations where files are\n uploaded.

" + } + }, + "com.amazonaws.nimble#StreamingSessionStorageRootPathLinux": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(\\$HOME|/)[/]?([A-Za-z0-9-_]+/)*([A-Za-z0-9_-]+)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.nimble#StreamingSessionStorageRootPathWindows": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^((\\%HOMEPATH\\%)|[a-zA-Z]:)[\\\\/](?:[a-zA-Z0-9_-]+[\\\\/])*[a-zA-Z0-9_-]+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.nimble#StreamingSessionStream": { "type": "structure", "members": { @@ -6336,7 +6300,6 @@ "com.amazonaws.nimble#StreamingSessionStreamExpirationInSeconds": { "type": "integer", "traits": { - "smithy.api#documentation": "", "smithy.api#range": { "min": 60, "max": 3600 @@ -6346,7 +6309,6 @@ "com.amazonaws.nimble#StreamingSessionStreamState": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "READY", @@ -6378,7 +6340,6 @@ "com.amazonaws.nimble#StreamingSessionStreamStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "STREAM_CREATE_IN_PROGRESS", @@ -6701,7 +6662,6 @@ "com.amazonaws.nimble#StudioComponentDescription": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 256 @@ -6712,7 +6672,6 @@ "com.amazonaws.nimble#StudioComponentId": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 22 @@ -6755,7 +6714,6 @@ "com.amazonaws.nimble#StudioComponentInitializationScriptContent": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1, "max": 5120 @@ -6767,15 +6725,11 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#StudioComponentInitializationScript" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StudioComponentInitializationScriptRunContext": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "SYSTEM_INITIALIZATION", @@ -6794,7 +6748,6 @@ "target": "com.amazonaws.nimble#StudioComponent" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 50 @@ -6804,7 +6757,6 @@ "com.amazonaws.nimble#StudioComponentName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 64 @@ -6854,7 +6806,7 @@ "nimble:studioId" ], "aws.iam#disableConditionKeyInference": {}, - "smithy.api#documentation": "Represents a studio component which connects a non-Nimble Studio resource in your account to your studio", + "smithy.api#documentation": "Represents a studio component that connects a non-Nimble Studio resource in your account to your studio", "smithy.api#externalDocumentation": { "CFNSourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio" } @@ -6866,7 +6818,6 @@ "target": "com.amazonaws.nimble#ScriptParameterKeyValue" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 30 @@ -6880,9 +6831,8 @@ "target": "com.amazonaws.nimble#SecurityGroupId" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { - "min": 1, + "min": 0, "max": 30 } } @@ -6978,7 +6928,6 @@ "com.amazonaws.nimble#StudioComponentSubtype": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "AWS_MANAGED_MICROSOFT_AD", @@ -7058,22 +7007,18 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The studio component's summary.

" } }, "com.amazonaws.nimble#StudioComponentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.nimble#StudioComponentSummary" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StudioComponentType": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "ACTIVE_DIRECTORY", @@ -7101,7 +7046,6 @@ "com.amazonaws.nimble#StudioDisplayName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 64 @@ -7159,9 +7103,6 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#Studio" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StudioMembership": { @@ -7202,7 +7143,6 @@ "target": "com.amazonaws.nimble#StudioMembership" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 20 @@ -7212,7 +7152,6 @@ "com.amazonaws.nimble#StudioName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 3, "max": 64 @@ -7223,7 +7162,6 @@ "com.amazonaws.nimble#StudioPersona": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "ADMINISTRATOR", @@ -7300,7 +7238,6 @@ "com.amazonaws.nimble#StudioState": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", @@ -7477,7 +7414,6 @@ } }, "traits": { - "smithy.api#documentation": "

", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource", @@ -7523,9 +7459,6 @@ }, "value": { "target": "com.amazonaws.nimble#String" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ThrottlingException": { @@ -7560,7 +7493,6 @@ "com.amazonaws.nimble#Timestamp": { "type": "timestamp", "traits": { - "smithy.api#documentation": "", "smithy.api#timestampFormat": "date-time" } }, @@ -7698,6 +7630,13 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update a launch profile", + "aws.iam#requiredActions": [ + "ec2:DescribeSubnets", + "ec2:DescribeRouteTables", + "ec2:DescribeNetworkAcls", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeNatGateways" + ], "smithy.api#documentation": "

Update a launch profile.

", "smithy.api#http": { "method": "PATCH", @@ -7789,9 +7728,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "

" } }, "com.amazonaws.nimble#UpdateLaunchProfileMemberResponse": { @@ -7864,9 +7800,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateLaunchProfileResponse": { @@ -7878,9 +7811,6 @@ "smithy.api#documentation": "

The launch profile.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStreamingImage": { @@ -7966,23 +7896,14 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStreamingImageResponse": { "type": "structure", "members": { "streamingImage": { - "target": "com.amazonaws.nimble#StreamingImage", - "traits": { - "smithy.api#documentation": "

" - } + "target": "com.amazonaws.nimble#StreamingImage" } - }, - "traits": { - "smithy.api#documentation": "

" } }, "com.amazonaws.nimble#UpdateStudio": { @@ -8151,9 +8072,6 @@ "smithy.api#documentation": "

The type of the studio component.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStudioComponentResponse": { @@ -8165,9 +8083,6 @@ "smithy.api#documentation": "

Information about the studio component.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStudioRequest": { @@ -8209,9 +8124,6 @@ "smithy.api#documentation": "

The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.

" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStudioResponse": { @@ -8224,9 +8136,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ValidationException": { @@ -8260,7 +8169,6 @@ "com.amazonaws.nimble#WindowsMountDrive": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#pattern": "^[A-Z]$" } }, @@ -8280,22 +8188,22 @@ "aws.iam#defineConditionKeys": { "nimble:ownedBy": { "type": "String", - "documentation": "Filters access based on the ownedBy request parameter or the ID of the owner of the resource", + "documentation": "Filters access by the ownedBy request parameter or the ID of the owner of the resource", "externalDocumentation": "${ContextKeysDocRoot}" }, "nimble:principalId": { "type": "String", - "documentation": "Filters access based on the principalId request parameter", + "documentation": "Filters access by the principalId request parameter", "externalDocumentation": "${ContextKeysDocRoot}" }, "nimble:createdBy": { "type": "String", - "documentation": "Filters access based on the createdBy request parameter or the ID of the creator of the resource", + "documentation": "Filters access by the createdBy request parameter or the ID of the creator of the resource", "externalDocumentation": "${ContextKeysDocRoot}" }, "nimble:studioId": { "type": "String", - "documentation": "Filters access to resources in a specific studio", + "documentation": "Filters access by a specific studio", "externalDocumentation": "${ContextKeysDocRoot}" }, "aws:RequestTag/${TagKey}": { @@ -8310,7 +8218,7 @@ }, "nimble:requesterPrincipalId": { "type": "String", - "documentation": "Filters access to Nimble Studio portal using the ID of the logged in user", + "documentation": "Filters access by the ID of the logged in user", "externalDocumentation": "${ContextKeysDocRoot}" }, "aws:ResourceTag/${TagKey}": { diff --git a/aws/sdk/aws-models/outposts.json b/aws/sdk/aws-models/outposts.json index 4f9d5897a9..06c6ce89a6 100644 --- a/aws/sdk/aws-models/outposts.json +++ b/aws/sdk/aws-models/outposts.json @@ -585,6 +585,7 @@ "SiteId": { "target": "com.amazonaws.outposts#SiteId", "traits": { + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the site.\n

", "smithy.api#required": {} } }, @@ -742,7 +743,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "

\n The ID of the Outpost.\n

", + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -793,6 +794,7 @@ "SiteId": { "target": "com.amazonaws.outposts#SiteId", "traits": { + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the site.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1024,7 +1026,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "

\n The ID of the Outpost.\n

", + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1068,7 +1070,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "

\n The ID of the Outpost.\n

", + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1183,6 +1185,7 @@ "SiteId": { "target": "com.amazonaws.outposts#SiteId", "traits": { + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the site.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1223,6 +1226,7 @@ "SiteId": { "target": "com.amazonaws.outposts#SiteId", "traits": { + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the site.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1918,7 +1922,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostIdOnly", "traits": { - "smithy.api#documentation": "

The ID of the Outpost in the order.

" + "smithy.api#documentation": "

\n The ID of the Outpost in the order.\n

" } }, "OrderId": { @@ -2096,7 +2100,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "

The ID of the Outpost.

" + "smithy.api#documentation": "

\n The ID of the Outpost.\n

" } }, "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": "

The ID of the site.

", + "smithy.api#documentation": "

\n The ID of the site.\n

", "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": "

\n Updates an Outpost.\n

", + "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": "

\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n

", + "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": "

\n The type of hardware for this Outpost.\n

" + } + } + } + }, + "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": "

\n The ID or the Amazon Resource Name (ARN) of the site.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2977,6 +3052,7 @@ "SiteId": { "target": "com.amazonaws.outposts#SiteId", "traits": { + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the site.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3043,6 +3119,7 @@ "SiteId": { "target": "com.amazonaws.outposts#SiteId", "traits": { + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the site.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/aws/sdk/aws-models/qldb.json b/aws/sdk/aws-models/qldb.json index dfbbdb0c63..18464dd608 100644 --- a/aws/sdk/aws-models/qldb.json +++ b/aws/sdk/aws-models/qldb.json @@ -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": "

The control plane for Amazon QLDB

", + "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": "

The control plane for Amazon QLDB

", - "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": "

Creates a new ledger in your account in the current Region.

", + "smithy.api#documentation": "

Creates a new ledger in your Amazon Web Services account in the current Region.

", "smithy.api#http": { "method": "POST", "uri": "/ledgers", @@ -225,7 +225,7 @@ "Name": { "target": "com.amazonaws.qldb#LedgerName", "traits": { - "smithy.api#documentation": "

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.

\n

Naming constraints for ledger names are defined in Quotas in Amazon QLDB\n in the Amazon QLDB Developer Guide.

", + "smithy.api#documentation": "

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.

\n

Naming constraints for ledger names are defined in Quotas in Amazon QLDB\n in the Amazon QLDB Developer Guide.

", "smithy.api#required": {} } }, @@ -251,7 +251,7 @@ "KmsKey": { "target": "com.amazonaws.qldb#KmsKey", "traits": { - "smithy.api#documentation": "

The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.

\n

Use one of the following options to specify this parameter:

\n
    \n
  • \n

    \n AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.

    \n
  • \n
  • \n

    \n Undefined: By default, use an Amazon Web Services owned KMS\n key.

    \n
  • \n
  • \n

    \n A valid symmetric customer managed KMS key: Use\n the specified KMS key in your account that you create, own, and manage.

    \n

    Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer\n Guide.

    \n
  • \n
\n

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 \"alias/\". To specify a key in a different account, you must use the key\n ARN or alias ARN.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
  • \n
  • \n

    Alias ARN:\n arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n

    \n
  • \n
\n

For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.

\n

Use one of the following options to specify this parameter:

\n
    \n
  • \n

    \n AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.

    \n
  • \n
  • \n

    \n Undefined: By default, use an Amazon Web Services owned KMS\n key.

    \n
  • \n
  • \n

    \n A valid symmetric customer managed KMS key: Use\n the specified KMS key in your account that you create, own, and manage.

    \n

    Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer\n Guide.

    \n
  • \n
\n

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 \"alias/\". To specify a key in a different Amazon Web Services account, you must use the key\n ARN or alias ARN.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
  • \n
  • \n

    Alias ARN:\n arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n

    \n
  • \n
\n

For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.

" } } } @@ -613,7 +613,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

If the ledger with the given Name doesn't exist, then throws\n ResourceNotFoundException.

\n

If the ledger with the given Name is in CREATING status, then\n throws ResourcePreconditionNotMetException.

\n

You can initiate up to two concurrent journal export requests for each ledger. Beyond\n this limit, journal export requests throw LimitExceededException.

", + "smithy.api#documentation": "

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 JSON Lines text\n format.

\n

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 JSON Lines.

\n

If the ledger with the given Name doesn't exist, then throws\n ResourceNotFoundException.

\n

If the ledger with the given Name is in CREATING status, then\n throws ResourcePreconditionNotMetException.

\n

You can initiate up to two concurrent journal export requests for each ledger. Beyond\n this limit, journal export requests throw LimitExceededException.

", "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": "

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:

\n
    \n
  • \n

    Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

    \n
  • \n
  • \n

    (Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side\n encryption of your exported data.

    \n
  • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:

\n
    \n
  • \n

    Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

    \n
  • \n
  • \n

    (Optional) Use your customer managed key in Key Management Service (KMS) for server-side\n encryption of your exported data.

    \n
  • \n
\n

To pass a role to QLDB when requesting a journal export, you must have permissions to\n perform the iam:PassRole action on the IAM role resource. This is required for\n all journal export requests.

", "smithy.api#required": {} } + }, + "OutputFormat": { + "target": "com.amazonaws.qldb#OutputFormat", + "traits": { + "smithy.api#documentation": "

The output format of your exported journal data. If this parameter is not specified, the\n exported data defaults to ION_TEXT format.

" + } } } }, @@ -1053,14 +1059,14 @@ "InclusiveStartTime": { "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

The inclusive start date and time for the range of journal contents that are specified\n in the original export request.

", + "smithy.api#documentation": "

The inclusive start date and time for the range of journal contents that was specified\n in the original export request.

", "smithy.api#required": {} } }, "ExclusiveEndTime": { "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "

The exclusive end date and time for the range of journal contents that are specified in\n the original export request.

", + "smithy.api#documentation": "

The exclusive end date and time for the range of journal contents that was specified in\n the original export request.

", "smithy.api#required": {} } }, @@ -1073,9 +1079,15 @@ "RoleArn": { "target": "com.amazonaws.qldb#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:

\n
    \n
  • \n

    Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

    \n
  • \n
  • \n

    (Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side\n encryption of your exported data.

    \n
  • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:

\n
    \n
  • \n

    Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

    \n
  • \n
  • \n

    (Optional) Use your customer managed key in Key Management Service (KMS) for server-side\n encryption of your exported data.

    \n
  • \n
", "smithy.api#required": {} } + }, + "OutputFormat": { + "target": "com.amazonaws.qldb#OutputFormat", + "traits": { + "smithy.api#documentation": "

The output format of the exported journal data.

" + } } }, "traits": { @@ -1316,7 +1328,7 @@ "target": "com.amazonaws.qldb#ListJournalS3ExportsResponse" }, "traits": { - "smithy.api#documentation": "

Returns an array of journal export job descriptions for all ledgers that are associated\n with the current account and Region.

\n

This action returns a maximum of MaxResults items, and is paginated so that\n you can retrieve all the items by calling ListJournalS3Exports multiple\n times.

\n

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer\n Guide.

", + "smithy.api#documentation": "

Returns an array of journal export job descriptions for all ledgers that are associated\n with the current Amazon Web Services account and Region.

\n

This action returns a maximum of MaxResults items, and is paginated so that\n you can retrieve all the items by calling ListJournalS3Exports multiple\n times.

\n

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer\n Guide.

", "smithy.api#http": { "method": "GET", "uri": "/journal-s3-exports", @@ -1420,7 +1432,7 @@ "JournalS3Exports": { "target": "com.amazonaws.qldb#JournalS3ExportList", "traits": { - "smithy.api#documentation": "

The array of journal export job descriptions for all ledgers that are associated with\n the current account and Region.

" + "smithy.api#documentation": "

The array of journal export job descriptions for all ledgers that are associated with\n the current Amazon Web Services account and Region.

" } }, "NextToken": { @@ -1440,7 +1452,7 @@ "target": "com.amazonaws.qldb#ListLedgersResponse" }, "traits": { - "smithy.api#documentation": "

Returns an array of ledger summaries that are associated with the current account\n and Region.

\n

This action returns a maximum of 100 items and is paginated so that you can\n retrieve all the items by calling ListLedgers multiple times.

", + "smithy.api#documentation": "

Returns an array of ledger summaries that are associated with the current Amazon Web Services account\n and Region.

\n

This action returns a maximum of 100 items and is paginated so that you can\n retrieve all the items by calling ListLedgers multiple times.

", "smithy.api#http": { "method": "GET", "uri": "/ledgers", @@ -1478,7 +1490,7 @@ "Ledgers": { "target": "com.amazonaws.qldb#LedgerList", "traits": { - "smithy.api#documentation": "

The array of ledger summaries that are associated with the current account and\n Region.

" + "smithy.api#documentation": "

The array of ledger summaries that are associated with the current Amazon Web Services account and\n Region.

" } }, "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": "

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.

\n

You must provide a KmsKeyArn if you specify SSE_KMS as the\n ObjectEncryptionType.

\n

\n KmsKeyArn is not required if you specify SSE_S3 as the\n ObjectEncryptionType.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not\n support asymmetric KMS keys.

\n

You must provide a KmsKeyArn if you specify SSE_KMS as the\n ObjectEncryptionType.

\n

\n KmsKeyArn is not required if you specify SSE_S3 as the\n ObjectEncryptionType.

" } } }, @@ -1812,7 +1843,7 @@ "RoleArn": { "target": "com.amazonaws.qldb#Arn", "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

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.

\n

To pass a role to QLDB when requesting a journal stream, you must have permissions to\n perform the iam:PassRole action on the IAM role resource. This is required for\n all journal stream requests.

", "smithy.api#required": {} } }, @@ -2170,7 +2201,7 @@ "KmsKey": { "target": "com.amazonaws.qldb#KmsKey", "traits": { - "smithy.api#documentation": "

The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.

\n

Use one of the following options to specify this parameter:

\n
    \n
  • \n

    \n AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.

    \n
  • \n
  • \n

    \n Undefined: Make no changes to the KMS key of the\n ledger.

    \n
  • \n
  • \n

    \n A valid symmetric customer managed KMS key: Use\n the specified KMS key in your account that you create, own, and manage.

    \n

    Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer\n Guide.

    \n
  • \n
\n

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 \"alias/\". To specify a key in a different account, you must use the key\n ARN or alias ARN.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
  • \n
  • \n

    Alias ARN:\n arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n

    \n
  • \n
\n

For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.

\n

Use one of the following options to specify this parameter:

\n
    \n
  • \n

    \n AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.

    \n
  • \n
  • \n

    \n Undefined: Make no changes to the KMS key of the\n ledger.

    \n
  • \n
  • \n

    \n A valid symmetric customer managed KMS key: Use\n the specified KMS key in your account that you create, own, and manage.

    \n

    Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer\n Guide.

    \n
  • \n
\n

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 \"alias/\". To specify a key in a different Amazon Web Services account, you must use the key\n ARN or alias ARN.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
  • \n
  • \n

    Alias ARN:\n arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n

    \n
  • \n
\n

For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.

" } } } diff --git a/aws/sdk/aws-models/quicksight.json b/aws/sdk/aws-models/quicksight.json index 1390873166..f631f0fecd 100644 --- a/aws/sdk/aws-models/quicksight.json +++ b/aws/sdk/aws-models/quicksight.json @@ -1681,7 +1681,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a dataset.

", + "smithy.api#documentation": "

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/data-sets", @@ -2580,7 +2580,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates and starts a new SPICE ingestion on a dataset

\n\t\t\n\t\t

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", + "smithy.api#documentation": "

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.

\n\t\t\n\t\t

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", @@ -6800,7 +6800,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a dataset.

", + "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", @@ -17602,7 +17602,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a dataset.

", + "smithy.api#documentation": "

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", diff --git a/aws/sdk/aws-models/ram.json b/aws/sdk/aws-models/ram.json index e1909d82ad..2282a20f92 100644 --- a/aws/sdk/aws-models/ram.json +++ b/aws/sdk/aws-models/ram.json @@ -70,7 +70,7 @@ } ], "traits": { - "smithy.api#documentation": "

Accepts an invitation to a resource share from another Amazon Web Services account.

", + "smithy.api#documentation": "

Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the\n invitation, the resources included in the resource share are available to interact with in the\n relevant Amazon Web Services Management Consoles and tools.

", "smithy.api#http": { "method": "POST", "uri": "/acceptresourceshareinvitation", @@ -84,14 +84,14 @@ "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the invitation.

", + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the invitation that you want to accept.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

" } } } @@ -102,19 +102,34 @@ "resourceShareInvitation": { "target": "com.amazonaws.ram#ResourceShareInvitation", "traits": { - "smithy.api#documentation": "

Information about the invitation.

" + "smithy.api#documentation": "

An object that contains information about the specified invitation.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } }, "com.amazonaws.ram#AmazonResourceSharing": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "RAM", + "arnNamespace": "ram", + "cloudFormationName": "RAM", + "cloudTrailEventSource": "ram.amazonaws.com", + "endpointPrefix": "ram" + }, + "aws.auth#sigv4": { + "name": "ram" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

This is the Resource Access Manager API Reference. This documentation provides\n descriptions and syntax for each of the actions and data types in RAM. RAM is a\n service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you\n have multiple Amazon Web Services accounts, you can use RAM to share those resources with other\n accounts. If you use Organizations to manage your accounts, then you share your resources\n with your organization or organizational units (OUs). For supported resource types, you\n can also share resources with individual Identity and Access Management (IAM) roles an users.

\n \n

To learn more about RAM, see the following resources:

\n ", + "smithy.api#title": "AWS Resource Access Manager" + }, "version": "2018-01-04", "operations": [ { @@ -189,22 +204,7 @@ { "target": "com.amazonaws.ram#UpdateResourceShare" } - ], - "traits": { - "aws.api#service": { - "sdkId": "RAM", - "arnNamespace": "ram", - "cloudFormationName": "RAM", - "cloudTrailEventSource": "ram.amazonaws.com", - "endpointPrefix": "ram" - }, - "aws.auth#sigv4": { - "name": "ram" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This is the Resource Access Manager API Reference. This documentation provides\n descriptions and syntax for each of the actions and data types in RAM. RAM is a\n service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts and\n within your organization or organizational units (OUs) in Organizations. For supported\n resource types, you can also share resources with IAM roles and IAM users. If you have\n multiple Amazon Web Services accounts, you can use RAM to share those resources with other\n accounts.

\n\n

To learn more about RAM, see the following resources:

\n\n ", - "smithy.api#title": "AWS Resource Access Manager" - } + ] }, "com.amazonaws.ram#AssociateResourceShare": { "type": "operation", @@ -242,12 +242,15 @@ { "target": "com.amazonaws.ram#ServiceUnavailableException" }, + { + "target": "com.amazonaws.ram#ThrottlingException" + }, { "target": "com.amazonaws.ram#UnknownResourceException" } ], "traits": { - "smithy.api#documentation": "

Associates the specified resource share with the specified principals and resources.

", + "smithy.api#documentation": "

Adds the specified list of principals and list of resources to a resource share. Principals that\n already have access to this resource share immediately receive access to the added resources.\n Newly added principals immediately receive access to the resources shared in this resource share.

", "smithy.api#http": { "method": "POST", "uri": "/associateresourceshare", @@ -287,7 +290,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a permission with a resource share.

", + "smithy.api#documentation": "

Adds or replaces the RAM permission for a resource type included in a resource share. You can\n have exactly one permission associated with each resource type in the resource share. You can add\n a new RAM permission only if there are currently no resources of that resource type\n currently in the resource share.

", "smithy.api#http": { "method": "POST", "uri": "/associateresourcesharepermission", @@ -301,33 +304,33 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource share to which you want to add or replace\n permissions.

", "smithy.api#required": {} } }, "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RAM permission to associate with the\n resource share.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the RAM permission to associate with the resource share.\n To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and \n then choose the name of the permission. The ARN is displayed on the detail page.

", "smithy.api#required": {} } }, "replace": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the permission should replace the permissions that are currently\n associated with the resource share. Use true to replace the current permissions. Use\n false to add the permission to the current permission.

" + "smithy.api#documentation": "

Specifies whether the specified permission should replace or add to the existing\n permission associated with the resource share. Use true to replace the current\n permissions. Use false to add the permission to the current permission. The\n default value is false.

\n \n

A resource share can have only one permission per resource type. If a resource share already has a\n permission for the specified resource type and you don't set replace to\n true then the operation returns an error. This helps prevent\n accidental overwriting of a permission.

\n
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

" } }, "permissionVersion": { "target": "com.amazonaws.ram#Integer", "traits": { - "smithy.api#documentation": "

The version of the RAM permissions to associate with the resource share.

" + "smithy.api#documentation": "

Specifies the version of the RAM permission to associate with the resource share. If you don't\n specify this parameter, the operation uses the version designated as the default.

" } } } @@ -338,13 +341,13 @@ "returnValue": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the request succeeded.

" + "smithy.api#documentation": "

A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } @@ -355,26 +358,26 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to add principals or resources\n to.

", "smithy.api#required": {} } }, "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the resources.

" + "smithy.api#documentation": "

Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be\n null if you want to add only principals.

" } }, "principals": { "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { - "smithy.api#documentation": "

The principals to associate with the resource share. The possible values are:

\n
    \n
  • \n

    An Amazon Web Services account ID

    \n
  • \n
  • \n

    An Amazon Resource Name (ARN) of an organization in Organizations

    \n
  • \n
  • \n

    An ARN of an organizational unit (OU) in Organizations

    \n
  • \n
  • \n

    An ARN of an IAM role

    \n
  • \n
  • \n

    An ARN of an IAM user

    \n
  • \n
\n \n

Not all resource types can be shared with IAM roles and IAM users. For more\n information, see Sharing with IAM roles and IAM users in the Resource Access Manager User\n Guide.

\n
" + "smithy.api#documentation": "

Specifies a list of principals to whom you want to the resource share. This can be\n null if you want to add only resources.

\n

What the principals can do with the resources in the share is determined by the RAM\n permissions that you associate with the resource share. See AssociateResourceSharePermission.

\n

You can include the following values:

\n
    \n
  • \n

    An Amazon Web Services account ID, for example: 123456789012\n

    \n
  • \n
  • \n

    An Amazon Resoure Name (ARN) of an organization in Organizations, for example:\n organizations::123456789012:organization/o-exampleorgid\n

    \n
  • \n
  • \n

    An ARN of an organizational unit (OU) in Organizations, for example:\n organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123\n

    \n
  • \n
  • \n

    An ARN of an IAM role, for example:\n iam::123456789012:role/rolename\n

    \n
  • \n
  • \n

    An ARN of an IAM user, for example:\n iam::123456789012user/username\n

    \n
  • \n
\n \n

Not all resource types can be shared with IAM roles and users. \n For more information, see Sharing with IAM roles and users in the Resource Access Manager User\n Guide.

\n
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

" } } } @@ -385,13 +388,13 @@ "resourceShareAssociations": { "target": "com.amazonaws.ram#ResourceShareAssociationList", "traits": { - "smithy.api#documentation": "

Information about the associations.

" + "smithy.api#documentation": "

An array of objects that contain information about the associations.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } @@ -446,7 +449,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a resource share. You must provide a list of the Amazon Resource Names (ARNs) for the\n resources you want to share. You must also specify who you want to share the resources\n with, and the permissions that you grant them.

\n \n

Sharing a resource makes it available for use by principals outside of the\n Amazon Web Services account that created the resource. Sharing doesn't change any permissions or\n quotas that apply to the resource in the account that created it.

\n
", + "smithy.api#documentation": "

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you\n want to share, a list of principals you want to share the resources with, and the\n permissions to grant those principals.

\n \n

Sharing a resource makes it available for use by principals outside of the\n Amazon Web Services account that created the resource. Sharing doesn't change any permissions or\n quotas that apply to the resource in the account that created it.

\n
", "smithy.api#http": { "method": "POST", "uri": "/createresourceshare", @@ -460,44 +463,44 @@ "name": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The name of the resource share.

", + "smithy.api#documentation": "

Specifies the name of the resource share.

", "smithy.api#required": {} } }, "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { - "smithy.api#documentation": "

The ARNs of the resources to associate with the resource share.

" + "smithy.api#documentation": "

Specifies a list of one or more ARNs of the resources to associate with the\n resource share.

" } }, "principals": { "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { - "smithy.api#documentation": "

The principals to associate with the resource share. The possible values are:

\n
    \n
  • \n

    An Amazon Web Services account ID

    \n
  • \n
  • \n

    An Amazon Resource Name (ARN) of an organization in Organizations

    \n
  • \n
  • \n

    An ARN of an organizational unit (OU) in Organizations

    \n
  • \n
  • \n

    An ARN of an IAM role

    \n
  • \n
  • \n

    An ARN of an IAM user

    \n
  • \n
\n \n

Not all resource types can be shared with IAM roles and IAM users. For more\n information, see Sharing with IAM roles and IAM users in the Resource Access Manager User\n Guide.

\n
" + "smithy.api#documentation": "

Specifies a list of one or more principals to associate with the resource share.

\n

You can include the following values:

\n
    \n
  • \n

    An Amazon Web Services account ID, for example: 123456789012\n

    \n
  • \n
  • \n

    An Amazon Resoure Name (ARN) of an organization in Organizations, for example:\n organizations::123456789012:organization/o-exampleorgid\n

    \n
  • \n
  • \n

    An ARN of an organizational unit (OU) in Organizations, for example:\n organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123\n

    \n
  • \n
  • \n

    An ARN of an IAM role, for example:\n iam::123456789012:role/rolename\n

    \n
  • \n
  • \n

    An ARN of an IAM user, for example:\n iam::123456789012user/username\n

    \n
  • \n
\n \n

Not all resource types can be shared with IAM roles and users. \n For more information, see Sharing with IAM roles and users in the Resource Access Manager User\n Guide.

\n
" } }, "tags": { "target": "com.amazonaws.ram#TagList", "traits": { - "smithy.api#documentation": "

One or more tags.

" + "smithy.api#documentation": "

Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to\n the resources associated with the resource share.

" } }, "allowExternalPrincipals": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether principals outside your organization in Organizations can be associated\n with a resource share.

" + "smithy.api#documentation": "

Specifies whether principals outside your organization in Organizations can be associated\n with a resource share. A value of true lets you share with individual Amazon Web Services accounts\n that are not in your organization. A value of false\n only has meaning if your account is a member of an Amazon Web Services Organization. The default value\n is true.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

" } }, "permissionArns": { "target": "com.amazonaws.ram#PermissionArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the permissions to associate with the resource share. If you\n do not specify an ARN for the permission, RAM automatically attaches the default\n version of the permission for each resource type. Only one permission can be associated\n with each resource type in a resource share.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do\n not specify an ARN for the permission, RAM automatically attaches the default version\n of the permission for each resource type. You can associate only one permission with\n each resource type included in the resource share.

" } } } @@ -508,13 +511,13 @@ "resourceShare": { "target": "com.amazonaws.ram#ResourceShare", "traits": { - "smithy.api#documentation": "

Information about the resource share.

" + "smithy.api#documentation": "

An object with information about the new resource share.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } @@ -560,7 +563,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified resource share.

", + "smithy.api#documentation": "

Deletes the specified resource share. This doesn't delete any of the resources that were\n associated with the resource share; it only stops the sharing of those resources outside of the\n Amazon Web Services account that created them.

", "smithy.api#http": { "method": "DELETE", "uri": "/deleteresourceshare", @@ -574,7 +577,7 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource share to delete.

", "smithy.api#httpQuery": "resourceShareArn", "smithy.api#required": {} } @@ -582,7 +585,7 @@ "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

", "smithy.api#httpQuery": "clientToken" } } @@ -594,14 +597,14 @@ "returnValue": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the request succeeded.

", + "smithy.api#documentation": "

A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.

", "smithy.api#xmlName": "return" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } @@ -690,7 +693,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates an RAM permission from a resource share.

", + "smithy.api#documentation": "

Disassociates an RAM permission from a resource share. Permission changes take effect\n immediately. You can remove a RAM permission from a resource share only if there are currently\n no resources of the relevant resource type currently attached to the resource share.

", "smithy.api#http": { "method": "POST", "uri": "/disassociateresourcesharepermission", @@ -704,21 +707,21 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the resource share from which you want to disassociate a permission.

", "smithy.api#required": {} } }, "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the permission to disassociate from the resource share.

", + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the permission to disassociate from the resource share. Changes to permissions\n take effect immediately.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

" } } } @@ -729,13 +732,13 @@ "returnValue": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the request succeeded.

" + "smithy.api#documentation": "

A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } @@ -746,26 +749,26 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

Specifies Amazon Resoure Name (ARN) of the resource share that you want to remove resources from.

", "smithy.api#required": {} } }, "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the resources.

" + "smithy.api#documentation": "

Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from\n the resource share. After the operation runs, these resources are no longer shared with principals\n outside of the Amazon Web Services account that created the resources.

" } }, "principals": { "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { - "smithy.api#documentation": "

The principals.

" + "smithy.api#documentation": "

Specifies a list of one or more principals that no longer are to have access to the\n resources in this resource share.

\n

You can include the following values:

\n
    \n
  • \n

    An Amazon Web Services account ID, for example: 123456789012\n

    \n
  • \n
  • \n

    An Amazon Resoure Name (ARN) of an organization in Organizations, for example:\n organizations::123456789012:organization/o-exampleorgid\n

    \n
  • \n
  • \n

    An ARN of an organizational unit (OU) in Organizations, for example:\n organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123\n

    \n
  • \n
  • \n

    An ARN of an IAM role, for example:\n iam::123456789012:role/rolename\n

    \n
  • \n
  • \n

    An ARN of an IAM user, for example:\n iam::123456789012user/username\n

    \n
  • \n
\n \n

Not all resource types can be shared with IAM roles and users. \n For more information, see Sharing with IAM roles and users in the Resource Access Manager User\n Guide.

\n
" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

" } } } @@ -776,13 +779,13 @@ "resourceShareAssociations": { "target": "com.amazonaws.ram#ResourceShareAssociationList", "traits": { - "smithy.api#documentation": "

Information about the associations.

" + "smithy.api#documentation": "

An array of objects that contain information about the updated associations for this\n resource share.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } @@ -807,7 +810,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables resource sharing within your organization in Organizations.

\n

The caller must be the master account for the organization.

", + "smithy.api#documentation": "

Enables resource sharing within your organization in Organizations. Calling this operation\n enables RAM to retrieve information about the organization and its structure. This\n lets you share resources with all of the accounts in an organization by specifying the\n organization's ID, or all of the accounts in an organizational unit (OU) by specifying\n the OU's ID. Until you enable sharing within the organization, you can specify only\n individual Amazon Web Services accounts, or for supported resource types, IAM users and\n roles.

\n

You must call this operation from an IAM user or role in the organization's\n management account.

", "smithy.api#http": { "method": "POST", "uri": "/enablesharingwithawsorganization", @@ -825,7 +828,7 @@ "returnValue": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the request succeeded.

", + "smithy.api#documentation": "

A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.

", "smithy.api#xmlName": "return" } } @@ -874,14 +877,14 @@ "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the permission.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the permission whose contents you want to retrieve.\n To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and \n then choose the name of the permission. The ARN is displayed on the detail page.

", "smithy.api#required": {} } }, "permissionVersion": { "target": "com.amazonaws.ram#Integer", "traits": { - "smithy.api#documentation": "

The identifier for the version of the permission.

" + "smithy.api#documentation": "

Specifies identifier for the version of the RAM permission to retrieve. If you don't\n specify this parameter, the operation retrieves the default version.

" } } } @@ -892,7 +895,7 @@ "permission": { "target": "com.amazonaws.ram#ResourceSharePermissionDetail", "traits": { - "smithy.api#documentation": "

Information about the permission.

" + "smithy.api#documentation": "

An object that contains information about the permission.

" } } } @@ -926,7 +929,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the policies for the specified resources that you own and have shared.

", + "smithy.api#documentation": "

Retrieves the resource policies for the specified resources that you own and have\n shared.

", "smithy.api#http": { "method": "POST", "uri": "/getresourcepolicies", @@ -945,26 +948,26 @@ "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the resources.

", + "smithy.api#documentation": "

Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

", "smithy.api#required": {} } }, "principal": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The principal.

" + "smithy.api#documentation": "

Specifies the principal.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" } } } @@ -975,13 +978,13 @@ "policies": { "target": "com.amazonaws.ram#PolicyList", "traits": { - "smithy.api#documentation": "

A key policy document, in JSON format.

" + "smithy.api#documentation": "

An array of resource policy documents in JSON format.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1018,7 +1021,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the resources or principals for the resource shares that you own.

", + "smithy.api#documentation": "

Retrieves the resource and principal associations for resource shares that you own.

", "smithy.api#http": { "method": "POST", "uri": "/getresourceshareassociations", @@ -1037,44 +1040,44 @@ "associationType": { "target": "com.amazonaws.ram#ResourceShareAssociationType", "traits": { - "smithy.api#documentation": "

The association type. Specify PRINCIPAL to list the principals that are\n associated with the specified resource share. Specify RESOURCE to list the resources\n that are associated with the specified resource share.

", + "smithy.api#documentation": "

Specifies whether you want to retrieve the associations that involve a specified\n resource or principal.

\n
    \n
  • \n

    \n PRINCIPAL – list the principals that are associated with\n the specified resource share.

    \n
  • \n
  • \n

    \n RESOURCE – list the resources that are associated with the\n specified resource share.

    \n
  • \n
", "smithy.api#required": {} } }, "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resource shares.

" + "smithy.api#documentation": "

Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to\n retrieve.

" } }, "resourceArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if\n the association type is PRINCIPAL.

" + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource whose resource shares you want to retrieve.

\n

You cannot specify this parameter if the association type is\n PRINCIPAL.

" } }, "principal": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The principal. You cannot specify this parameter if the association type is\n RESOURCE.

" + "smithy.api#documentation": "

Specifies the ID of the principal whose resource shares you want to retrieve. This can be an\n Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resoure Name (ARN) of an\n individual IAM user or role.

\n

You cannot specify this parameter if the association type is\n RESOURCE.

" } }, "associationStatus": { "target": "com.amazonaws.ram#ResourceShareAssociationStatus", "traits": { - "smithy.api#documentation": "

The association status.

" + "smithy.api#documentation": "

Specifies that you want to retrieve only associations with this status.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" } } } @@ -1085,13 +1088,13 @@ "resourceShareAssociations": { "target": "com.amazonaws.ram#ResourceShareAssociationList", "traits": { - "smithy.api#documentation": "

Information about the associations.

" + "smithy.api#documentation": "

An array of objects that contain the details about the associations.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1131,7 +1134,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the invitations that you have received for resource shares.

", + "smithy.api#documentation": "

Retrieves details about invitations that you have received for resource shares.

", "smithy.api#http": { "method": "POST", "uri": "/getresourceshareinvitations", @@ -1150,25 +1153,25 @@ "resourceShareInvitationArns": { "target": "com.amazonaws.ram#ResourceShareInvitationArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the invitations.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

" } }, "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resource shares.

" + "smithy.api#documentation": "

Specifies that you want details about invitations only for the resource shares described by this\n list of Amazon Resource Names (ARNs)\n

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" } } } @@ -1179,13 +1182,13 @@ "resourceShareInvitations": { "target": "com.amazonaws.ram#ResourceShareInvitationList", "traits": { - "smithy.api#documentation": "

Information about the invitations.

" + "smithy.api#documentation": "

An array of objects that contain the details about the invitations.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1219,7 +1222,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the resource shares that you own or the resource shares that are shared with you.

", + "smithy.api#documentation": "

Retrieves details about the resource shares that you own or that are shared with you.

", "smithy.api#http": { "method": "POST", "uri": "/getresourceshares", @@ -1238,50 +1241,50 @@ "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the resource shares.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

" } }, "resourceShareStatus": { "target": "com.amazonaws.ram#ResourceShareStatus", "traits": { - "smithy.api#documentation": "

The status of the resource share.

" + "smithy.api#documentation": "

Specifies that you want to retrieve details of only those resource shares that have this\n status.

" } }, "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { - "smithy.api#documentation": "

The type of owner.

", + "smithy.api#documentation": "

Specifies that you want to retrieve details of only those resource shares that match the\n following:

\n
    \n
  • \n

    \n \n SELF\n – resources that you\n are sharing

    \n
  • \n
  • \n

    \n \n OTHER-ACCOUNTS\n –\n resources that other accounts share with you

    \n
  • \n
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The name of the resource share.

" + "smithy.api#documentation": "

Specifies the name of an individual resource share that you want to retrieve details\n about.

" } }, "tagFilters": { "target": "com.amazonaws.ram#TagFilters", "traits": { - "smithy.api#documentation": "

One or more tag filters.

" + "smithy.api#documentation": "

Specifies that you want to retrieve details of only those resource shares that match the\n specified tag keys and values.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" } }, "permissionArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RAM permission that is associated with the\n resource share.

" + "smithy.api#documentation": "

Specifies that you want to retrieve details of only those resource shares that use the RAM\n permission with this Amazon Resoure Name (ARN).

" } } } @@ -1292,13 +1295,13 @@ "resourceShares": { "target": "com.amazonaws.ram#ResourceShareList", "traits": { - "smithy.api#documentation": "

Information about the resource shares.

" + "smithy.api#documentation": "

An array of objects that contain the information about the resource shares.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1318,7 +1321,7 @@ "code": "IdempotentParameterMismatch", "httpResponseCode": 400 }, - "smithy.api#documentation": "

A client token input parameter was reused with an operation, but at least one of the\n other input parameters is different from the previous call to the operation.

", + "smithy.api#documentation": "

The client token input parameter was matched one used with a previous call to the\n operation, but at least one of the other input parameters is different from the previous\n call.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1344,7 +1347,7 @@ "code": "InvalidClientToken", "httpResponseCode": 400 }, - "smithy.api#documentation": "

A client token is not valid.

", + "smithy.api#documentation": "

The client token is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1364,7 +1367,7 @@ "code": "InvalidMaxResults", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The specified value for MaxResults is not valid.

", + "smithy.api#documentation": "

The specified value for MaxResults is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1384,7 +1387,7 @@ "code": "InvalidNextToken", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The specified value for NextToken is not valid.

", + "smithy.api#documentation": "

The specified value for NextToken is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1487,7 +1490,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the resources in a resource share that is shared with you but that the invitation is still\n pending for.

", + "smithy.api#documentation": "

Lists the resources in a resource share that is shared with you but for which the invitation is\n still PENDING. That means that you haven't accepted or rejected the\n invitation and the invitation hasn't expired.

", "smithy.api#http": { "method": "POST", "uri": "/listpendinginvitationresources", @@ -1506,20 +1509,26 @@ "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the invitation.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" + } + }, + "resourceRegionScope": { + "target": "com.amazonaws.ram#ResourceRegionScopeFilter", + "traits": { + "smithy.api#documentation": "

Specifies that you want the results to include only \n resources that have the specified scope.

\n
    \n
  • \n

    \n ALL – the results include both global and \n regional resources or resource types.

    \n
  • \n
  • \n

    \n GLOBAL – the results include only global \n resources or resource types.

    \n
  • \n
  • \n

    \n REGIONAL – the results include only regional \n resources or resource types.

    \n
  • \n
\n

The default value is ALL.

" } } } @@ -1530,13 +1539,13 @@ "resources": { "target": "com.amazonaws.ram#ResourceList", "traits": { - "smithy.api#documentation": "

Information about the resources included the resource share.

" + "smithy.api#documentation": "

An array of objects that contain the information about the resources included the\n specified resource share.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1567,7 +1576,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the RAM permissions.

", + "smithy.api#documentation": "

Retrieves a list of available RAM permissions that you can use for the supported\n resource types.

", "smithy.api#http": { "method": "POST", "uri": "/listpermissions", @@ -1586,19 +1595,19 @@ "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

Specifies the resource type for which to list permissions. For example, to list only\n permissions that apply to EC2 subnets, specify ec2:Subnet.

" + "smithy.api#documentation": "

Specifies that you want to list permissions for only the specified resource type. For\n example, to list only permissions that apply to EC2 subnets, specify\n ec2:Subnet. You can use the ListResourceTypes\n operation to get the specific string required.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" } } } @@ -1609,13 +1618,13 @@ "permissions": { "target": "com.amazonaws.ram#ResourceSharePermissionList", "traits": { - "smithy.api#documentation": "

Information about the permissions.

" + "smithy.api#documentation": "

An array of objects with information about the permissions.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1649,7 +1658,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the principals that you have shared resources with or that have shared resources\n with you.

", + "smithy.api#documentation": "

Lists the principals that you are sharing resources with or that are sharing resources\n with you.

", "smithy.api#http": { "method": "POST", "uri": "/listprincipals", @@ -1668,44 +1677,44 @@ "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { - "smithy.api#documentation": "

The type of owner.

", + "smithy.api#documentation": "

Specifies that you want to list information for only resource shares that match the\n following:

\n
    \n
  • \n

    \n \n SELF\n – resources that you\n are sharing

    \n
  • \n
  • \n

    \n \n OTHER-ACCOUNTS\n –\n resources that other accounts share with you

    \n
  • \n
", "smithy.api#required": {} } }, "resourceArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + "smithy.api#documentation": "

Specifies that you want to list principal information for the resource share with the specified\n Amazon Resoure Name (ARN).

" } }, "principals": { "target": "com.amazonaws.ram#PrincipalArnOrIdList", "traits": { - "smithy.api#documentation": "

The principals.

" + "smithy.api#documentation": "

Specifies that you want to list information for only the listed principals.

\n

You can include the following values:

\n
    \n
  • \n

    An Amazon Web Services account ID, for example: 123456789012\n

    \n
  • \n
  • \n

    An Amazon Resoure Name (ARN) of an organization in Organizations, for example:\n organizations::123456789012:organization/o-exampleorgid\n

    \n
  • \n
  • \n

    An ARN of an organizational unit (OU) in Organizations, for example:\n organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123\n

    \n
  • \n
  • \n

    An ARN of an IAM role, for example:\n iam::123456789012:role/rolename\n

    \n
  • \n
  • \n

    An ARN of an IAM user, for example:\n iam::123456789012user/username\n

    \n
  • \n
\n \n

Not all resource types can be shared with IAM roles and users. \n For more information, see Sharing with IAM roles and users in the Resource Access Manager User\n Guide.

\n
" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The resource type.

\n

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan\n

" + "smithy.api#documentation": "

Specifies that you want to list information for only principals associated with resource shares\n that include the specified resource type.

\n

For a list of valid values, query the ListResourceTypes operation.

" } }, "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resource shares.

" + "smithy.api#documentation": "

Specifies that you want to list information for only principals associated with the\n resource shares specified by a list the Amazon Resource Names (ARNs).

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" } } } @@ -1716,13 +1725,13 @@ "principals": { "target": "com.amazonaws.ram#PrincipalList", "traits": { - "smithy.api#documentation": "

The principals.

" + "smithy.api#documentation": "

An array of objects that contain the details about the principals.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1778,20 +1787,20 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource share for which you want to retrieve the associated\n permissions.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" } } } @@ -1802,13 +1811,13 @@ "permissions": { "target": "com.amazonaws.ram#ResourceSharePermissionList", "traits": { - "smithy.api#documentation": "

The permissions associated with the resource share.

" + "smithy.api#documentation": "

An array of objects that describe the permissions associated with the resource share.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1836,7 +1845,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the shareable resource types supported by RAM.

", + "smithy.api#documentation": "

Lists the resource types that can be shared by RAM.

", "smithy.api#http": { "method": "POST", "uri": "/listresourcetypes", @@ -1855,13 +1864,19 @@ "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" + } + }, + "resourceRegionScope": { + "target": "com.amazonaws.ram#ResourceRegionScopeFilter", + "traits": { + "smithy.api#documentation": "

Specifies that you want the results to include only \n resources that have the specified scope.

\n
    \n
  • \n

    \n ALL – the results include both global and \n regional resources or resource types.

    \n
  • \n
  • \n

    \n GLOBAL – the results include only global \n resources or resource types.

    \n
  • \n
  • \n

    \n REGIONAL – the results include only regional \n resources or resource types.

    \n
  • \n
\n

The default value is ALL.

" } } } @@ -1872,13 +1887,13 @@ "resourceTypes": { "target": "com.amazonaws.ram#ServiceNameAndResourceTypeList", "traits": { - "smithy.api#documentation": "

The shareable resource types supported by RAM.

" + "smithy.api#documentation": "

An array of objects that contain information about the resource types that can be\n shared using RAM.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -1934,44 +1949,50 @@ "resourceOwner": { "target": "com.amazonaws.ram#ResourceOwner", "traits": { - "smithy.api#documentation": "

The type of owner.

", + "smithy.api#documentation": "

Specifies that you want to list only the resource shares that match the following:

\n
    \n
  • \n

    \n \n SELF\n – resources that you\n are sharing

    \n
  • \n
  • \n

    \n \n OTHER-ACCOUNTS\n –\n resources that other accounts share with you

    \n
  • \n
", "smithy.api#required": {} } }, "principal": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The principal.

" + "smithy.api#documentation": "

Specifies that you want to list only the resource shares that are associated with the specified\n principal.

" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The resource type.

\n

Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan\n

" + "smithy.api#documentation": "

Specifies that you want to list only the resource shares that include resources of the specified\n resource type.

\n

For valid values, query the ListResourceTypes operation.

" } }, "resourceArns": { "target": "com.amazonaws.ram#ResourceArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the resources.

" + "smithy.api#documentation": "

Specifies that you want to list only the resource shares that include resources with the\n specified Amazon Resource Names (ARNs).

" } }, "resourceShareArns": { "target": "com.amazonaws.ram#ResourceShareArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the resource shares.

" + "smithy.api#documentation": "

Specifies that you want to list only resources in the resource shares identified by the\n specified Amazon Resource Names (ARNs).

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.

" } }, "maxResults": { "target": "com.amazonaws.ram#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + "smithy.api#documentation": "

Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.

" + } + }, + "resourceRegionScope": { + "target": "com.amazonaws.ram#ResourceRegionScopeFilter", + "traits": { + "smithy.api#documentation": "

Specifies that you want the results to include only \n resources that have the specified scope.

\n
    \n
  • \n

    \n ALL – the results include both global and \n regional resources or resource types.

    \n
  • \n
  • \n

    \n GLOBAL – the results include only global \n resources or resource types.

    \n
  • \n
  • \n

    \n REGIONAL – the results include only regional \n resources or resource types.

    \n
  • \n
\n

The default value is ALL.

" } } } @@ -1982,13 +2003,13 @@ "resources": { "target": "com.amazonaws.ram#ResourceList", "traits": { - "smithy.api#documentation": "

Information about the resources.

" + "smithy.api#documentation": "

An array of objects that contain information about the resources.

" } }, "nextToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + "smithy.api#documentation": "

If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.

" } } } @@ -2096,19 +2117,19 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of a resource share the principal is associated with.

" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

The time when the principal was associated with the resource share.

" + "smithy.api#documentation": "

The date and time when the principal was associated with the resource share.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

The time when the association was last updated.

" + "smithy.api#documentation": "

The date and time when the association was last updated.

" } }, "external": { @@ -2175,7 +2196,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resource shares that were created by attaching a policy to a resource are visible only\n to the resource share owner, and the resource share cannot be modified in RAM.

\n\n

Use this API action to promote the resource share. When you promote the resource\n share, it becomes:

\n
    \n
  • \n

    Visible to all principals that it is shared with.

    \n
  • \n
  • \n

    Modifiable in RAM.

    \n
  • \n
", + "smithy.api#documentation": "

When you attach a resource-based permission policy to a resource, it automatically\n creates a resource share. However, resource shares created this way are visible only to the resource share\n owner, and the resource share can't be modified in RAM.

\n

You can use this operation to promote the resource share to a full RAM resource share. When you promote\n a resource share, you can then manage the resource share in RAM and it becomes visible to all of the\n principals you shared it with.

", "smithy.api#http": { "method": "POST", "uri": "/promoteresourcesharecreatedfrompolicy", @@ -2189,7 +2210,7 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share to promote.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource share to promote.

", "smithy.api#httpQuery": "resourceShareArn", "smithy.api#required": {} } @@ -2202,7 +2223,7 @@ "returnValue": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the request succeeded.

", + "smithy.api#documentation": "

A return value of true indicates that the request succeeded. \n A value of false indicates that the request failed.

", "smithy.api#xmlName": "return" } } @@ -2263,14 +2284,14 @@ "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the invitation.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the invitation that you want to reject.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

" } } } @@ -2281,13 +2302,13 @@ "resourceShareInvitation": { "target": "com.amazonaws.ram#ResourceShareInvitation", "traits": { - "smithy.api#documentation": "

Information about the invitation.

" + "smithy.api#documentation": "

An object that contains the details about the rejected invitation.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } @@ -2298,31 +2319,31 @@ "arn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the resource.

" } }, "type": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The resource type.

" + "smithy.api#documentation": "

The resource type. This takes the form of:\n service-code:resource-code\n

" } }, "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the resource share this resource is associated with.

" } }, "resourceGroupArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource group. This value is returned only if\n the resource is a resource group.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the resource group. This value is available only if the resource is\n part of a resource group.

" } }, "status": { "target": "com.amazonaws.ram#ResourceStatus", "traits": { - "smithy.api#documentation": "

The status of the resource.

" + "smithy.api#documentation": "

The current status of the resource.

" } }, "statusMessage": { @@ -2334,18 +2355,24 @@ "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

The time when the resource was associated with the resource share.

" + "smithy.api#documentation": "

The date and time when the resource was associated with the resource share.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

The time when the association was last updated.

" + "smithy.api#documentation": "

The date an time when the association was last updated.

" + } + }, + "resourceRegionScope": { + "target": "com.amazonaws.ram#ResourceRegionScope", + "traits": { + "smithy.api#documentation": "

Specifies the scope of visibility of this resource:

\n
    \n
  • \n

    \n REGIONAL – The resource can be\n accessed only by using requests that target the Amazon Web Services Region in which the\n resource exists.

    \n
  • \n
  • \n

    \n GLOBAL – The resource can be accessed\n from any Amazon Web Services Region.

    \n
  • \n
" } } }, "traits": { - "smithy.api#documentation": "

Describes a resource associated with a resource share.

" + "smithy.api#documentation": "

Describes a resource associated with a resource share in RAM.

" } }, "com.amazonaws.ram#ResourceArnList": { @@ -2372,7 +2399,7 @@ "code": "InvalidResourceArn.NotFound", "httpResponseCode": 400 }, - "smithy.api#documentation": "

An Amazon Resource Name (ARN) was not found.

", + "smithy.api#documentation": "

The specified Amazon Resource Name (ARN) was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2401,13 +2428,47 @@ ] } }, + "com.amazonaws.ram#ResourceRegionScope": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REGIONAL", + "name": "REGIONAL" + }, + { + "value": "GLOBAL", + "name": "GLOBAL" + } + ] + } + }, + "com.amazonaws.ram#ResourceRegionScopeFilter": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "REGIONAL", + "name": "REGIONAL" + }, + { + "value": "GLOBAL", + "name": "GLOBAL" + } + ] + } + }, "com.amazonaws.ram#ResourceShare": { "type": "structure", "members": { "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the resource share

" } }, "name": { @@ -2431,7 +2492,7 @@ "status": { "target": "com.amazonaws.ram#ResourceShareStatus", "traits": { - "smithy.api#documentation": "

The status of the resource share.

" + "smithy.api#documentation": "

The current status of the resource share.

" } }, "statusMessage": { @@ -2443,30 +2504,30 @@ "tags": { "target": "com.amazonaws.ram#TagList", "traits": { - "smithy.api#documentation": "

The tags for the resource share.

" + "smithy.api#documentation": "

The tag key and value pairs attached to the resource share.

" } }, "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

The time when the resource share was created.

" + "smithy.api#documentation": "

The date and time when the resource share was created.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

The time when the resource share was last updated.

" + "smithy.api#documentation": "

The date and time when the resource share was last updated.

" } }, "featureSet": { "target": "com.amazonaws.ram#ResourceShareFeatureSet", "traits": { - "smithy.api#documentation": "

Indicates how the resource share was created. Possible values include:

\n
    \n
  • \n

    \n CREATED_FROM_POLICY - Indicates that the resource share was created from an\n Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource.\n These resource shares are visible only to the Amazon Web Services account that created it. They cannot\n be modified in RAM.

    \n
  • \n
  • \n

    \n PROMOTING_TO_STANDARD - The resource share is in the process of being\n promoted. For more information, see PromoteResourceShareCreatedFromPolicy.

    \n
  • \n
  • \n

    \n STANDARD - Indicates that the resource share was created in RAM using the\n console or APIs. These resource shares are visible to all principals. They can\n be modified in RAM.

    \n
  • \n
" + "smithy.api#documentation": "

Indicates how the resource share was created. Possible values include:

\n
    \n
  • \n

    \n CREATED_FROM_POLICY - Indicates that the resource share was created from an\n Identity and Access Management (IAM) resource-based permission policy attached to the resource.\n This type of resource share is visible only to the Amazon Web Services account that created it. You\n can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

    \n
  • \n
  • \n

    \n PROMOTING_TO_STANDARD - The resource share is in the process of being\n promoted. For more information, see PromoteResourceShareCreatedFromPolicy.

    \n
  • \n
  • \n

    \n STANDARD - Indicates that the resource share was created in RAM using the\n console or APIs. These resource shares are visible to all principals you share the resource share\n with. You can modify these resource shares in RAM using the console or APIs.

    \n
  • \n
" } } }, "traits": { - "smithy.api#documentation": "

Describes a resource share.

" + "smithy.api#documentation": "

Describes a resource share in RAM.

" } }, "com.amazonaws.ram#ResourceShareArnList": { @@ -2484,7 +2545,7 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the resource share.

" } }, "resourceShareName": { @@ -2496,19 +2557,19 @@ "associatedEntity": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The associated entity. For resource associations, this is the Amazon Resource Name\n (ARN) of the resource. For principal associations, this is one of the following:

\n
    \n
  • \n

    An Amazon Web Services account ID

    \n
  • \n
  • \n

    An ARN of an organization in Organizations

    \n
  • \n
  • \n

    An ARN of an organizational unit (OU) in Organizations

    \n
  • \n
  • \n

    An ARN of an IAM role

    \n
  • \n
  • \n

    An ARN of an IAM user

    \n
  • \n
" + "smithy.api#documentation": "

The associated entity. This can be either of the following:

\n
    \n
  • \n

    For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

    \n
  • \n
  • \n

    For principal associations, this is one of the following:

    \n
      \n
    • \n

      The ID of an Amazon Web Services account

      \n
    • \n
    • \n

      The Amazon Resoure Name (ARN) of an organization in Organizations

      \n
    • \n
    • \n

      The ARN of an organizational unit (OU) in Organizations

      \n
    • \n
    • \n

      The ARN of an IAM role

      \n
    • \n
    • \n

      The ARN of an IAM user

      \n
    • \n
    \n
  • \n
" } }, "associationType": { "target": "com.amazonaws.ram#ResourceShareAssociationType", "traits": { - "smithy.api#documentation": "

The association type.

" + "smithy.api#documentation": "

The type of entity included in this association.

" } }, "status": { "target": "com.amazonaws.ram#ResourceShareAssociationStatus", "traits": { - "smithy.api#documentation": "

The status of the association.

" + "smithy.api#documentation": "

The current status of the association.

" } }, "statusMessage": { @@ -2520,13 +2581,13 @@ "creationTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

The time when the association was created.

" + "smithy.api#documentation": "

The date and time when the association was created.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.ram#DateTime", "traits": { - "smithy.api#documentation": "

The time when the association was last updated.

" + "smithy.api#documentation": "

The date and time when the association was last updated.

" } }, "external": { @@ -2537,7 +2598,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an association with a resource share.

" + "smithy.api#documentation": "

Describes an association with a resource share and either a principal or a resource.

" } }, "com.amazonaws.ram#ResourceShareAssociationList": { @@ -2616,7 +2677,7 @@ "resourceShareInvitationArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the invitation.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the invitation.

" } }, "resourceShareName": { @@ -2628,7 +2689,7 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the resource share

" } }, "senderAccountId": { @@ -2652,7 +2713,7 @@ "status": { "target": "com.amazonaws.ram#ResourceShareInvitationStatus", "traits": { - "smithy.api#documentation": "

The status of the invitation.

" + "smithy.api#documentation": "

The current status of the invitation.

" } }, "resourceShareAssociations": { @@ -2661,18 +2722,18 @@ "smithy.api#deprecated": { "message": "This member has been deprecated. Use ListPendingInvitationResources." }, - "smithy.api#documentation": "

To view the resources associated with a pending resource share invitation, use \n ListPendingInvitationResources.

" + "smithy.api#documentation": "

To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.

" } }, "receiverArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM user or IAM role that received the\n invitation.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the IAM user or role that received the invitation.

" } } }, "traits": { - "smithy.api#documentation": "

Describes an invitation to join a resource share.

" + "smithy.api#documentation": "

Describes an invitation for an Amazon Web Services account to join a resource share.

" } }, "com.amazonaws.ram#ResourceShareInvitationAlreadyAcceptedException": { @@ -2690,7 +2751,7 @@ "code": "InvalidResourceShareInvitationArn.AlreadyAccepted", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The invitation was already accepted.

", + "smithy.api#documentation": "

The specified invitation was already accepted.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2710,7 +2771,7 @@ "code": "InvalidResourceShareInvitationArn.AlreadyRejected", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The invitation was already rejected.

", + "smithy.api#documentation": "

The specified invitation was already rejected.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2739,7 +2800,7 @@ "code": "InvalidResourceShareInvitationArn.NotFound", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an invitation was not found.

", + "smithy.api#documentation": "

The specified Amazon Resource Name (ARN) for an invitation was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2759,7 +2820,7 @@ "code": "InvalidResourceShareInvitationArn.Expired", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The invitation is expired.

", + "smithy.api#documentation": "

The specified invitation is expired.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2811,7 +2872,7 @@ "code": "ResourceShareLimitExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The requested resource share exceeds the limit for your account.

", + "smithy.api#documentation": "

This request would exceed the limit for resource shares for your account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2831,37 +2892,37 @@ "arn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the permission.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of this RAM permission.

" } }, "version": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The identifier for the version of the permission.

" + "smithy.api#documentation": "

The version of the permission represented in this structure.

" } }, "defaultVersion": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the version of the permission is set to the default version for this\n permission.

" + "smithy.api#documentation": "

Specifies whether the version of the permission represented in this structure is the\n default version for this permission.

" } }, "name": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The name of the permission.

" + "smithy.api#documentation": "

The name of this permission.

" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The resource type to which the permission applies.

" + "smithy.api#documentation": "

The resource type to which this permission applies.

" } }, "permission": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The permission's effect and actions in JSON format. The effect indicates\n whether the actions are allowed or denied. The actions list the API actions\n to which the principal is granted or denied access.

" + "smithy.api#documentation": "

The permission's effect and actions in JSON format. The effect indicates\n whether the specified actions are allowed or denied. The actions list the\n operations to which the principal is granted or denied access.

" } }, "creationTime": { @@ -2879,7 +2940,7 @@ "isResourceTypeDefault": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the version of the permission is set to the default version for this\n resource type.

" + "smithy.api#documentation": "

Specifies whether the version of the permission represented in this structure is the\n default version for all resources of this resource type.

" } } }, @@ -2902,31 +2963,31 @@ "arn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the permission.

" + "smithy.api#documentation": "

The Amazon Resoure Name (ARN) of the permission you want information about.

" } }, "version": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The identifier for the version of the permission.

" + "smithy.api#documentation": "

The version of the permission represented in this structure.

" } }, "defaultVersion": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the version of the permission is set to the default version for this\n permission.

" + "smithy.api#documentation": "

Specifies whether the version of the permission represented in this structure is the\n default version for this permission.

" } }, "name": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The name of the permission.

" + "smithy.api#documentation": "

The name of this permission.

" } }, "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The type of resource to which the permission applies.

" + "smithy.api#documentation": "

The type of resource to which this permission applies.

" } }, "status": { @@ -2950,12 +3011,12 @@ "isResourceTypeDefault": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the version of the permission is set to the default version for this\n resource type.

" + "smithy.api#documentation": "

Specifies whether the version of the permission represented in this structure is the\n default version for all resources of this resource type.

" } } }, "traits": { - "smithy.api#documentation": "

Information about a permission that is associated with a resource share.

" + "smithy.api#documentation": "

Information about an RAM permission that is associated with a resource share and any of its\n resources of a specified type.

" } }, "com.amazonaws.ram#ResourceShareStatus": { @@ -3038,18 +3099,24 @@ "resourceType": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The shareable resource types.

" + "smithy.api#documentation": "

The type of the resource.

" } }, "serviceName": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services services to which the resources belong.

" + "smithy.api#documentation": "

The name of the Amazon Web Services service to which resources of this type belong.

" + } + }, + "resourceRegionScope": { + "target": "com.amazonaws.ram#ResourceRegionScope", + "traits": { + "smithy.api#documentation": "

Specifies the scope of visibility of resources of this type:

\n
    \n
  • \n

    \n REGIONAL – The resource can be\n accessed only by using requests that target the Amazon Web Services Region in which the\n resource exists.

    \n
  • \n
  • \n

    \n GLOBAL – The resource can be accessed\n from any Amazon Web Services Region.

    \n
  • \n
" } } }, "traits": { - "smithy.api#documentation": "

Information about the shareable resource types and the Amazon Web Services services to which they\n belong.

" + "smithy.api#documentation": "

Information about a shareable resource type and the Amazon Web Services service to which resources\n of that type belong.

" } }, "com.amazonaws.ram#ServiceNameAndResourceTypeList": { @@ -3090,18 +3157,18 @@ "key": { "target": "com.amazonaws.ram#TagKey", "traits": { - "smithy.api#documentation": "

The key of the tag.

" + "smithy.api#documentation": "

The key, or name, attached to the tag. Every tag must have a key. Key names are case\n sensitive.

" } }, "value": { "target": "com.amazonaws.ram#TagValue", "traits": { - "smithy.api#documentation": "

The value of the tag.

" + "smithy.api#documentation": "

The string value attached to the tag. The value can be an empty string. Key values are\n case sensitive.

" } } }, "traits": { - "smithy.api#documentation": "

Information about a tag.

" + "smithy.api#documentation": "

A structure containing a tag. A tag is metadata that you can attach to your resources\n to help organize and categorize them. You can also use them to help you secure your\n resources. For more information, see Controlling access to Amazon Web Services resources\n using tags.

\n

For more information about tags, see Tagging Amazon Web Services resources in the\n Amazon Web Services General Reference Guide.

" } }, "com.amazonaws.ram#TagFilter": { @@ -3110,18 +3177,18 @@ "tagKey": { "target": "com.amazonaws.ram#TagKey", "traits": { - "smithy.api#documentation": "

The tag key.

" + "smithy.api#documentation": "

The tag key. This must have a valid string value and can't be empty.

" } }, "tagValues": { "target": "com.amazonaws.ram#TagValueList", "traits": { - "smithy.api#documentation": "

The tag values.

" + "smithy.api#documentation": "

A list of zero or more tag values. If no values are provided, then the filter matches\n any tag with the specified key, regardless of its value.

" } } }, "traits": { - "smithy.api#documentation": "

Used to filter information based on tags.

" + "smithy.api#documentation": "

A tag key and optional list of possible values that you can use to filter results for\n tagged resources.

" } }, "com.amazonaws.ram#TagFilters": { @@ -3154,7 +3221,7 @@ "code": "TagLimitExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The requested tags exceed the limit for your account.

", + "smithy.api#documentation": "

This request would exceed the limit for tags for your account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3180,7 +3247,7 @@ "code": "TagPolicyViolation", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The specified tag is a reserved word and cannot be used.

", + "smithy.api#documentation": "

The specified tag key is a reserved word and can't be used.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3220,7 +3287,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource share that you own.

", + "smithy.api#documentation": "

Adds the specified tag keys and values to the specified resource share. The tags are attached\n only to the resource share, not to the resources that are in the resource share.

", "smithy.api#http": { "method": "POST", "uri": "/tagresource", @@ -3234,14 +3301,14 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to add tags to.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ram#TagList", "traits": { - "smithy.api#documentation": "

One or more tags.

", + "smithy.api#documentation": "

A list of one or more tag key and value pairs. The tag key must be present and not be\n an empty string. The tag value must be present but can be an empty string.

", "smithy.api#required": {} } } @@ -3260,6 +3327,26 @@ "target": "com.amazonaws.ram#TagValue" } }, + "com.amazonaws.ram#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ram#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ThrottlingException", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

You exceeded the rate at which you are allowed to perform this operation. Please try\n again later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.ram#UnknownResourceException": { "type": "structure", "members": { @@ -3300,7 +3387,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified resource share that you own.

", + "smithy.api#documentation": "

Removes the specified tag key and value pairs from the specified resource share.

", "smithy.api#http": { "method": "POST", "uri": "/untagresource", @@ -3314,14 +3401,14 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to remove tags from. The tags are\n removed from the resource share, not the resources in the resource share.

", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.ram#TagKeyList", "traits": { - "smithy.api#documentation": "

The tag keys of the tags to remove.

", + "smithy.api#documentation": "

Specifies a list of one or more tag keys that you want to remove.

", "smithy.api#required": {} } } @@ -3369,7 +3456,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified resource share that you own.

", + "smithy.api#documentation": "

Modifies some of the properties of the specified resource share.

", "smithy.api#http": { "method": "POST", "uri": "/updateresourceshare", @@ -3383,26 +3470,26 @@ "resourceShareArn": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource share.

", + "smithy.api#documentation": "

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to modify.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

The name of the resource share.

" + "smithy.api#documentation": "

If specified, the new name that you want to attach to the resource share.

" } }, "allowExternalPrincipals": { "target": "com.amazonaws.ram#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether principals outside your organization in Organizations can be associated\n with a resource share.

" + "smithy.api#documentation": "

Specifies whether principals outside your organization in Organizations can be associated\n with a resource share.

" } }, "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

Specifies a unique, case-sensitive identifier that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..

\n

If you don't provide this value, then Amazon Web Services generates a random one for\n you.

" } } } @@ -3419,7 +3506,7 @@ "clientToken": { "target": "com.amazonaws.ram#String", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + "smithy.api#documentation": "

The idempotency identifier associated with this request. If you\n want to repeat the same operation in an idempotent manner then you must include this\n value in the clientToken request parameter of that later call. All other \n parameters must also have the same values that you used in the first call.

" } } } diff --git a/aws/sdk/aws-models/rds.json b/aws/sdk/aws-models/rds.json index f56820ee0d..0da9516f18 100644 --- a/aws/sdk/aws-models/rds.json +++ b/aws/sdk/aws-models/rds.json @@ -1900,7 +1900,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later\n RU/RUR.

\n

Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3.

\n

When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).

\n

Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.

\n

After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.

\n
\n

For more information, see \n Creating a CEV in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later\n RU/RUR.

\n

Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.

\n

When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).

\n

Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.

\n

After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.

\n
\n

For more information, see \n Creating a CEV in the Amazon RDS User Guide.

" } }, "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { @@ -1916,7 +1916,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#CustomEngineVersion", "traits": { - "smithy.api#documentation": "

The name of your CEV. The name format is 19.customized_string\n . For example, \n a valid name is 19.my_cev1. This setting is required for RDS Custom, but optional for Amazon RDS. \n The combination of Engine and EngineVersion is unique per customer per Region.

", + "smithy.api#documentation": "

The name of your CEV. The name format is 19.customized_string\n . For example, \n a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. \n The combination of Engine and EngineVersion is unique per customer per Region.

", "smithy.api#required": {} } }, @@ -2157,14 +2157,14 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n

\n

\n Aurora PostgreSQL\n

\n

For information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n

\n

\n Aurora PostgreSQL\n

\n

For information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { @@ -2320,7 +2320,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

\n Valid values: standard | gp2 | io1\n

\n

\n If you specify io1, also include a value for the\n Iops parameter.\n

\n

\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

\n Valid values: io1\n

\n

\n When specified, a value for the Iops parameter is required.\n

\n

\n Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "Iops": { @@ -2409,7 +2409,7 @@ "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora5.6, aurora-mysql5.7\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql9.6\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres12\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n
\n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
", + "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql9.6\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres12\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n
\n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
", "smithy.api#required": {} } }, @@ -2589,7 +2589,7 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
  • \n
\n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
  • \n
\n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
  • \n
\n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters

    \n
  • \n
\n

\n Amazon RDS Custom\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.\n

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 8 alphanumeric characters.

    \n
  • \n
  • \n

    It must contain a letter.

    \n
  • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
  • \n
\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 64 alphanumeric characters.

    \n
  • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
  • \n
\n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
  • \n
  • \n

    It must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
  • \n
  • \n

    It can't be a word reserved by the\n database engine.

    \n
  • \n
" + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
  • \n
\n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
  • \n
\n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
  • \n
\n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters

    \n
  • \n
\n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.\n

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 8 alphanumeric characters.

    \n
  • \n
  • \n

    It must contain a letter.

    \n
  • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
  • \n
\n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 64 alphanumeric characters.

    \n
  • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
  • \n
\n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
  • \n
  • \n

    It must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
  • \n
  • \n

    It can't be a word reserved by the\n database engine.

    \n
  • \n
" } }, "DBInstanceIdentifier": { @@ -2602,7 +2602,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n\n

\n Amazon RDS Custom\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536.

    \n
  • \n
\n \n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
  • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
  • \n
\n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
  • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
  • \n
\n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
  • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
  • \n
\n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
  • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
  • \n
\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 16384.

      \n
    • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
    • \n
    \n
  • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 16384.

      \n
    • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
    • \n
    \n
  • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 1024.

      \n
    • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
    • \n
    \n
  • \n
" + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n\n

\n Amazon RDS Custom\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
  • \n
\n \n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
  • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
  • \n
\n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
  • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
  • \n
\n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
  • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
  • \n
\n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
  • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
  • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
  • \n
\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
    • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
    • \n
    \n
  • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
    • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
    • \n
    \n
  • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
    • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
    • \n
    \n
  • \n
" } }, "DBInstanceClass": { @@ -2615,7 +2615,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.\n

\n \n

Not every database engine is available for every Amazon Web Services Region.\n

\n\n

Valid Values:\n

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n custom-oracle-ee (for RDS Custom instances)\n

    \n
  • \n
  • \n

    \n mariadb\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n oracle-ee\n

    \n
  • \n
  • \n

    \n oracle-ee-cdb\n

    \n
  • \n
  • \n

    \n oracle-se2\n

    \n
  • \n
  • \n

    \n oracle-se2-cdb\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
  • \n

    \n sqlserver-ee\n

    \n
  • \n
  • \n

    \n sqlserver-se\n

    \n
  • \n
  • \n

    \n sqlserver-ex\n

    \n
  • \n
  • \n

    \n sqlserver-web\n

    \n
  • \n
", + "smithy.api#documentation": "

The name of the database engine to be used for this instance.\n

\n \n

Not every database engine is available for every Amazon Web Services Region.\n

\n\n

Valid Values:\n

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n custom-oracle-ee (for RDS Custom for Oracle instances)\n

    \n
  • \n
  • \n

    \n custom-sqlserver-ee (for RDS Custom for SQL Server instances)\n

    \n
  • \n
  • \n

    \n custom-sqlserver-se (for RDS Custom for SQL Server instances)\n

    \n
  • \n
  • \n

    \n custom-sqlserver-web (for RDS Custom for SQL Server instances)\n

    \n
  • \n
  • \n

    \n mariadb\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n oracle-ee\n

    \n
  • \n
  • \n

    \n oracle-ee-cdb\n

    \n
  • \n
  • \n

    \n oracle-se2\n

    \n
  • \n
  • \n

    \n oracle-se2-cdb\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
  • \n

    \n sqlserver-ee\n

    \n
  • \n
  • \n

    \n sqlserver-se\n

    \n
  • \n
  • \n

    \n sqlserver-ex\n

    \n
  • \n
  • \n

    \n sqlserver-web\n

    \n
  • \n
", "smithy.api#required": {} } }, @@ -2646,7 +2646,7 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

\n Example: us-east-1d\n

\n

\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.\n

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n
" + "smithy.api#documentation": "

\n The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.\n

\n

\n Amazon Aurora\n

\n

Not applicable. Availability Zones are managed by the DB cluster.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

\n Example: us-east-1d\n

\n

\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.\n

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n
" } }, "DBSubnetGroupName": { @@ -2670,7 +2670,7 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35

    \n
  • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas

    \n
  • \n
  • \n

    Can't be set to 0 or 35 for an RDS Custom DB instance

    \n
  • \n
" + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35

    \n
  • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas

    \n
  • \n
  • \n

    Can't be set to 0 or 35 for an RDS Custom for Oracle DB instance

    \n
  • \n
" } }, "PreferredBackupWindow": { @@ -2694,7 +2694,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n \n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n \n

\n Amazon RDS Custom\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom DB instance in the Amazon RDS User Guide..

\n \n

\n MariaDB\n

\n\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Microsoft SQL Server\n

\n \n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n

\n \n

\n MySQL\n

\n\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Oracle\n

\n \n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n

\n\n

\n PostgreSQL\n

\n\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n \n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n \n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide..

\n \n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.\n

\n \n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n

\n \n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n

\n\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

" } }, "AutoMinorVersionUpgrade": { @@ -2772,13 +2772,13 @@ "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom Oracle instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.

\n

\n Amazon Aurora\n

\n

Not applicable. The encryption for DB instances is managed by the DB cluster.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.

\n

\n Amazon Aurora\n

\n

Not applicable. The encryption for DB instances is managed by the DB cluster.

" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

\n Amazon Aurora\n

\n

Not applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

\n Amazon RDS Custom\n

\n

A KMS key is required for RDS Custom Oracle instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom for Oracle \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

\n Amazon Aurora\n

\n

Not applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

\n Amazon RDS Custom\n

\n

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" } }, "Domain": { @@ -3216,7 +3216,7 @@ "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n
\n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mariadb\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n oracle-ee\n

    \n
  • \n
  • \n

    \n oracle-ee-cdb\n

    \n
  • \n
  • \n

    \n oracle-se2\n

    \n
  • \n
  • \n

    \n oracle-se2-cdb\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
  • \n

    \n sqlserver-ee\n

    \n
  • \n
  • \n

    \n sqlserver-se\n

    \n
  • \n
  • \n

    \n sqlserver-ex\n

    \n
  • \n
  • \n

    \n sqlserver-web\n

    \n
  • \n
", + "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n
\n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mariadb\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n oracle-ee\n

    \n
  • \n
  • \n

    \n oracle-ee-cdb\n

    \n
  • \n
  • \n

    \n oracle-se2\n

    \n
  • \n
  • \n

    \n oracle-se2-cdb\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
  • \n

    \n sqlserver-ee\n

    \n
  • \n
  • \n

    \n sqlserver-se\n

    \n
  • \n
  • \n

    \n sqlserver-ex\n

    \n
  • \n
  • \n

    \n sqlserver-web\n

    \n
  • \n
", "smithy.api#required": {} } }, @@ -4421,7 +4421,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The storage type associated with DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + "smithy.api#documentation": "

The storage type associated with the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "Iops": { @@ -5153,7 +5153,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot.

" + "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

\n
    \n
  • \n

    \n available\n

    \n
  • \n
  • \n

    \n copying\n

    \n
  • \n
  • \n

    \n creating\n

    \n
  • \n
" } }, "Port": { @@ -9367,7 +9367,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:\n

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mariadb\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n oracle-ee\n

    \n
  • \n
  • \n

    \n oracle-ee-cdb\n

    \n
  • \n
  • \n

    \n oracle-se2\n

    \n
  • \n
  • \n

    \n oracle-se2-cdb\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
  • \n

    \n sqlserver-ee\n

    \n
  • \n
  • \n

    \n sqlserver-se\n

    \n
  • \n
  • \n

    \n sqlserver-ex\n

    \n
  • \n
  • \n

    \n sqlserver-web\n

    \n
  • \n
" + "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:\n

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mariadb\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n oracle-ee\n

    \n
  • \n
  • \n

    \n oracle-ee-cdb\n

    \n
  • \n
  • \n

    \n oracle-se2\n

    \n
  • \n
  • \n

    \n oracle-se2-cdb\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
  • \n

    \n sqlserver-ee\n

    \n
  • \n
  • \n

    \n sqlserver-se\n

    \n
  • \n
  • \n

    \n sqlserver-ex\n

    \n
  • \n
  • \n

    \n sqlserver-web\n

    \n
  • \n
" } }, "EngineVersion": { @@ -11191,7 +11191,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:\n

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mariadb\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n oracle-ee\n

    \n
  • \n
  • \n

    \n oracle-ee-cdb\n

    \n
  • \n
  • \n

    \n oracle-se2\n

    \n
  • \n
  • \n

    \n oracle-se2-cdb\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
  • \n

    \n sqlserver-ee\n

    \n
  • \n
  • \n

    \n sqlserver-se\n

    \n
  • \n
  • \n

    \n sqlserver-ex\n

    \n
  • \n
  • \n

    \n sqlserver-web\n

    \n
  • \n
", + "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:\n

\n
    \n
  • \n

    \n aurora (for MySQL 5.6-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

    \n
  • \n
  • \n

    \n aurora-postgresql\n

    \n
  • \n
  • \n

    \n mariadb\n

    \n
  • \n
  • \n

    \n mysql\n

    \n
  • \n
  • \n

    \n oracle-ee\n

    \n
  • \n
  • \n

    \n oracle-ee-cdb\n

    \n
  • \n
  • \n

    \n oracle-se2\n

    \n
  • \n
  • \n

    \n oracle-se2-cdb\n

    \n
  • \n
  • \n

    \n postgres\n

    \n
  • \n
  • \n

    \n sqlserver-ee\n

    \n
  • \n
  • \n

    \n sqlserver-se\n

    \n
  • \n
  • \n

    \n sqlserver-ex\n

    \n
  • \n
  • \n

    \n sqlserver-web\n

    \n
  • \n
", "smithy.api#required": {} } }, @@ -13736,7 +13736,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#CustomEngineVersion", "traits": { - "smithy.api#documentation": "

The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", + "smithy.api#documentation": "

The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", "smithy.api#required": {} } }, @@ -13954,7 +13954,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "AllowMajorVersionUpgrade": { @@ -14026,7 +14026,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

\n Valid values: standard | gp2 | io1\n

\n

\n If you specify io1, you must also include a value for the\n Iops parameter.\n

\n

\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

\n Valid values: io1\n

\n

\n When specified, a value for the Iops parameter is required.\n

\n

\n Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "Iops": { @@ -14281,7 +14281,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n

\n

This setting doesn't apply to RDS Custom.

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n

\n

This setting doesn't apply to RDS Custom for Oracle.

\n

Default: Uses existing setting

" } }, "DBSubnetGroupName": { @@ -14299,13 +14299,13 @@ "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing VpcSecurityGroupIds.

    \n
  • \n
" + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing VpcSecurityGroupIds.

    \n
  • \n
" } }, "ApplyImmediately": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is \n disabled.\n

\n

\n If this parameter is disabled, changes to the\n DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. \n Review the table of parameters in Modifying a DB Instance \n in the Amazon RDS User Guide. to see the impact of enabling\n or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.\n

" + "smithy.api#documentation": "

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

\n If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.\n

" } }, "MasterUserPassword": { @@ -14323,7 +14323,7 @@ "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n
\n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance.

    \n
  • \n
  • \n

    It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.

    \n
  • \n
  • \n

    It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.

    \n
  • \n
" + "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n
\n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 or 35 for an RDS Custom for Oracle DB instance.

    \n
  • \n
  • \n

    It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.

    \n
  • \n
  • \n

    It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.

    \n
  • \n
" } }, "PreferredBackupWindow": { @@ -14347,7 +14347,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

In RDS Custom, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.\n

" + "smithy.api#documentation": "

\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.\n

" } }, "AllowMajorVersionUpgrade": { @@ -14437,7 +14437,7 @@ "PubliclyAccessible": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.\n

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.\n

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom.

" + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.\n

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.\n

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" } }, "MonitoringRoleArn": { @@ -14594,7 +14594,7 @@ "Parameters": { "target": "com.amazonaws.rds#ParametersList", "traits": { - "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB instances associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the \n parameter group.

\n
", + "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.

\n

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.

\n \n

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

\n
\n

For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.

", "smithy.api#required": {} } } @@ -15125,7 +15125,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" } }, "AllowMajorVersionUpgrade": { @@ -17634,14 +17634,14 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql \n

", + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql \n

", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n

\n

\n Aurora PostgreSQL\n

\n

Example: 9.6.3, 10.7\n

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5, 8.0.mysql_aurora.3.01.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: 9.6.3, 10.7\n

" } }, "Port": { @@ -17881,7 +17881,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n

\n

\n Aurora PostgreSQL\n

\n

See Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n

\n

\n MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n

\n

\n Aurora PostgreSQL\n

\n

See Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n

\n

\n MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Port": { @@ -17995,7 +17995,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

\n Valid values: standard | gp2 | io1\n

\n

\n If you specify io1, you must also include a value for the\n Iops parameter.\n

\n

\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

\n Valid values: io1\n

\n

\n When specified, a value for the Iops parameter is required.\n

\n

\n Default: io1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "Iops": { @@ -18228,7 +18228,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

\n Valid values: standard | gp2 | io1\n

\n

\n If you specify io1, also include a value for the\n Iops parameter.\n

\n

\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

Valid for: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

\n Valid values: io1\n

\n

\n When specified, a value for the Iops parameter is required.\n

\n

\n Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" } }, "PubliclyAccessible": { diff --git a/aws/sdk/aws-models/redshift.json b/aws/sdk/aws-models/redshift.json index 55fe8c09ca..a813855599 100644 --- a/aws/sdk/aws-models/redshift.json +++ b/aws/sdk/aws-models/redshift.json @@ -616,7 +616,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.redshift#AuthorizeDataShareMessage": { @@ -632,7 +632,7 @@ "ConsumerIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID.

", + "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } @@ -3717,6 +3717,12 @@ "traits": { "smithy.api#documentation": "

A value that specifies when the datashare has an association between a producer and data consumers.

" } + }, + "ManagedBy": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The identifier of a datashare to show its managing entity.

" + } } } }, @@ -3920,7 +3926,7 @@ "ConsumerIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/rekognition.json b/aws/sdk/aws-models/rekognition.json index 0628f4dcea..6882826d79 100644 --- a/aws/sdk/aws-models/rekognition.json +++ b/aws/sdk/aws-models/rekognition.json @@ -469,7 +469,7 @@ } ], "traits": { - "smithy.api#documentation": "

Compares a face in the source input image with\n each of the 100 largest faces detected in the target input image.\n

\n \n

If the source image contains multiple faces, the service detects the largest face\n and compares it with each face detected in the target image.

\n \n \n \n

CompareFaces uses machine learning algorithms, which are probabilistic. \n A false negative is an incorrect prediction that\n a face in the target image has a low similarity confidence score when compared to the face\n in the source image. To reduce the probability of false negatives, \n we recommend that you compare the target image against multiple source images.\n If you plan to use CompareFaces to make a decision that impacts an individual's rights,\n privacy, or access to services, we recommend that you pass the result to a human for review and further\n validation before taking action.

\n
\n\n\n

You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.

\n

In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.

\n\n \n

By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.

\n
\n\n

\n CompareFaces also returns an array of faces that don't match the source image. \n For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.\n The response also returns information about the face in the source image, including the bounding box\n of the face and confidence value.

\n \n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. Use QualityFilter to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default value is NONE.

\n\n

If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the\n source and target images. Use these values to display the images with the correct image orientation.

\n

If no faces are detected in the source or target images, CompareFaces returns an \n InvalidParameterException error.

\n\n\n \n

This is a stateless API operation. That is, data returned by this operation doesn't persist.

\n
\n\n \n

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the rekognition:CompareFaces\n action.

" + "smithy.api#documentation": "

Compares a face in the source input image with\n each of the 100 largest faces detected in the target input image.\n

\n \n

If the source image contains multiple faces, the service detects the largest face\n and compares it with each face detected in the target image.

\n \n \n \n

CompareFaces uses machine learning algorithms, which are probabilistic. \n A false negative is an incorrect prediction that\n a face in the target image has a low similarity confidence score when compared to the face\n in the source image. To reduce the probability of false negatives, \n we recommend that you compare the target image against multiple source images.\n If you plan to use CompareFaces to make a decision that impacts an individual's rights,\n privacy, or access to services, we recommend that you pass the result to a human for review and further\n validation before taking action.

\n
\n\n\n

You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.

\n

In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.

\n\n \n

By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.

\n
\n\n

\n CompareFaces also returns an array of faces that don't match the source image. \n For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.\n The response also returns information about the face in the source image, including the bounding box\n of the face and confidence value.

\n \n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. Use QualityFilter to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default value is NONE.

\n\n

If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the\n source and target images. Use these values to display the images with the correct image orientation.

\n

If no faces are detected in the source or target images, CompareFaces returns an \n InvalidParameterException error.

\n\n\n \n

This is a stateless API operation. That is, data returned by this operation doesn't persist.

\n
\n\n \n

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the rekognition:CompareFaces\n action.

" } }, "com.amazonaws.rekognition#CompareFacesMatch": { @@ -805,7 +805,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Version number of the face detection model associated with the collection you are creating.

" + "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" } } } @@ -2751,7 +2751,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects text in the input image and converts it into machine-readable text.

\n

Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more ISO basic latin script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

\n \n

For more information, see DetectText in the Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Detects text in the input image and converts it into machine-readable text.

\n

Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

\n \n

For more information, see DetectText in the Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#DetectTextFilters": { @@ -3128,6 +3128,12 @@ "traits": { "smithy.api#documentation": "

Confidence level that the bounding box contains a face (and not a different object such\n as a tree).

" } + }, + "IndexFacesModelVersion": { + "target": "com.amazonaws.rekognition#IndexFacesModelVersion", + "traits": { + "smithy.api#documentation": "

\n The version of the face detect and storage model that was used when indexing the face vector.\n

" + } } }, "traits": { @@ -4687,7 +4693,13 @@ } ], "traits": { - "smithy.api#documentation": "

Detects faces in the input image and adds them to the specified collection.

\n

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage\n operations.

\n \n

For more information, see Adding Faces to a Collection in the Amazon Rekognition\n Developer Guide.

\n

To get the number of faces in a collection, call DescribeCollection.

\n\n

If you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.

\n

If you're using version 4 or later of the face model, image orientation information\n is not returned in the OrientationCorrection field.

\n

To determine which version of the model you're using, call DescribeCollection\n and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response\n from IndexFaces\n

\n \n

For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.

\n

If you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.

\n

You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want to index\n smaller faces, such as those belonging to people standing in the background.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. By default, IndexFaces chooses the quality bar that's \n used to filter faces. You can also explicitly choose\n the quality bar. Use QualityFilter, to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.

\n
\n

Information about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't\n indexed for reasons such as:

\n
    \n
  • \n

    The number of faces detected exceeds the value of the MaxFaces request\n parameter.

    \n
  • \n
  • \n

    The face is too small compared to the image dimensions.

    \n
  • \n
  • \n

    The face is too blurry.

    \n
  • \n
  • \n

    The image is too dark.

    \n
  • \n
  • \n

    The face has an extreme pose.

    \n
  • \n
  • \n

    The face doesn’t have enough detail to be suitable for face search.

    \n
  • \n
\n

In response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:

\n
    \n
  • \n

    The bounding box, BoundingBox, of the detected face.

    \n
  • \n
  • \n

    A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.

    \n
  • \n
  • \n

    A face ID, FaceId, assigned by the service for each face that's detected\n and stored.

    \n
  • \n
  • \n

    An image ID, ImageId, assigned by the service for the input image.

    \n
  • \n
\n

If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide\n the same image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

\n \n\n

\n \n\n

The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

\n

This operation requires permissions to perform the rekognition:IndexFaces\n action.

" + "smithy.api#documentation": "

Detects faces in the input image and adds them to the specified collection.

\n

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage\n operations.

\n \n

For more information, see Adding Faces to a Collection in the Amazon Rekognition\n Developer Guide.

\n

To get the number of faces in a collection, call DescribeCollection.

\n\n

If you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.

\n

If you're using version 4 or later of the face model, image orientation information\n is not returned in the OrientationCorrection field.

\n

To determine which version of the model you're using, call DescribeCollection\n and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response\n from IndexFaces\n

\n \n

For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.

\n

If you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.

\n

You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want to index\n smaller faces, such as those belonging to people standing in the background.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. By default, IndexFaces chooses the quality bar that's \n used to filter faces. You can also explicitly choose\n the quality bar. Use QualityFilter, to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.

\n
\n

Information about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't\n indexed for reasons such as:

\n
    \n
  • \n

    The number of faces detected exceeds the value of the MaxFaces request\n parameter.

    \n
  • \n
  • \n

    The face is too small compared to the image dimensions.

    \n
  • \n
  • \n

    The face is too blurry.

    \n
  • \n
  • \n

    The image is too dark.

    \n
  • \n
  • \n

    The face has an extreme pose.

    \n
  • \n
  • \n

    The face doesn’t have enough detail to be suitable for face search.

    \n
  • \n
\n

In response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:

\n
    \n
  • \n

    The bounding box, BoundingBox, of the detected face.

    \n
  • \n
  • \n

    A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.

    \n
  • \n
  • \n

    A face ID, FaceId, assigned by the service for each face that's detected\n and stored.

    \n
  • \n
  • \n

    An image ID, ImageId, assigned by the service for the input image.

    \n
  • \n
\n

If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide\n the same image, specify the same collection, use the same external ID, and use the same model version in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

\n \n\n

\n \n\n

The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

\n

This operation requires permissions to perform the rekognition:IndexFaces\n action.

" + } + }, + "com.amazonaws.rekognition#IndexFacesModelVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9\\.]+$" } }, "com.amazonaws.rekognition#IndexFacesRequest": { @@ -4751,7 +4763,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

The version number of the face detection model that's associated with the input\n collection (CollectionId).

" + "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" } }, "UnindexedFaces": { @@ -4989,7 +5001,7 @@ } }, "traits": { - "smithy.api#documentation": "

The known gender identity for the celebrity that matches the provided ID.

" + "smithy.api#documentation": "

The known gender identity for the celebrity that matches the provided ID. The known\n gender identity can be Male, Female, Nonbinary, or Unlisted.

" } }, "com.amazonaws.rekognition#KnownGenderType": { @@ -5004,6 +5016,14 @@ { "value": "Female", "name": "Female" + }, + { + "value": "Nonbinary", + "name": "Nonbinary" + }, + { + "value": "Unlisted", + "name": "Unlisted" } ] } @@ -5343,7 +5363,7 @@ "FaceModelVersions": { "target": "com.amazonaws.rekognition#FaceModelVersionList", "traits": { - "smithy.api#documentation": "

Version numbers of the face detection models associated with the collections in the array CollectionIds.\n For example, the value of FaceModelVersions[2] is the version number for the face detection model used\n by the collection in CollectionId[2].

" + "smithy.api#documentation": "

Latest face models being used with the corresponding collections in the array. For more information, see Model versioning. \n For example, the value of FaceModelVersions[2] is the version number for the face detection model used\n by the collection in CollectionId[2].

" } } } @@ -5651,7 +5671,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Version number of the face detection model associated with the input collection (CollectionId).

" + "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" } } } @@ -7268,7 +7288,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Version number of the face detection model associated with the input collection (CollectionId).

" + "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" } } } @@ -7322,7 +7342,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Version number of the face detection model associated with the input collection (CollectionId).

" + "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" } } } diff --git a/aws/sdk/aws-models/route53-recovery-control-config.json b/aws/sdk/aws-models/route53-recovery-control-config.json index 8f988dcc62..9f24c04a85 100644 --- a/aws/sdk/aws-models/route53-recovery-control-config.json +++ b/aws/sdk/aws-models/route53-recovery-control-config.json @@ -41,7 +41,7 @@ } }, "traits": { - "smithy.api#documentation": "

403 response - AccessDeniedException. You do not have sufficient access to perform this action.

", + "smithy.api#documentation": "

403 response - You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -50,14 +50,14 @@ "type": "structure", "members": { "AssertedControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

", "smithy.api#required": {} } }, "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

", "smithy.api#required": {} @@ -73,12 +73,12 @@ "RuleConfig": { "target": "com.amazonaws.route53recoverycontrolconfig#RuleConfig", "traits": { - "smithy.api#documentation": "

The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.

", + "smithy.api#documentation": "

The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

", "smithy.api#required": {} } }, "SafetyRuleArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assertion rule.

", "smithy.api#required": {} @@ -100,7 +100,7 @@ } }, "traits": { - "smithy.api#documentation": "

An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.

" + "smithy.api#documentation": "

An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control is not accepted. For example, the criteria might be that at least one routing control state is On after the transation so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

" } }, "com.amazonaws.route53recoverycontrolconfig#AssertionRuleUpdate": { @@ -114,7 +114,7 @@ } }, "SafetyRuleArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assertion rule.

", "smithy.api#required": {} @@ -136,7 +136,7 @@ "type": "structure", "members": { "ClusterArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

" } @@ -144,7 +144,7 @@ "ClusterEndpoints": { "target": "com.amazonaws.route53recoverycontrolconfig#__listOfClusterEndpoint", "traits": { - "smithy.api#documentation": "

Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.

" + "smithy.api#documentation": "

Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

" } }, "Name": { @@ -161,20 +161,20 @@ } }, "traits": { - "smithy.api#documentation": "

A cluster is a set of five consensus-forming Regional endpoints that represent the infrastructure that hosts your routing controls. Typically, you host together on one cluster all of the routing controls for your applications.

" + "smithy.api#documentation": "

A set of five redundant Regional endpoints against which you can execute API calls to update or get the state of routing controls. You can host multiple control panels and routing controls on one cluster.

" } }, "com.amazonaws.route53recoverycontrolconfig#ClusterEndpoint": { "type": "structure", "members": { "Endpoint": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max128", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max128PatternAZaZ09", "traits": { - "smithy.api#documentation": "

A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.

" + "smithy.api#documentation": "

A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.

" } }, "Region": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max32", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max32PatternS", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region for a cluster endpoint.

" } @@ -196,7 +196,7 @@ } }, "traits": { - "smithy.api#documentation": "

409 response - ConflictException.

", + "smithy.api#documentation": "

409 response - ConflictException. You might be using a predefined variable.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -205,13 +205,13 @@ "type": "structure", "members": { "ClusterArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that includes the control panel.

" } }, "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

" } @@ -277,7 +277,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the Amazon Route 53 Application Recovery Controller cluster data plane.

", + "smithy.api#documentation": "

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.

", "smithy.api#http": { "method": "POST", "uri": "/cluster", @@ -289,9 +289,9 @@ "type": "structure", "members": { "ClientToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax64", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "

Unique client idempotency token.

", + "smithy.api#documentation": "

A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

", "smithy.api#idempotencyToken": {} } }, @@ -301,6 +301,12 @@ "smithy.api#documentation": "

The name of the cluster.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "

The tags associated with the cluster.

" + } } }, "traits": { @@ -350,7 +356,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or AWS Region.

", + "smithy.api#documentation": "

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.

", "smithy.api#http": { "method": "POST", "uri": "/controlpanel", @@ -362,14 +368,14 @@ "type": "structure", "members": { "ClientToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax64", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "

Unique client idempotency token.

", + "smithy.api#documentation": "

A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

", "smithy.api#idempotencyToken": {} } }, "ClusterArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster for the control panel.

", "smithy.api#required": {} @@ -381,6 +387,12 @@ "smithy.api#documentation": "

The name of the control panel.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "

The tags associated with the control panel.

" + } } }, "traits": { @@ -442,21 +454,21 @@ "type": "structure", "members": { "ClientToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax64", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "

Unique client idempotency token.

", + "smithy.api#documentation": "

A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

", "smithy.api#idempotencyToken": {} } }, "ClusterArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that includes the routing control.

", "smithy.api#required": {} } }, "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel that includes the routing control.

" } @@ -501,7 +513,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a safety rule in a control panel. Safety rules let you add safeguards around enabling and disabling routing controls, to help prevent unexpected outcomes.

There are two types of safety rules: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.

Gating rule: A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

", + "smithy.api#documentation": "

Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.

There are two types of safety rules: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transation so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

Gating rule: A gating rule lets you configure a gating routing control as an overall \"on/off\" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.

For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/safetyrule", @@ -513,17 +525,29 @@ "type": "structure", "members": { "AssertionRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#NewAssertionRule" + "target": "com.amazonaws.route53recoverycontrolconfig#NewAssertionRule", + "traits": { + "smithy.api#documentation": "

The assertion rule requested.

" + } }, "ClientToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax64", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "

Unique client idempotency token.

", + "smithy.api#documentation": "

A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

", "smithy.api#idempotencyToken": {} } }, "GatingRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#NewGatingRule" + "target": "com.amazonaws.route53recoverycontrolconfig#NewGatingRule", + "traits": { + "smithy.api#documentation": "

The gating rule requested.

" + } + }, + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "

The tags associated with the safety rule.

" + } } }, "traits": { @@ -534,10 +558,16 @@ "type": "structure", "members": { "AssertionRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule" + "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule", + "traits": { + "smithy.api#documentation": "

The assertion rule created.

" + } }, "GatingRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule" + "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule", + "traits": { + "smithy.api#documentation": "

The gating rule created.

" + } } } }, @@ -638,7 +668,7 @@ "ControlPanelArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel that you're deleting.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -737,7 +767,7 @@ "SafetyRuleArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The request body that you include when you update a safety rule.

", + "smithy.api#documentation": "

The ARN of the safety rule.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -853,7 +883,7 @@ "ClusterArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that you're getting details for.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -976,7 +1006,7 @@ "ControlPanelArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel that you're getting details for.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1099,7 +1129,7 @@ "RoutingControlArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing control that you're getting details for.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing control.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1134,7 +1164,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the safety rules (that is, the assertion rules and gating rules) for the routing controls in a control panel.

", + "smithy.api#documentation": "

Returns information about a safety rule.

", "smithy.api#http": { "method": "GET", "uri": "/safetyrule/{SafetyRuleArn}", @@ -1148,7 +1178,7 @@ "SafetyRuleArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The request body that you include when you update a safety rule.

", + "smithy.api#documentation": "

The ARN of the safety rule.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1159,10 +1189,16 @@ "type": "structure", "members": { "AssertionRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule" + "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule", + "traits": { + "smithy.api#documentation": "

The assertion rule in the response.

" + } }, "GatingRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule" + "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule", + "traits": { + "smithy.api#documentation": "

The gating rule in the response.

" + } } } }, @@ -1170,35 +1206,35 @@ "type": "structure", "members": { "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

", "smithy.api#required": {} } }, "GatingControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { - "smithy.api#documentation": "

The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

", + "smithy.api#documentation": "

An array of gating routing control Amazon Resource Names (ARNs). For a simple \"on/off\" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "

The name for the gating rule.

", + "smithy.api#documentation": "

The name for the gating rule. You can use any non-white space character in the name.

", "smithy.api#required": {} } }, "RuleConfig": { "target": "com.amazonaws.route53recoverycontrolconfig#RuleConfig", "traits": { - "smithy.api#documentation": "

The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.

", + "smithy.api#documentation": "

The criteria that you set for gating routing controls that designates how many of the routing control states must be ON to allow you to update target routing control states.

", "smithy.api#required": {} } }, "SafetyRuleArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gating rule.

", "smithy.api#required": {} @@ -1212,9 +1248,9 @@ } }, "TargetControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { - "smithy.api#documentation": "

Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.

In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.

", + "smithy.api#documentation": "

An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall \"on/off\" switch for a set of target routing controls. You can use this to manually override automated fail over, for example.

", "smithy.api#required": {} } }, @@ -1227,7 +1263,7 @@ } }, "traits": { - "smithy.api#documentation": "

A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

" + "smithy.api#documentation": "

A gating rule verifies that a gating routing control or set of gating rounting controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.

For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control \"switch\" to be \"On\". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.

" } }, "com.amazonaws.route53recoverycontrolconfig#GatingRuleUpdate": { @@ -1236,12 +1272,12 @@ "Name": { "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "

The name for the gating rule.

", + "smithy.api#documentation": "

The name for the gating rule. You can use any non-white space character in the name.

", "smithy.api#required": {} } }, "SafetyRuleArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gating rule.

", "smithy.api#required": {} @@ -1329,7 +1365,7 @@ "RoutingControlArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing control that you're getting details for.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing control.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1340,15 +1376,15 @@ "type": "structure", "members": { "HealthCheckIds": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMax36PatternS", "traits": { "smithy.api#documentation": "

Identifiers for the health checks.

" } }, "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { - "smithy.api#documentation": "

The token that identifies which batch of results you want to see.

" + "smithy.api#documentation": "

Next token for listing health checks.

" } } } @@ -1421,7 +1457,7 @@ } }, "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { "smithy.api#documentation": "

The token that identifies which batch of results you want to see.

" } @@ -1454,7 +1490,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an array of control panels for a cluster.

", + "smithy.api#documentation": "

Returns an array of control panels in an account or in a cluster.

", "smithy.api#http": { "method": "GET", "uri": "/controlpanels", @@ -1503,7 +1539,7 @@ } }, "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { "smithy.api#documentation": "

The token that identifies which batch of results you want to see.

" } @@ -1555,7 +1591,7 @@ "ControlPanelArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel that you're getting routing control details for.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1580,7 +1616,7 @@ "type": "structure", "members": { "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { "smithy.api#documentation": "

The token that identifies which batch of results you want to see.

" } @@ -1638,7 +1674,7 @@ "ControlPanelArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel that you're getting details for.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1663,7 +1699,7 @@ "type": "structure", "members": { "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { "smithy.api#documentation": "

The token that identifies which batch of results you want to see.

" } @@ -1676,6 +1712,58 @@ } } }, + "com.amazonaws.route53recoverycontrolconfig#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53recoverycontrolconfig#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53recoverycontrolconfig#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53recoverycontrolconfig#InternalServerException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for a resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the resource that's tagged.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "

The tags associated with the resource.

" + } + } + } + }, "com.amazonaws.route53recoverycontrolconfig#MaxResults": { "type": "integer", "traits": { @@ -1689,14 +1777,14 @@ "type": "structure", "members": { "AssertedControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

", "smithy.api#required": {} } }, "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the control panel.

", "smithy.api#required": {} @@ -1712,7 +1800,7 @@ "RuleConfig": { "target": "com.amazonaws.route53recoverycontrolconfig#RuleConfig", "traits": { - "smithy.api#documentation": "

The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.

", + "smithy.api#documentation": "

The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.

", "smithy.api#required": {} } }, @@ -1732,14 +1820,14 @@ "type": "structure", "members": { "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

", "smithy.api#required": {} } }, "GatingControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

", "smithy.api#required": {} @@ -1755,12 +1843,12 @@ "RuleConfig": { "target": "com.amazonaws.route53recoverycontrolconfig#RuleConfig", "traits": { - "smithy.api#documentation": "

The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.

", + "smithy.api#documentation": "

The criteria that you set for specific gating controls (routing controls) that designates how many control states must be ON to allow you to change (set or unset) the target control states.

", "smithy.api#required": {} } }, "TargetControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.

In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.

", "smithy.api#required": {} @@ -1790,13 +1878,28 @@ } }, "traits": { - "smithy.api#documentation": "

404 response - The query string contains a syntax error or resource not found.

", + "smithy.api#documentation": "

404 response - MalformedQueryString. The query string contains a syntax error or resource not found..

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.route53recoverycontrolconfig#Route53RecoveryControlConfig": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Route53 Recovery Control Config", + "arnNamespace": "route53-recovery-control-config", + "cloudFormationName": "Route53RecoveryControlConfig", + "cloudTrailEventSource": "route53recoverycontrolconfig.amazonaws.com", + "endpointPrefix": "route53-recovery-control-config" + }, + "aws.auth#sigv4": { + "name": "route53-recovery-control-config" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

", + "smithy.api#title": "AWS Route53 Recovery Control Config" + }, "version": "2020-11-02", "operations": [ { @@ -1850,6 +1953,15 @@ { "target": "com.amazonaws.route53recoverycontrolconfig#ListSafetyRules" }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ListTagsForResource" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#TagResource" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#UntagResource" + }, { "target": "com.amazonaws.route53recoverycontrolconfig#UpdateControlPanel" }, @@ -1859,28 +1971,13 @@ { "target": "com.amazonaws.route53recoverycontrolconfig#UpdateSafetyRule" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Route53 Recovery Control Config", - "arnNamespace": "route53-recovery-control-config", - "cloudFormationName": "Route53RecoveryControlConfig", - "cloudTrailEventSource": "route53recoverycontrolconfig.amazonaws.com", - "endpointPrefix": "route53-recovery-control-config" - }, - "aws.auth#sigv4": { - "name": "route53-recovery-control-config" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

", - "smithy.api#title": "AWS Route53 Recovery Control Config" - } + ] }, "com.amazonaws.route53recoverycontrolconfig#RoutingControl": { "type": "structure", "members": { "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel that includes the routing control.

" } @@ -1892,7 +1989,7 @@ } }, "RoutingControlArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing control.

" } @@ -1914,13 +2011,13 @@ "ASSERTION": { "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule", "traits": { - "smithy.api#documentation": "

An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.

" + "smithy.api#documentation": "

An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transation so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

" } }, "GATING": { "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule", "traits": { - "smithy.api#documentation": "

A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

" + "smithy.api#documentation": "

A gating rule verifies that a gating routing control or set of gating rounting controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.

For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control \"switch\" to be \"On\". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.

" } } }, @@ -1954,7 +2051,7 @@ } }, "traits": { - "smithy.api#documentation": "

The rule configuration for an assertion rule. That is, the criteria that you set for specific assertion controls (routing controls) that specify how many controls must be enabled after a transaction completes.

" + "smithy.api#documentation": "

The rule configuration for an assertion rule. That is, the criteria that you set for specific assertion controls (routing controls) that specify how many control states must be ON after a transaction completes.

" } }, "com.amazonaws.route53recoverycontrolconfig#RuleType": { @@ -1989,7 +2086,7 @@ } }, "traits": { - "smithy.api#documentation": "

402 response

", + "smithy.api#documentation": "

402 response - You attempted to create more resources than the service allows based on service quotas.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -2014,6 +2111,61 @@ ] } }, + "com.amazonaws.route53recoverycontrolconfig#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53recoverycontrolconfig#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53recoverycontrolconfig#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53recoverycontrolconfig#InternalServerException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a tag to a resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the resource that's tagged.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "

The tags associated with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request of adding tag to the resource

" + } + }, + "com.amazonaws.route53recoverycontrolconfig#TagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.route53recoverycontrolconfig#ThrottlingException": { "type": "structure", "members": { @@ -2026,11 +2178,64 @@ } }, "traits": { - "smithy.api#documentation": "

429 response - ThrottlingException.

", + "smithy.api#documentation": "

429 response - LimitExceededException or TooManyRequestsException.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, + "com.amazonaws.route53recoverycontrolconfig#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53recoverycontrolconfig#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53recoverycontrolconfig#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53recoverycontrolconfig#InternalServerException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag from a resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the resource that's tagged.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "traits": { + "smithy.api#documentation": "

Keys for the tags to be removed.

", + "smithy.api#httpQuery": "TagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.route53recoverycontrolconfig#UpdateControlPanel": { "type": "operation", "input": { @@ -2072,7 +2277,7 @@ "type": "structure", "members": { "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the control panel.

", "smithy.api#required": {} @@ -2142,7 +2347,7 @@ "type": "structure", "members": { "RoutingControlArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing control.

", "smithy.api#required": {} @@ -2191,7 +2396,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update a safety rule (an assertion rule or gating rule) for the routing controls in a control panel. You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new safety rule.

", + "smithy.api#documentation": "

Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.

", "smithy.api#http": { "method": "PUT", "uri": "/safetyrule", @@ -2203,21 +2408,36 @@ "type": "structure", "members": { "AssertionRuleUpdate": { - "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRuleUpdate" + "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRuleUpdate", + "traits": { + "smithy.api#documentation": "

The assertion rule to update.

" + } }, "GatingRuleUpdate": { - "target": "com.amazonaws.route53recoverycontrolconfig#GatingRuleUpdate" + "target": "com.amazonaws.route53recoverycontrolconfig#GatingRuleUpdate", + "traits": { + "smithy.api#documentation": "

The gating rule to update.

" + } } + }, + "traits": { + "smithy.api#documentation": "

A rule that you add to Application Recovery Controller to ensure that recovery actions don't accidentally impair your application's availability.

" } }, "com.amazonaws.route53recoverycontrolconfig#UpdateSafetyRuleResponse": { "type": "structure", "members": { "AssertionRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule" + "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule", + "traits": { + "smithy.api#documentation": "

The assertion rule updated.

" + } }, "GatingRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule" + "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule", + "traits": { + "smithy.api#documentation": "

The gating rule updated.

" + } } } }, @@ -2233,7 +2453,7 @@ } }, "traits": { - "smithy.api#documentation": "

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

", + "smithy.api#documentation": "

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2280,43 +2500,78 @@ "target": "com.amazonaws.route53recoverycontrolconfig#__string" } }, + "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMax36PatternS": { + "type": "list", + "member": { + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax36PatternS" + } + }, + "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09": { + "type": "list", + "member": { + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09" + } + }, + "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS": { + "type": "map", + "key": { + "target": "com.amazonaws.route53recoverycontrolconfig#__string" + }, + "value": { + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin0Max256PatternS" + } + }, "com.amazonaws.route53recoverycontrolconfig#__string": { "type": "string" }, - "com.amazonaws.route53recoverycontrolconfig#__stringMax64": { + "com.amazonaws.route53recoverycontrolconfig#__stringMax36PatternS": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 64 - } + "max": 36 + }, + "smithy.api#pattern": "^\\S+$" } }, - "com.amazonaws.route53recoverycontrolconfig#__stringMax8096": { + "com.amazonaws.route53recoverycontrolconfig#__stringMin0Max256PatternS": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 8096 - } + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" } }, - "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max128": { + "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max128PatternAZaZ09": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 - } + }, + "smithy.api#pattern": "^[A-Za-z0-9:.\\/_-]*$" + } + }, + "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9:\\/_-]*$" } }, - "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max32": { + "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max32PatternS": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 - } + }, + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS": { @@ -2328,6 +2583,16 @@ }, "smithy.api#pattern": "^\\S+$" } + }, + "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8096 + }, + "smithy.api#pattern": "^[\\S]*$" + } } } } diff --git a/aws/sdk/aws-models/route53.json b/aws/sdk/aws-models/route53.json index e448307408..b2ec5b0829 100644 --- a/aws/sdk/aws-models/route53.json +++ b/aws/sdk/aws-models/route53.json @@ -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": "

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.

", + "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": "

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.

", - "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": "

(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

\n\t\t

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 AssociateVPCWithHostedZone\n\t\t\tafter you create a hosted zone.

" + "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

\n\t\t

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\tVPCId and VPCRegion are also required.

\n\t\t

To associate additional Amazon VPCs with the hosted zone, \n\t\t\tuse AssociateVPCWithHostedZone\n\t\t\tafter you create a hosted zone.

" } }, "CallerReference": { @@ -1338,7 +1346,7 @@ "KeyManagementServiceArn": { "target": "com.amazonaws.route53#SigningKeyString", "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) for a customer managed customer master key (CMK) in Key Management Service (KMS).\n\t\t\tThe KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. \n\t\t\tTo see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, \n\t\t\tscroll down to Example.

\n\t\t

You must configure the customer managed CMK as follows:

\n\t\t
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n\t\t\t\t\t
    \n
  • \n

    DescribeKey

    \n
  • \n
  • \n

    GetPublicKey

    \n
  • \n
  • \n

    Sign

    \n
  • \n
\n\t\t\t\t\t

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:

\n\t\t\t\t\t
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
  • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with a customer managed CMK in KMS, see \n\t\t\tKey Management Service concepts.

", + "smithy.api#documentation": "

The Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS).\n\t\t\tThe KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. \n\t\t\tTo see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, \n\t\t\tscroll down to Example.

\n\t\t

You must configure the customer managed customer managed key as follows:

\n\t\t
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n\t\t\t\t\t
    \n
  • \n

    DescribeKey

    \n
  • \n
  • \n

    GetPublicKey

    \n
  • \n
  • \n

    Sign

    \n
  • \n
\n\t\t\t\t\t

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:

\n\t\t\t\t\t
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
  • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with a customer managed key in KMS, see \n\t\t\tKey Management Service concepts.

", "smithy.api#required": {} } }, @@ -1916,7 +1924,7 @@ "ServeSignature": { "target": "com.amazonaws.route53#ServeSignature", "traits": { - "smithy.api#documentation": "

A string that represents the current hosted zone signing status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
SIGNING
\n
\n

DNSSEC signing is enabled for the hosted zone.

\n
\n
NOT_SIGNING
\n
\n

DNSSEC signing is not enabled for the hosted zone.

\n
\n
DELETING
\n
\n

DNSSEC signing is in the process of being removed for the hosted zone.

\n
\n
ACTION_NEEDED
\n
\n

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.

\n
\n
INTERNAL_FAILURE
\n
\n

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.

\n
\n
" + "smithy.api#documentation": "

A string that represents the current hosted zone signing status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
SIGNING
\n
\n

DNSSEC signing is enabled for the hosted zone.

\n
\n
NOT_SIGNING
\n
\n

DNSSEC signing is not enabled for the hosted zone.

\n
\n
DELETING
\n
\n

DNSSEC signing is in the process of being removed for the hosted zone.

\n
\n
ACTION_NEEDED
\n
\n

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.

\n
\n
INTERNAL_FAILURE
\n
\n

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.

\n
\n
" } }, "StatusMessage": { @@ -2272,7 +2280,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

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.

\n\t\t

You can use DeactivateKeySigningKey \n\t\t\tto deactivate the key before you delete it.

\n\t\t

Use GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.

", "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": "

The Amazon resource name (ARN) used to identify the customer managed customer master key (CMK) in Key Management Service (KMS).\n\t\t\tThe KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.

\n\t\t

You must configure the CMK as follows:

\n\t\t
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n\t\t\t\t
    \n
  • \n

    DescribeKey

    \n
  • \n
  • \n

    GetPublicKey

    \n
  • \n
  • \n

    Sign

    \n
  • \n
\n\t\t\t\t\t

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:

\n\t\t\t\t\t
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
  • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with the customer managed CMK in KMS, see \n\t\t\tKey Management Service concepts.

" + "smithy.api#documentation": "

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).\n\t\t\tThe KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.

\n\t\t

You must configure the customer managed key as follows:

\n\t\t
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n\t\t\t\t
    \n
  • \n

    DescribeKey

    \n
  • \n
  • \n

    GetPublicKey

    \n
  • \n
  • \n

    Sign

    \n
  • \n
\n\t\t\t\t\t

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:

\n\t\t\t\t\t
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
  • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with the customer managed key in KMS, see \n\t\t\tKey Management Service concepts.

" } }, "Flag": { @@ -5039,7 +5047,7 @@ "Status": { "target": "com.amazonaws.route53#SigningKeyStatus", "traits": { - "smithy.api#documentation": "

A string that represents the current key-signing key (KSK) status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
ACTIVE
\n
\n

The KSK is being used for signing.

\n
\n
INACTIVE
\n
\n

The KSK is not being used for signing.

\n
\n
DELETING
\n
\n

The KSK is in the process of being deleted.

\n
\n
ACTION_NEEDED
\n
\n

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.

\n
\n
INTERNAL_FAILURE
\n
\n

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.

\n
\n
" + "smithy.api#documentation": "

A string that represents the current key-signing key (KSK) status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
ACTIVE
\n
\n

The KSK is being used for signing.

\n
\n
INACTIVE
\n
\n

The KSK is not being used for signing.

\n
\n
DELETING
\n
\n

The KSK is in the process of being deleted.

\n
\n
ACTION_NEEDED
\n
\n

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.

\n
\n
INTERNAL_FAILURE
\n
\n

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.

\n
\n
" } }, "StatusMessage": { @@ -5073,7 +5081,7 @@ } }, "traits": { - "smithy.api#documentation": "

You've already created a key-signing key (KSK) with this name or with the same customer managed customer master key (CMK) ARN.

", + "smithy.api#documentation": "

You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.

", "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": "

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:

\n\t\t
    \n
  • \n

    \n Healthy: Route 53 considers the health check to be healthy.

    \n
  • \n
  • \n

    \n Unhealthy: Route 53 considers the health check to be unhealthy.

    \n
  • \n
  • \n

    \n LastKnownStatus: 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.

    \n
  • \n
" + "smithy.api#documentation": "

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:

\n\t\t
    \n
  • \n

    \n Healthy: Route 53 considers the health check to be healthy.

    \n
  • \n
  • \n

    \n Unhealthy: Route 53 considers the health check to be unhealthy.

    \n
  • \n
  • \n

    \n LastKnownStatus: 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.

    \n
  • \n
" } }, "ResetElements": { @@ -8546,6 +8558,9 @@ }, { "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" } ], "traits": { @@ -8776,7 +8791,7 @@ } }, "traits": { - "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

" + "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

\n\t\t

If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also\n\t\t\trequired.

" } }, "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" diff --git a/aws/sdk/aws-models/route53domains.json b/aws/sdk/aws-models/route53domains.json index b788a17ce3..8859304000 100644 --- a/aws/sdk/aws-models/route53domains.json +++ b/aws/sdk/aws-models/route53domains.json @@ -46,10 +46,13 @@ }, { "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" } ], "traits": { - "smithy.api#documentation": "

Accepts the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t

\n\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" + "smithy.api#documentation": "

Accepts the transfer of a domain from another Amazon Web Services account to the\n\t\t\t\tcurrentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.

\n\t\t

If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input\n\t\t\tinstead of text because otherwise CLI will throw an error from domain\n\t\t\ttransfer input that includes single quotes.

\n\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" } }, "com.amazonaws.route53domains#AcceptDomainTransferFromAnotherAwsAccountRequest": { @@ -58,7 +61,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that was specified when another AWS account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t

", + "smithy.api#documentation": "

The name of the domain that was specified when another Amazon Web Services account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t

", "smithy.api#required": {} } }, @@ -91,6 +94,10 @@ "com.amazonaws.route53domains#AccountId": { "type": "string", "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, "smithy.api#pattern": "^(\\d{12})$" } }, @@ -167,10 +174,13 @@ }, { "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" } ], "traits": { - "smithy.api#documentation": "

Cancels the transfer of a domain from the current AWS account to another AWS account. You initiate a transfer between AWS accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t

\n\t\t\n\t\t \n\t\t\t

You must cancel the transfer before the other AWS account accepts the transfer using \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.

\n\t\t
\n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" + "smithy.api#documentation": "

Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t

\n\t\t\n\t\t \n\t\t\t

You must cancel the transfer before the other Amazon Web Services account accepts the transfer using \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.

\n\t\t
\n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" } }, "com.amazonaws.route53domains#CancelDomainTransferToAnotherAwsAccountRequest": { @@ -179,7 +189,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain for which you want to cancel the transfer to another AWS account.

", + "smithy.api#documentation": "

The name of the domain for which you want to cancel the transfer to another Amazon Web Services account.

", "smithy.api#required": {} } } @@ -341,7 +351,7 @@ "ContactType": { "target": "com.amazonaws.route53domains#ContactType", "traits": { - "smithy.api#documentation": "

Indicates whether the contact is a person, company, association, or public organization. Note the following:

\n\t\t
    \n
  • \n

    If you specify a value other than PERSON, you must also specify a value for \n\t\t\t\tOrganizationName.

    \n
  • \n
  • \n

    For some TLDs, the privacy protection available depends on the value that you specify for \n\t\t\t\tContact Type. For the privacy protection settings for your TLD, see \n\t\t\t\tDomains that You Can \n\t\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer Guide\n

    \n
  • \n
  • \n

    For .es domains, if you specify PERSON, you must specify INDIVIDUAL \n\t\t\t\tfor the value of ES_LEGAL_FORM.

    \n
  • \n
" + "smithy.api#documentation": "

Indicates whether the contact is a person, company, association, or public organization. Note the following:

\n\t\t
    \n
  • \n

    If you specify a value other than PERSON, you must also specify a value for \n\t\t\t\tOrganizationName.

    \n
  • \n
  • \n

    For some TLDs, the privacy protection available depends on the value that you specify for \n\t\t\t\tContact Type. For the privacy protection settings for your TLD, see \n\t\t\t\tDomains that You Can \n\t\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer Guide\n

    \n
  • \n
  • \n

    For .es domains, the value of ContactType must be PERSON for all three contacts.

    \n
  • \n
" } }, "OrganizationName": { @@ -465,6 +475,10 @@ "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "AC", + "name": "AC" + }, { "value": "AD", "name": "AD" @@ -525,6 +539,10 @@ "value": "AW", "name": "AW" }, + { + "value": "AX", + "name": "AX" + }, { "value": "AZ", "name": "AZ" @@ -581,6 +599,10 @@ "value": "BO", "name": "BO" }, + { + "value": "BQ", + "name": "BQ" + }, { "value": "BR", "name": "BR" @@ -593,6 +615,10 @@ "value": "BT", "name": "BT" }, + { + "value": "BV", + "name": "BV" + }, { "value": "BW", "name": "BW" @@ -665,6 +691,10 @@ "value": "CV", "name": "CV" }, + { + "value": "CW", + "name": "CW" + }, { "value": "CX", "name": "CX" @@ -713,6 +743,10 @@ "value": "EG", "name": "EG" }, + { + "value": "EH", + "name": "EH" + }, { "value": "ER", "name": "ER" @@ -765,6 +799,14 @@ "value": "GE", "name": "GE" }, + { + "value": "GF", + "name": "GF" + }, + { + "value": "GG", + "name": "GG" + }, { "value": "GH", "name": "GH" @@ -785,6 +827,10 @@ "value": "GN", "name": "GN" }, + { + "value": "GP", + "name": "GP" + }, { "value": "GQ", "name": "GQ" @@ -793,6 +839,10 @@ "value": "GR", "name": "GR" }, + { + "value": "GS", + "name": "GS" + }, { "value": "GT", "name": "GT" @@ -813,6 +863,10 @@ "value": "HK", "name": "HK" }, + { + "value": "HM", + "name": "HM" + }, { "value": "HN", "name": "HN" @@ -849,6 +903,10 @@ "value": "IN", "name": "IN" }, + { + "value": "IO", + "name": "IO" + }, { "value": "IQ", "name": "IQ" @@ -865,6 +923,10 @@ "value": "IT", "name": "IT" }, + { + "value": "JE", + "name": "JE" + }, { "value": "JM", "name": "JM" @@ -1017,6 +1079,10 @@ "value": "MP", "name": "MP" }, + { + "value": "MQ", + "name": "MQ" + }, { "value": "MR", "name": "MR" @@ -1065,6 +1131,10 @@ "value": "NE", "name": "NE" }, + { + "value": "NF", + "name": "NF" + }, { "value": "NG", "name": "NG" @@ -1141,6 +1211,10 @@ "value": "PR", "name": "PR" }, + { + "value": "PS", + "name": "PS" + }, { "value": "PT", "name": "PT" @@ -1157,6 +1231,10 @@ "value": "QA", "name": "QA" }, + { + "value": "RE", + "name": "RE" + }, { "value": "RO", "name": "RO" @@ -1205,6 +1283,10 @@ "value": "SI", "name": "SI" }, + { + "value": "SJ", + "name": "SJ" + }, { "value": "SK", "name": "SK" @@ -1229,6 +1311,10 @@ "value": "SR", "name": "SR" }, + { + "value": "SS", + "name": "SS" + }, { "value": "ST", "name": "ST" @@ -1237,6 +1323,10 @@ "value": "SV", "name": "SV" }, + { + "value": "SX", + "name": "SX" + }, { "value": "SY", "name": "SY" @@ -1253,6 +1343,10 @@ "value": "TD", "name": "TD" }, + { + "value": "TF", + "name": "TF" + }, { "value": "TG", "name": "TG" @@ -1285,6 +1379,10 @@ "value": "TO", "name": "TO" }, + { + "value": "TP", + "name": "TP" + }, { "value": "TR", "name": "TR" @@ -1384,12 +1482,70 @@ ] } }, + "com.amazonaws.route53domains#Currency": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 3 + } + } + }, "com.amazonaws.route53domains#CurrentExpiryYear": { "type": "integer" }, "com.amazonaws.route53domains#DNSSec": { "type": "string" }, + "com.amazonaws.route53domains#DeleteDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#DeleteDomainRequest" + }, + "output": { + "target": "com.amazonaws.route53domains#DeleteDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#DuplicateRequest" + }, + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#TLDRulesViolation" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], + "traits": { + "smithy.api#documentation": "

This operation deletes the specified domain. This action is permanent. For more information,\n\t\t\tsee Deleting a domain name registration.

\n\t\t

To transfer the domain registration to another registrar, use the transfer process that’s\n\t\t\tprovided by the registrar to which you want to transfer the registration. Otherwise,\n\t\t\tthe following apply:

\n\t\t
    \n
  1. \n

    You can’t get a refund for the cost of a deleted domain registration.

    \n
  2. \n
  3. \n

    The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry).

    \n
  4. \n
  5. \n

    When the registration has been deleted, we'll send you a confirmation to the registrant\n\t\t\t\tcontact. The email will come from\n\t\t\t\tnoreply@domainnameverification.net or\n\t\t\t\tnoreply@registrar.amazon.com.

    \n
  6. \n
" + } + }, + "com.amazonaws.route53domains#DeleteDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "

Name of the domain to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53domains#DeleteDomainResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "

Identifier for tracking the progress of the request. \n\t\t\tTo query the operation status, use GetOperationDetail.

" + } + } + } + }, "com.amazonaws.route53domains#DeleteTagsForDomain": { "type": "operation", "input": { @@ -1608,6 +1764,65 @@ } } }, + "com.amazonaws.route53domains#DomainPrice": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53domains#DomainPriceName", + "traits": { + "smithy.api#documentation": "

The name of the TLD for which the prices apply.

" + } + }, + "RegistrationPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "

The price for domain registration with RouteΒ 53.

" + } + }, + "TransferPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "

The price for transferring the domain registration to RouteΒ 53.

" + } + }, + "RenewalPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "

The price for renewing domain registration with RouteΒ 53.

" + } + }, + "ChangeOwnershipPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "

The price for changing domain ownership.

" + } + }, + "RestorationPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "

The price for restoring the domain with RouteΒ 53.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the domain price associated with a TLD.

" + } + }, + "com.amazonaws.route53domains#DomainPriceList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#DomainPrice" + } + }, + "com.amazonaws.route53domains#DomainPriceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.route53domains#DomainStatus": { "type": "string" }, @@ -1748,7 +1963,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. \n\t\t\tThe cost of renewing your domain registration is billed to your AWS account.

\n\t\t

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \n\t\t\tDomains That You Can Register with Amazon Route 53 \n\t\t\tin the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period \n\t\t\tso we can complete processing before the deadline.

" + "smithy.api#documentation": "

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. \n\t\t\tThe cost of renewing your domain registration is billed to your Amazon Web Services account.

\n\t\t

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \n\t\t\tDomains That You Can Register with Amazon Route 53 \n\t\t\tin the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period \n\t\t\tso we can complete processing before the deadline.

" } }, "com.amazonaws.route53domains#EnableDomainAutoRenewRequest": { @@ -1835,7 +2050,7 @@ "Name": { "target": "com.amazonaws.route53domains#ExtraParamName", "traits": { - "smithy.api#documentation": "

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require \n\t\t\tadditional parameters and the names of the parameters that they require:

\n\n\t\t
\n
.com.au and .net.au
\n
\n\t\t\t\t\t
    \n
  • \n

    \n AU_ID_NUMBER\n

    \n
  • \n
  • \n

    \n AU_ID_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ABN (Australian business number)

      \n
    • \n
    • \n

      \n ACN (Australian company number)

      \n
    • \n
    • \n

      \n TM (Trademark number)

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.ca
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BRAND_NUMBER\n

    \n
  • \n
  • \n

    \n CA_BUSINESS_ENTITY_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n BANK (Bank)

      \n
    • \n
    • \n

      \n COMMERCIAL_COMPANY (Commercial company)

      \n
    • \n
    • \n

      \n COMPANY (Company)

      \n
    • \n
    • \n

      \n COOPERATION (Cooperation)

      \n
    • \n
    • \n

      \n COOPERATIVE (Cooperative)

      \n
    • \n
    • \n

      \n COOPRIX (Cooprix)

      \n
    • \n
    • \n

      \n CORP (Corporation)

      \n
    • \n
    • \n

      \n CREDIT_UNION (Credit union)

      \n
    • \n
    • \n

      \n FOMIA (Federation of mutual insurance associations)

      \n
    • \n
    • \n

      \n INC (Incorporated)

      \n
    • \n
    • \n

      \n LTD (Limited)

      \n
    • \n
    • \n

      \n LTEE (LimitΓ©e)

      \n
    • \n
    • \n

      \n LLC (Limited liability corporation)

      \n
    • \n
    • \n

      \n LLP (Limited liability partnership)

      \n
    • \n
    • \n

      \n LTE (Lte.)

      \n
    • \n
    • \n

      \n MBA (Mutual benefit association)

      \n
    • \n
    • \n

      \n MIC (Mutual insurance company)

      \n
    • \n
    • \n

      \n NFP (Not-for-profit corporation)

      \n
    • \n
    • \n

      \n SA (S.A.)

      \n
    • \n
    • \n

      \n SAVINGS_COMPANY (Savings company)

      \n
    • \n
    • \n

      \n SAVINGS_UNION (Savings union)

      \n
    • \n
    • \n

      \n SARL (SociΓ©tΓ© Γ  responsabilitΓ© limitΓ©e)

      \n
    • \n
    • \n

      \n TRUST (Trust)

      \n
    • \n
    • \n

      \n ULC (Unlimited liability corporation)

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n CA_LEGAL_TYPE\n

    \n\t\t\t\t\t\t\t

    When ContactType is PERSON, valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ABO (Aboriginal Peoples indigenous to Canada)

      \n
    • \n
    • \n

      \n CCT (Canadian citizen)

      \n
    • \n
    • \n

      \n LGR (Legal Representative of a Canadian Citizen or Permanent Resident)

      \n
    • \n
    • \n

      \n RES (Permanent resident of Canada)

      \n
    • \n
    \n\n\t\t\t\t\t\t\t

    When ContactType is a value other than PERSON, valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ASS (Canadian unincorporated association)

      \n
    • \n
    • \n

      \n CCO (Canadian corporation)

      \n
    • \n
    • \n

      \n EDU (Canadian educational institution)

      \n
    • \n
    • \n

      \n GOV (Government or government entity in Canada)

      \n
    • \n
    • \n

      \n HOP (Canadian Hospital)

      \n
    • \n
    • \n

      \n INB (Indian Band recognized by the Indian Act of Canada)

      \n
    • \n
    • \n

      \n LAM (Canadian Library, Archive, or Museum)

      \n
    • \n
    • \n

      \n MAJ (Her/His Majesty the Queen/King)

      \n
    • \n
    • \n

      \n OMK (Official mark registered in Canada)

      \n
    • \n
    • \n

      \n PLT (Canadian Political Party)

      \n
    • \n
    • \n

      \n PRT (Partnership Registered in Canada)

      \n
    • \n
    • \n

      \n TDM (Trademark registered in Canada)

      \n
    • \n
    • \n

      \n TRD (Canadian Trade Union)

      \n
    • \n
    • \n

      \n TRS (Trust established in Canada)

      \n
    • \n
    \n\n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.es
\n
\n\t\t\t\t\t
    \n
  • \n

    \n ES_IDENTIFICATION\n

    \n\t\t\t\t\t\t\t

    Specify the applicable value:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n For contacts inside Spain: Enter your passport ID.

      \n
    • \n
    • \n

      \n For contacts outside of Spain: Enter the VAT identification number \n\t\t\t\t\t\t\t\t\tfor the company.

      \n\t\t\t\t\t\t\t\t\t \n

      For .es domains, the value of ContactType must be PERSON.

      \n
      \n\t\t\t\t\t\t\t\t
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n ES_IDENTIFICATION_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n DNI_AND_NIF (For Spanish contacts)

      \n
    • \n
    • \n

      \n NIE (For foreigners with legal residence)

      \n
    • \n
    • \n

      \n OTHER (For contacts outside of Spain)

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n ES_LEGAL_FORM\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ASSOCIATION\n

      \n
    • \n
    • \n

      \n CENTRAL_GOVERNMENT_BODY\n

      \n
    • \n
    • \n

      \n CIVIL_SOCIETY\n

      \n
    • \n
    • \n

      \n COMMUNITY_OF_OWNERS\n

      \n
    • \n
    • \n

      \n COMMUNITY_PROPERTY\n

      \n
    • \n
    • \n

      \n CONSULATE\n

      \n
    • \n
    • \n

      \n COOPERATIVE\n

      \n
    • \n
    • \n

      \n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n

      \n
    • \n
    • \n

      \n ECONOMIC_INTEREST_GROUP\n

      \n
    • \n
    • \n

      \n EMBASSY\n

      \n
    • \n
    • \n

      \n ENTITY_MANAGING_NATURAL_AREAS\n

      \n
    • \n
    • \n

      \n FARM_PARTNERSHIP\n

      \n
    • \n
    • \n

      \n FOUNDATION\n

      \n
    • \n
    • \n

      \n GENERAL_AND_LIMITED_PARTNERSHIP\n

      \n
    • \n
    • \n

      \n GENERAL_PARTNERSHIP\n

      \n
    • \n
    • \n

      \n INDIVIDUAL\n

      \n
    • \n
    • \n

      \n LIMITED_COMPANY\n

      \n
    • \n
    • \n

      \n LOCAL_AUTHORITY\n

      \n
    • \n
    • \n

      \n LOCAL_PUBLIC_ENTITY\n

      \n
    • \n
    • \n

      \n MUTUAL_INSURANCE_COMPANY\n

      \n
    • \n
    • \n

      \n NATIONAL_PUBLIC_ENTITY\n

      \n
    • \n
    • \n

      \n ORDER_OR_RELIGIOUS_INSTITUTION\n

      \n
    • \n
    • \n

      \n OTHERS (Only for contacts outside of Spain)\n

      \n
    • \n
    • \n

      \n POLITICAL_PARTY\n

      \n
    • \n
    • \n

      \n PROFESSIONAL_ASSOCIATION\n

      \n
    • \n
    • \n

      \n PUBLIC_LAW_ASSOCIATION\n

      \n
    • \n
    • \n

      \n PUBLIC_LIMITED_COMPANY\n

      \n
    • \n
    • \n

      \n REGIONAL_GOVERNMENT_BODY\n

      \n
    • \n
    • \n

      \n REGIONAL_PUBLIC_ENTITY\n

      \n
    • \n
    • \n

      \n SAVINGS_BANK\n

      \n
    • \n
    • \n

      \n SPANISH_OFFICE\n

      \n
    • \n
    • \n

      \n SPORTS_ASSOCIATION\n

      \n
    • \n
    • \n

      \n SPORTS_FEDERATION\n

      \n
    • \n
    • \n

      \n SPORTS_LIMITED_COMPANY\n

      \n
    • \n
    • \n

      \n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n

      \n
    • \n
    • \n

      \n TRADE_UNION\n

      \n
    • \n
    • \n

      \n WORKER_OWNED_COMPANY\n

      \n
    • \n
    • \n

      \n WORKER_OWNED_LIMITED_COMPANY\n

      \n
    • \n
    \n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.fi
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
  • \n
  • \n

    \n FI_BUSINESS_NUMBER\n

    \n
  • \n
  • \n

    \n FI_ID_NUMBER\n

    \n
  • \n
  • \n

    \n FI_NATIONALITY\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n FINNISH\n

      \n
    • \n
    • \n

      \n NOT_FINNISH\n

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n FI_ORGANIZATION_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n COMPANY\n

      \n
    • \n
    • \n

      \n CORPORATION\n

      \n
    • \n
    • \n

      \n GOVERNMENT\n

      \n
    • \n
    • \n

      \n INSTITUTION\n

      \n
    • \n
    • \n

      \n POLITICAL_PARTY\n

      \n
    • \n
    • \n

      \n PUBLIC_COMMUNITY\n

      \n
    • \n
    • \n

      \n TOWNSHIP\n

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.fr
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_CITY\n

    \n
  • \n
  • \n

    \n BIRTH_COUNTRY\n

    \n
  • \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
  • \n
  • \n

    \n BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. \n\t\t\t\t\t\t\tIf the contact was born somewhere other than France or its overseas departments, specify 99. For more information, \n\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers, see the Wikipedia entry \n\t\t\t\t\t\t\tDepartments of France.

    \n
  • \n
  • \n

    \n BRAND_NUMBER\n

    \n
  • \n
\n\t\t\t\t
\n
.it
\n
\n\t\t\t\t\t
    \n
  • \n

    \n IT_NATIONALITY\n

    \n
  • \n
  • \n

    \n IT_PIN\n

    \n
  • \n
  • \n

    \n IT_REGISTRANT_ENTITY_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n FOREIGNERS\n

      \n
    • \n
    • \n

      \n FREELANCE_WORKERS (Freelance workers and professionals)

      \n
    • \n
    • \n

      \n ITALIAN_COMPANIES (Italian companies and one-person companies)

      \n
    • \n
    • \n

      \n NON_PROFIT_ORGANIZATIONS\n

      \n
    • \n
    • \n

      \n OTHER_SUBJECTS\n

      \n
    • \n
    • \n

      \n PUBLIC_ORGANIZATIONS\n

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.ru
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
  • \n
  • \n

    \n RU_PASSPORT_DATA\n

    \n
  • \n
\n\t\t\t\t
\n
.se
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_COUNTRY\n

    \n
  • \n
  • \n

    \n SE_ID_NUMBER\n

    \n
  • \n
\n\t\t\t\t
\n
.sg
\n
\n\t\t\t\t\t
    \n
  • \n

    \n SG_ID_NUMBER\n

    \n
  • \n
\n\t\t\t\t
\n
.co.uk, .me.uk, and .org.uk
\n
\n\t\t\t\t\t
    \n
  • \n

    \n UK_CONTACT_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n CRC (UK Corporation by Royal Charter)

      \n
    • \n
    • \n

      \n FCORP (Non-UK Corporation)

      \n
    • \n
    • \n

      \n FIND (Non-UK Individual, representing self)

      \n
    • \n
    • \n

      \n FOTHER (Non-UK Entity that does not fit into any other category)

      \n
    • \n
    • \n

      \n GOV (UK Government Body)

      \n
    • \n
    • \n

      \n IND (UK Individual (representing self))

      \n
    • \n
    • \n

      \n IP (UK Industrial/Provident Registered Company)

      \n
    • \n
    • \n

      \n LLP (UK Limited Liability Partnership)

      \n
    • \n
    • \n

      \n LTD (UK Limited Company)

      \n
    • \n
    • \n

      \n OTHER (UK Entity that does not fit into any other category)

      \n
    • \n
    • \n

      \n PLC (UK Public Limited Company)

      \n
    • \n
    • \n

      \n PTNR (UK Partnership)

      \n
    • \n
    • \n

      \n RCHAR (UK Registered Charity)

      \n
    • \n
    • \n

      \n SCH (UK School)

      \n
    • \n
    • \n

      \n STAT (UK Statutory Body)

      \n
    • \n
    • \n

      \n STRA (UK Sole Trader)

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n UK_COMPANY_NUMBER\n

    \n
  • \n
\n\t\t\t\t
\n
\n\n\t\t

In addition, many TLDs require a VAT_NUMBER.

", + "smithy.api#documentation": "

The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require \n\t\t\tadditional parameters and the names of the parameters that they require:

\n\n\t\t
\n
.com.au and .net.au
\n
\n\t\t\t\t\t
    \n
  • \n

    \n AU_ID_NUMBER\n

    \n
  • \n
  • \n

    \n AU_ID_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ABN (Australian business number)

      \n
    • \n
    • \n

      \n ACN (Australian company number)

      \n
    • \n
    • \n

      \n TM (Trademark number)

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.ca
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BRAND_NUMBER\n

    \n
  • \n
  • \n

    \n CA_BUSINESS_ENTITY_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n BANK (Bank)

      \n
    • \n
    • \n

      \n COMMERCIAL_COMPANY (Commercial company)

      \n
    • \n
    • \n

      \n COMPANY (Company)

      \n
    • \n
    • \n

      \n COOPERATION (Cooperation)

      \n
    • \n
    • \n

      \n COOPERATIVE (Cooperative)

      \n
    • \n
    • \n

      \n COOPRIX (Cooprix)

      \n
    • \n
    • \n

      \n CORP (Corporation)

      \n
    • \n
    • \n

      \n CREDIT_UNION (Credit union)

      \n
    • \n
    • \n

      \n FOMIA (Federation of mutual insurance associations)

      \n
    • \n
    • \n

      \n INC (Incorporated)

      \n
    • \n
    • \n

      \n LTD (Limited)

      \n
    • \n
    • \n

      \n LTEE (LimitΓ©e)

      \n
    • \n
    • \n

      \n LLC (Limited liability corporation)

      \n
    • \n
    • \n

      \n LLP (Limited liability partnership)

      \n
    • \n
    • \n

      \n LTE (Lte.)

      \n
    • \n
    • \n

      \n MBA (Mutual benefit association)

      \n
    • \n
    • \n

      \n MIC (Mutual insurance company)

      \n
    • \n
    • \n

      \n NFP (Not-for-profit corporation)

      \n
    • \n
    • \n

      \n SA (S.A.)

      \n
    • \n
    • \n

      \n SAVINGS_COMPANY (Savings company)

      \n
    • \n
    • \n

      \n SAVINGS_UNION (Savings union)

      \n
    • \n
    • \n

      \n SARL (SociΓ©tΓ© Γ  responsabilitΓ© limitΓ©e)

      \n
    • \n
    • \n

      \n TRUST (Trust)

      \n
    • \n
    • \n

      \n ULC (Unlimited liability corporation)

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n CA_LEGAL_TYPE\n

    \n\t\t\t\t\t\t\t

    When ContactType is PERSON, valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ABO (Aboriginal Peoples indigenous to Canada)

      \n
    • \n
    • \n

      \n CCT (Canadian citizen)

      \n
    • \n
    • \n

      \n LGR (Legal Representative of a Canadian Citizen or Permanent Resident)

      \n
    • \n
    • \n

      \n RES (Permanent resident of Canada)

      \n
    • \n
    \n\n\t\t\t\t\t\t\t

    When ContactType is a value other than PERSON, valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ASS (Canadian unincorporated association)

      \n
    • \n
    • \n

      \n CCO (Canadian corporation)

      \n
    • \n
    • \n

      \n EDU (Canadian educational institution)

      \n
    • \n
    • \n

      \n GOV (Government or government entity in Canada)

      \n
    • \n
    • \n

      \n HOP (Canadian Hospital)

      \n
    • \n
    • \n

      \n INB (Indian Band recognized by the Indian Act of Canada)

      \n
    • \n
    • \n

      \n LAM (Canadian Library, Archive, or Museum)

      \n
    • \n
    • \n

      \n MAJ (Her/His Majesty the Queen/King)

      \n
    • \n
    • \n

      \n OMK (Official mark registered in Canada)

      \n
    • \n
    • \n

      \n PLT (Canadian Political Party)

      \n
    • \n
    • \n

      \n PRT (Partnership Registered in Canada)

      \n
    • \n
    • \n

      \n TDM (Trademark registered in Canada)

      \n
    • \n
    • \n

      \n TRD (Canadian Trade Union)

      \n
    • \n
    • \n

      \n TRS (Trust established in Canada)

      \n
    • \n
    \n\n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.es
\n
\n\t\t\t\t\t
    \n
  • \n

    \n ES_IDENTIFICATION\n

    \n\t\t\t\t\t\t\t

    The value of ES_IDENTIFICATION depends on the following values:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      The value of ES_LEGAL_FORM\n

      \n
    • \n
    • \n

      The value of ES_IDENTIFICATION_TYPE\n

      \n
    • \n
    \n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t

    \n If ES_LEGAL_FORM is any value other than INDIVIDUAL:\n

    \n\t\t\t\t\t\t\t
      \n
    • \n

      Specify 1 letter + 8 numbers (CIF [Certificado de IdentificaciΓ³n Fiscal])

      \n
    • \n
    • \n

      Example: B12345678

      \n
    • \n
    \n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t

    \n If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for \n\t\t\t\t\t\t\t\tES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:\n

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):

      \n\t\t\t\t\t\t\t\t\t
        \n
      • \n

        Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [NΓΊmero de IdentificaciΓ³n Fiscal])

        \n
      • \n
      • \n

        Example: 12345678M

        \n
      • \n
      \n\t\t\t\t\t\t\t\t
    • \n
    • \n\t\t\t\t\t\t\t\t\t

      If ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):

      \n\t\t\t\t\t\t\t\t\t
        \n
      • \n

        Specify 1 letter + 7 numbers + 1 letter ( NIE [NΓΊmero de Identidad de Extranjero])

        \n
      • \n
      • \n

        Example: Y1234567X

        \n
      • \n
      \n\t\t\t\t\t\t\t\t
    • \n
    • \n\t\t\t\t\t\t\t\t\t

      If ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):

      \n\t\t\t\t\t\t\t\t\t
        \n
      • \n

        Specify a passport number, drivers license number, or national identity card number

        \n
      • \n
      \n\t\t\t\t\t\t\t\t
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n ES_IDENTIFICATION_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n DNI_AND_NIF (For Spanish contacts)

      \n
    • \n
    • \n

      \n NIE (For foreigners with legal residence)

      \n
    • \n
    • \n

      \n OTHER (For contacts outside of Spain)

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n ES_LEGAL_FORM\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n ASSOCIATION\n

      \n
    • \n
    • \n

      \n CENTRAL_GOVERNMENT_BODY\n

      \n
    • \n
    • \n

      \n CIVIL_SOCIETY\n

      \n
    • \n
    • \n

      \n COMMUNITY_OF_OWNERS\n

      \n
    • \n
    • \n

      \n COMMUNITY_PROPERTY\n

      \n
    • \n
    • \n

      \n CONSULATE\n

      \n
    • \n
    • \n

      \n COOPERATIVE\n

      \n
    • \n
    • \n

      \n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n

      \n
    • \n
    • \n

      \n ECONOMIC_INTEREST_GROUP\n

      \n
    • \n
    • \n

      \n EMBASSY\n

      \n
    • \n
    • \n

      \n ENTITY_MANAGING_NATURAL_AREAS\n

      \n
    • \n
    • \n

      \n FARM_PARTNERSHIP\n

      \n
    • \n
    • \n

      \n FOUNDATION\n

      \n
    • \n
    • \n

      \n GENERAL_AND_LIMITED_PARTNERSHIP\n

      \n
    • \n
    • \n

      \n GENERAL_PARTNERSHIP\n

      \n
    • \n
    • \n

      \n INDIVIDUAL\n

      \n
    • \n
    • \n

      \n LIMITED_COMPANY\n

      \n
    • \n
    • \n

      \n LOCAL_AUTHORITY\n

      \n
    • \n
    • \n

      \n LOCAL_PUBLIC_ENTITY\n

      \n
    • \n
    • \n

      \n MUTUAL_INSURANCE_COMPANY\n

      \n
    • \n
    • \n

      \n NATIONAL_PUBLIC_ENTITY\n

      \n
    • \n
    • \n

      \n ORDER_OR_RELIGIOUS_INSTITUTION\n

      \n
    • \n
    • \n

      \n OTHERS (Only for contacts outside of Spain)\n

      \n
    • \n
    • \n

      \n POLITICAL_PARTY\n

      \n
    • \n
    • \n

      \n PROFESSIONAL_ASSOCIATION\n

      \n
    • \n
    • \n

      \n PUBLIC_LAW_ASSOCIATION\n

      \n
    • \n
    • \n

      \n PUBLIC_LIMITED_COMPANY\n

      \n
    • \n
    • \n

      \n REGIONAL_GOVERNMENT_BODY\n

      \n
    • \n
    • \n

      \n REGIONAL_PUBLIC_ENTITY\n

      \n
    • \n
    • \n

      \n SAVINGS_BANK\n

      \n
    • \n
    • \n

      \n SPANISH_OFFICE\n

      \n
    • \n
    • \n

      \n SPORTS_ASSOCIATION\n

      \n
    • \n
    • \n

      \n SPORTS_FEDERATION\n

      \n
    • \n
    • \n

      \n SPORTS_LIMITED_COMPANY\n

      \n
    • \n
    • \n

      \n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n

      \n
    • \n
    • \n

      \n TRADE_UNION\n

      \n
    • \n
    • \n

      \n WORKER_OWNED_COMPANY\n

      \n
    • \n
    • \n

      \n WORKER_OWNED_LIMITED_COMPANY\n

      \n
    • \n
    \n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.eu
\n
\n\t\t
    \n
  • \n

    \n EU_COUNTRY_OF_CITIZENSHIP\n

    \n
  • \n
\n\t\t
\n
.fi
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
  • \n
  • \n

    \n FI_BUSINESS_NUMBER\n

    \n
  • \n
  • \n

    \n FI_ID_NUMBER\n

    \n
  • \n
  • \n

    \n FI_NATIONALITY\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n FINNISH\n

      \n
    • \n
    • \n

      \n NOT_FINNISH\n

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n FI_ORGANIZATION_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n COMPANY\n

      \n
    • \n
    • \n

      \n CORPORATION\n

      \n
    • \n
    • \n

      \n GOVERNMENT\n

      \n
    • \n
    • \n

      \n INSTITUTION\n

      \n
    • \n
    • \n

      \n POLITICAL_PARTY\n

      \n
    • \n
    • \n

      \n PUBLIC_COMMUNITY\n

      \n
    • \n
    • \n

      \n TOWNSHIP\n

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.fr
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_CITY\n

    \n
  • \n
  • \n

    \n BIRTH_COUNTRY\n

    \n
  • \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
  • \n
  • \n

    \n BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. \n\t\t\t\t\t\t\tIf the contact was born somewhere other than France or its overseas departments, specify 99. For more information, \n\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers, see the Wikipedia entry \n\t\t\t\t\t\t\tDepartments of France.

    \n
  • \n
  • \n

    \n BRAND_NUMBER\n

    \n
  • \n
\n\t\t\t\t
\n
.it
\n
\n\t\t\t\t\t
    \n
  • \n

    \n IT_NATIONALITY\n

    \n
  • \n
  • \n

    \n IT_PIN\n

    \n
  • \n
  • \n

    \n IT_REGISTRANT_ENTITY_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n FOREIGNERS\n

      \n
    • \n
    • \n

      \n FREELANCE_WORKERS (Freelance workers and professionals)

      \n
    • \n
    • \n

      \n ITALIAN_COMPANIES (Italian companies and one-person companies)

      \n
    • \n
    • \n

      \n NON_PROFIT_ORGANIZATIONS\n

      \n
    • \n
    • \n

      \n OTHER_SUBJECTS\n

      \n
    • \n
    • \n

      \n PUBLIC_ORGANIZATIONS\n

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
\n\t\t\t\t
\n
.ru
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_DATE_IN_YYYY_MM_DD\n

    \n
  • \n
  • \n

    \n RU_PASSPORT_DATA\n

    \n
  • \n
\n\t\t\t\t
\n
.se
\n
\n\t\t\t\t\t
    \n
  • \n

    \n BIRTH_COUNTRY\n

    \n
  • \n
  • \n

    \n SE_ID_NUMBER\n

    \n
  • \n
\n\t\t\t\t
\n
.sg
\n
\n\t\t\t\t\t
    \n
  • \n

    \n SG_ID_NUMBER\n

    \n
  • \n
\n\t\t\t\t
\n
.co.uk, .me.uk, and .org.uk
\n
\n\t\t\t\t\t
    \n
  • \n

    \n UK_CONTACT_TYPE\n

    \n\t\t\t\t\t\t\t

    Valid values include the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      \n CRC (UK Corporation by Royal Charter)

      \n
    • \n
    • \n

      \n FCORP (Non-UK Corporation)

      \n
    • \n
    • \n

      \n FIND (Non-UK Individual, representing self)

      \n
    • \n
    • \n

      \n FOTHER (Non-UK Entity that does not fit into any other category)

      \n
    • \n
    • \n

      \n GOV (UK Government Body)

      \n
    • \n
    • \n

      \n IND (UK Individual (representing self))

      \n
    • \n
    • \n

      \n IP (UK Industrial/Provident Registered Company)

      \n
    • \n
    • \n

      \n LLP (UK Limited Liability Partnership)

      \n
    • \n
    • \n

      \n LTD (UK Limited Company)

      \n
    • \n
    • \n

      \n OTHER (UK Entity that does not fit into any other category)

      \n
    • \n
    • \n

      \n PLC (UK Public Limited Company)

      \n
    • \n
    • \n

      \n PTNR (UK Partnership)

      \n
    • \n
    • \n

      \n RCHAR (UK Registered Charity)

      \n
    • \n
    • \n

      \n SCH (UK School)

      \n
    • \n
    • \n

      \n STAT (UK Statutory Body)

      \n
    • \n
    • \n

      \n STRA (UK Sole Trader)

      \n
    • \n
    \n\t\t\t\t\t\t
  • \n
  • \n

    \n UK_COMPANY_NUMBER\n

    \n
  • \n
\n\t\t\t\t
\n
\n\n\t\t

In addition, many TLDs require a VAT_NUMBER.

", "smithy.api#required": {} } }, @@ -1976,6 +2191,10 @@ { "value": "UK_COMPANY_NUMBER", "name": "UK_COMPANY_NUMBER" + }, + { + "value": "EU_COUNTRY_OF_CITIZENSHIP", + "name": "EU_COUNTRY_OF_CITIZENSHIP" } ] } @@ -1986,11 +2205,54 @@ "smithy.api#length": { "min": 0, "max": 2048 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.route53domains#FIAuthKey": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.route53domains#FilterCondition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53domains#ListDomainsAttributeName", + "traits": { + "smithy.api#documentation": "

Name of the field which should be used for filtering the list of domains.

", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.route53domains#Operator", + "traits": { + "smithy.api#documentation": "

The operator values for filtering domain names. The values can be:

\n\t\t
    \n
  • \n

    \n LE: Less than, or equal to

    \n
  • \n
  • \n

    \n GE: Greater than, or equal to

    \n
  • \n
  • \n

    \n BEGINS_WITH: Begins with

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.route53domains#Values", + "traits": { + "smithy.api#documentation": "

An array of strings presenting values to compare. Only 1 item in the list is currently supported.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information for the filtering of a list of domains returned by \n\t\t\tListDomains.

" + } + }, + "com.amazonaws.route53domains#FilterConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#FilterCondition" + } }, "com.amazonaws.route53domains#GetContactReachabilityStatus": { "type": "operation", @@ -2060,7 +2322,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns detailed information about a specified domain that is associated with the current AWS account. \n\t\t\tContact information for the domain is also returned as part of the output.

" + "smithy.api#documentation": "

This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. \n\t\t\tContact information for the domain is also returned as part of the output.

" } }, "com.amazonaws.route53domains#GetDomainDetailRequest": { @@ -2091,7 +2353,7 @@ "Nameservers": { "target": "com.amazonaws.route53domains#NameserverList", "traits": { - "smithy.api#documentation": "

The name of the domain.

", + "smithy.api#documentation": "

The\n\t\t\tname of the domain.

", "smithy.api#required": {} } }, @@ -2125,7 +2387,7 @@ "AdminPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

" + "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS\n\t\t\tqueries. If the value is true, WHOIS (\"who is\") queries return contact\n\t\t\tinformation either for Amazon Registrar (for .com, .net, and .org domains) or for our\n\t\t\tregistrar associate, Gandi (for all other TLDs). If the value is false,\n\t\t\tWHOIS queries return the information that you entered for the admin contact.

" } }, "RegistrantPrivacy": { @@ -2203,7 +2465,7 @@ "DnsSec": { "target": "com.amazonaws.route53domains#DNSSec", "traits": { - "smithy.api#documentation": "

Reserved for future use.

" + "smithy.api#documentation": "

Deprecated.

" } }, "StatusList": { @@ -2372,7 +2634,7 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "[a-zA-Z0-9_\\-.]*" + "smithy.api#pattern": "^[a-zA-Z0-9_\\-.]*$" } }, "com.amazonaws.route53domains#Integer": { @@ -2420,7 +2682,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

", + "smithy.api#documentation": "

This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account\n\t\t\t if no filtering conditions are used.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2429,13 +2691,40 @@ } } }, + "com.amazonaws.route53domains#ListDomainsAttributeName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DomainName", + "name": "DomainName" + }, + { + "value": "Expiry", + "name": "Expiry" + } + ] + } + }, "com.amazonaws.route53domains#ListDomainsRequest": { "type": "structure", "members": { + "FilterConditions": { + "target": "com.amazonaws.route53domains#FilterConditions", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can\n\t\t\tinclude domain name and domain expiration.

" + } + }, + "SortCondition": { + "target": "com.amazonaws.route53domains#SortCondition", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the requested ordering of domains in the returned list.

" + } + }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

For an initial request for a list of domains, omit this element. If the number of domains\n\t\t\tthat are associated with the current AWS account is greater than the value that you specified for\n\t\t\tMaxItems, you can use Marker to return additional domains. Get the value of\n\t\t\tNextPageMarker from the previous response, and submit another request that includes the\n\t\t\tvalue of NextPageMarker in the Marker element.

\n\t\t

Constraints: The marker must match the value specified in the previous request.

" + "smithy.api#documentation": "

For an initial request for a list of domains, omit this element. If the number of domains\n\t\t\tthat are associated with the current Amazon Web Services account is greater than the value that you specified for\n\t\t\tMaxItems, you can use Marker to return additional domains. Get the value of\n\t\t\tNextPageMarker from the previous response, and submit another request that includes the\n\t\t\tvalue of NextPageMarker in the Marker element.

\n\t\t

Constraints: The marker must match the value specified in the previous request.

" } }, "MaxItems": { @@ -2455,7 +2744,7 @@ "Domains": { "target": "com.amazonaws.route53domains#DomainSummaryList", "traits": { - "smithy.api#documentation": "

A summary of domains.

", + "smithy.api#documentation": "

A list of domains.

", "smithy.api#required": {} } }, @@ -2484,7 +2773,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about all of the operations that return an operation ID and that have ever been \n\t\t\tperformed on domains that were registered by the current account.

", + "smithy.api#documentation": "

Returns information about all of the operations that return an operation ID and that have ever been \n\t\t\tperformed on domains that were registered by the current account.

\n\t\t

This command runs only in the us-east-1 Region.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2540,6 +2829,73 @@ "smithy.api#documentation": "

The ListOperations response includes the following elements.

" } }, + "com.amazonaws.route53domains#ListPrices": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#ListPricesRequest" + }, + "output": { + "target": "com.amazonaws.route53domains#ListPricesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the following prices for either all the TLDs supported by RouteΒ 53, or the specified TLD:

\n\t\t
    \n
  • \n

    Registration

    \n
  • \n
  • \n

    Transfer

    \n
  • \n
  • \n

    Owner change

    \n
  • \n
  • \n

    Domain renewal

    \n
  • \n
  • \n

    Domain restoration

    \n
  • \n
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextPageMarker", + "items": "Prices", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.route53domains#ListPricesRequest": { + "type": "structure", + "members": { + "Tld": { + "target": "com.amazonaws.route53domains#TldName", + "traits": { + "smithy.api#documentation": "

The TLD for which you want to receive the pricing information. For example.\n\t\t\t\t.net.

\n\t\t

If a Tld value is not provided, a list of prices for all TLDs supported by RouteΒ 53\n\t\tis returned.

" + } + }, + "Marker": { + "target": "com.amazonaws.route53domains#PageMarker", + "traits": { + "smithy.api#documentation": "

For an initial request for a list of prices, omit this element. \n\t\t\tIf the number of prices that are not yet complete is greater than the value that you specified for MaxItems, \n\t\t\tyou can use Marker to return additional prices. Get the value of NextPageMarker from the previous response, \n\t\t\tand submit another request that includes the value of NextPageMarker in the Marker element.

\n\t\t

Used only for all TLDs. If you specify a TLD, don't specify a Marker.

" + } + }, + "MaxItems": { + "target": "com.amazonaws.route53domains#PageMaxItems", + "traits": { + "smithy.api#documentation": "

Number of Prices to be returned.

\n\t\t

Used only for all TLDs. If you specify a TLD, don't specify a MaxItems.

" + } + } + } + }, + "com.amazonaws.route53domains#ListPricesResponse": { + "type": "structure", + "members": { + "Prices": { + "target": "com.amazonaws.route53domains#DomainPriceList", + "traits": { + "smithy.api#documentation": "

A complex type that includes all the pricing information. If you specify a TLD, this array\n\t\t\tcontains only the pricing for that TLD.

", + "smithy.api#required": {} + } + }, + "NextPageMarker": { + "target": "com.amazonaws.route53domains#PageMarker", + "traits": { + "smithy.api#documentation": "

If there are more prices than you specified for MaxItems in the request, submit another request and include the value of \n\t\t\tNextPageMarker in the value of Marker.

\n\t\t

Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tNextPageMarker.

" + } + } + } + }, "com.amazonaws.route53domains#ListTagsForDomain": { "type": "operation", "input": { @@ -2793,6 +3149,25 @@ ] } }, + "com.amazonaws.route53domains#Operator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LE", + "name": "LE" + }, + { + "value": "GE", + "name": "GE" + }, + { + "value": "BEGINS_WITH", + "name": "BEGINS_WITH" + } + ] + } + }, "com.amazonaws.route53domains#PageMarker": { "type": "string", "traits": { @@ -2814,6 +3189,28 @@ "com.amazonaws.route53domains#Price": { "type": "double" }, + "com.amazonaws.route53domains#PriceWithCurrency": { + "type": "structure", + "members": { + "Price": { + "target": "com.amazonaws.route53domains#Price", + "traits": { + "smithy.api#documentation": "

The price of a domain, in a specific currency.

", + "smithy.api#required": {} + } + }, + "Currency": { + "target": "com.amazonaws.route53domains#Currency", + "traits": { + "smithy.api#documentation": "

The currency specifier.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Currency-specific price information.

" + } + }, "com.amazonaws.route53domains#ReachabilityStatus": { "type": "string", "traits": { @@ -2862,7 +3259,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by \n\t\t\tour registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.

\n\t\t

When you register a domain, Amazon Route 53 does the following:

\n\t\t\t
    \n
  • \n

    Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers \n\t\t\t\t\tto your hosted zone and automatically updates your domain registration with the names of these name servers.

    \n
  • \n
  • \n

    Enables autorenew, so your domain registration will renew automatically each year. We'll notify you \n\t\t\t\t\tin advance of the renewal date so you can choose whether to renew the registration.

    \n
  • \n
  • \n

    Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar \n\t\t\t\t\t(for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy \n\t\t\t\t\tprotection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts.

    \n
  • \n
  • \n

    If registration is successful, returns an operation ID that you can use to track the progress and \n\t\t\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant is notified by email.

    \n
  • \n
  • \n

    Charges your AWS account an amount based on the top-level domain. For more information, see \n\t\t\t\t\tAmazon Route 53 Pricing.

    \n
  • \n
" + "smithy.api#documentation": "

This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by \n\t\t\tour registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.

\n\t\t

When you register a domain, Amazon Route 53 does the following:

\n\t\t\t
    \n
  • \n

    Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers \n\t\t\t\t\tto your hosted zone and automatically updates your domain registration with the names of these name servers.

    \n
  • \n
  • \n

    Enables autorenew, so your domain registration will renew automatically each year. We'll notify you \n\t\t\t\t\tin advance of the renewal date so you can choose whether to renew the registration.

    \n
  • \n
  • \n

    Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar \n\t\t\t\t\t(for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy \n\t\t\t\t\tprotection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.

    \n\t\t\t\t\t \n\t\t\t\t\t\t

    You must specify the same privacy setting for the administrative, registrant, and technical contacts.

    \n\t\t\t\t\t
    \n\t\t\t\t
  • \n
  • \n

    If registration is successful, returns an operation ID that you can use to track the progress and \n\t\t\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant is notified by email.

    \n
  • \n
  • \n

    Charges your Amazon Web Services account an amount based on the top-level domain. For more information, see \n\t\t\t\t\tAmazon Route 53 Pricing.

    \n
  • \n
" } }, "com.amazonaws.route53domains#RegisterDomainRequest": { @@ -2918,19 +3315,19 @@ "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

\n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
\n\t\t

Default: true\n

" } }, "PrivacyProtectRegistrantContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (the domain owner).

\n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (the domain owner).

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
\n\t\t

Default: true\n

" } }, "PrivacyProtectTechContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

\n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
\n\t\t

Default: true\n

" } } }, @@ -2979,10 +3376,13 @@ }, { "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" } ], "traits": { - "smithy.api#documentation": "

Rejects the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t

\n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" + "smithy.api#documentation": "

Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t

\n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" } }, "com.amazonaws.route53domains#RejectDomainTransferFromAnotherAwsAccountRequest": { @@ -2991,7 +3391,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that was specified when another AWS account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t

", + "smithy.api#documentation": "

The name of the domain that was specified when another Amazon Web Services account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t

", "smithy.api#required": {} } } @@ -3040,7 +3440,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.

\n\t\t

We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the \n\t\t\texpiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see \n\t\t\tRenewing Registration for a Domain \n\t\t\tin the Amazon Route 53 Developer Guide.

" + "smithy.api#documentation": "

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services account.

\n\t\t

We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the \n\t\t\texpiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see \n\t\t\tRenewing Registration for a Domain \n\t\t\tin the Amazon Route 53 Developer Guide.

" } }, "com.amazonaws.route53domains#RenewDomainRequest": { @@ -3195,6 +3595,24 @@ }, "com.amazonaws.route53domains#Route53Domains_v20140515": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Route 53 Domains", + "arnNamespace": "route53domains", + "cloudFormationName": "Route53Domains", + "cloudTrailEventSource": "route53domains.amazonaws.com", + "endpointPrefix": "route53domains" + }, + "aws.auth#sigv4": { + "name": "route53domains" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon Route 53 API actions let you register domain names and perform related operations.

", + "smithy.api#title": "Amazon Route 53 Domains", + "smithy.api#xmlNamespace": { + "uri": "https://route53domains.amazonaws.com/doc/2014-05-15/" + } + }, "version": "2014-05-15", "operations": [ { @@ -3209,6 +3627,9 @@ { "target": "com.amazonaws.route53domains#CheckDomainTransferability" }, + { + "target": "com.amazonaws.route53domains#DeleteDomain" + }, { "target": "com.amazonaws.route53domains#DeleteTagsForDomain" }, @@ -3242,6 +3663,9 @@ { "target": "com.amazonaws.route53domains#ListOperations" }, + { + "target": "com.amazonaws.route53domains#ListPrices" + }, { "target": "com.amazonaws.route53domains#ListTagsForDomain" }, @@ -3281,24 +3705,43 @@ { "target": "com.amazonaws.route53domains#ViewBilling" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Route 53 Domains", - "arnNamespace": "route53domains", - "cloudFormationName": "Route53Domains", - "cloudTrailEventSource": "route53domains.amazonaws.com", - "endpointPrefix": "route53domains" - }, - "aws.auth#sigv4": { - "name": "route53domains" + ] + }, + "com.amazonaws.route53domains#SortCondition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53domains#ListDomainsAttributeName", + "traits": { + "smithy.api#documentation": "

Field to be used for sorting the list of domains. It can be either the name or the expiration for a domain. Note that if \n\t\t\tfilterCondition is used in the same \n\t\t\tListDomains\n\t\t\t call, the field used for sorting has to be the same as the field used for filtering.

", + "smithy.api#required": {} + } }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Route 53 API actions let you register domain names and perform related operations.

", - "smithy.api#title": "Amazon Route 53 Domains", - "smithy.api#xmlNamespace": { - "uri": "https://route53domains.amazonaws.com/doc/2014-05-15/" + "SortOrder": { + "target": "com.amazonaws.route53domains#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order for a list of domains. Either ascending (ASC) or descending (DES).

", + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#documentation": "

Information for sorting a list of domains.

" + } + }, + "com.amazonaws.route53domains#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] } }, "com.amazonaws.route53domains#State": { @@ -3350,7 +3793,13 @@ } }, "com.amazonaws.route53domains#TagKey": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } }, "com.amazonaws.route53domains#TagKeyList": { "type": "list", @@ -3365,11 +3814,26 @@ } }, "com.amazonaws.route53domains#TagValue": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, "com.amazonaws.route53domains#Timestamp": { "type": "timestamp" }, + "com.amazonaws.route53domains#TldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.route53domains#TransferDomain": { "type": "operation", "input": { @@ -3399,7 +3863,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with \n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).

\n\t\t

For more information about transferring domains, see the following topics:

\n\t\t \n\t\t

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you \n\t\t\ttransfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars \n\t\t\tprovide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar \n\t\t\twill not renew your domain registration and could end your DNS service at any time.

\n\t\t\n\t\t\t \n\t\t\t\t

If the registrar for your domain is also the DNS service provider for the domain and you don't \n\t\t\t\t\ttransfer DNS service to another provider, your website, email, and the web applications associated with the domain \n\t\t\t\t\tmight become unavailable.

\n\t\t\t
\n\t\t\n\t\t

If the transfer is successful, this method returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

" + "smithy.api#documentation": "

Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with \n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).

\n\t\t

For more information about transferring domains, see the following topics:

\n\t\t \n\t\t

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you \n\t\t\ttransfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars \n\t\t\tprovide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar \n\t\t\twill not renew your domain registration and could end your DNS service at any time.

\n\t\t\n\t\t\t \n\t\t\t\t

If the registrar for your domain is also the DNS service provider for the domain and you don't \n\t\t\t\t\ttransfer DNS service to another provider, your website, email, and the web applications associated with the domain \n\t\t\t\t\tmight become unavailable.

\n\t\t\t
\n\t\t\n\t\t

If the transfer is successful, this method returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

" } }, "com.amazonaws.route53domains#TransferDomainRequest": { @@ -3467,19 +3931,19 @@ "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

\n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
\n\t\t

Default: true\n

" } }, "PrivacyProtectRegistrantContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

\n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
\n\t\t

Default: true\n

" } }, "PrivacyProtectTechContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

\n\t\t

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
\n\t\t

Default: true\n

" } } }, @@ -3519,10 +3983,13 @@ }, { "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" } ], "traits": { - "smithy.api#documentation": "

Transfers a domain from the current AWS account to another AWS account. Note the following:

\n\t\t \n\t\t\n\t\t \n\t\t\t

When you transfer a domain from one AWS account to another, Route 53 doesn't transfer the hosted zone that is associated \n\t\t\t\twith the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, \n\t\t\t\tso transferring the hosted zone is optional. For information about transferring the hosted zone to another AWS account, see \n\t\t\t\tMigrating a Hosted Zone to a \n\t\t\t\tDifferent AWS Account in the Amazon Route 53 Developer Guide.

\n\t\t
\n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" + "smithy.api#documentation": "

Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:

\n\t\t \n\t\t\n\t\t \n\t\t\t

When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated \n\t\t\t\twith the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, \n\t\t\t\tso transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see \n\t\t\t\tMigrating a Hosted Zone to a \n\t\t\t\t\tDifferent Amazon Web Services Account in the Amazon Route 53 Developer Guide.

\n\t\t
\n\t\t\n\t\t

Use either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t

" } }, "com.amazonaws.route53domains#TransferDomainToAnotherAwsAccountRequest": { @@ -3531,14 +3998,14 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain that you want to transfer from the current AWS account to another account.

", + "smithy.api#documentation": "

The name of the domain that you want to transfer from the current Amazon Web Services account to another account.

", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.route53domains#AccountId", "traits": { - "smithy.api#documentation": "

The account ID of the AWS account that you want to transfer the domain to, for example, 111122223333.

", + "smithy.api#documentation": "

The account ID of the Amazon Web Services account that you want to transfer the domain to, for example, 111122223333.

", "smithy.api#required": {} } } @@ -3559,7 +4026,7 @@ "Password": { "target": "com.amazonaws.route53domains#String", "traits": { - "smithy.api#documentation": "

To finish transferring a domain to another AWS account, the account that the domain is being transferred to must submit an \n\t\t\tAcceptDomainTransferFromAnotherAwsAccount\n\t\t\trequest. The request must include the value of the Password element that was returned in the \n\t\t\tTransferDomainToAnotherAwsAccount response.

" + "smithy.api#documentation": "

To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an \n\t\t\tAcceptDomainTransferFromAnotherAwsAccount\n\t\t\trequest. The request must include the value of the Password element that was returned in the \n\t\t\tTransferDomainToAnotherAwsAccount response.

" } } }, @@ -3658,7 +4125,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, \n\t\t\tcontact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org \n\t\t\tdomains) or with contact information for our registrar associate, Gandi.

\n\t\t

This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). \n\t\t\tIf the request succeeds, Amazon Route 53 returns an operation ID that you can use with \n\t\t\tGetOperationDetail\n\t\t\tto track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.

\n\t\t \n

By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain \n\t\t\tvia the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. \n\t\t\tYou may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the \n\t\t\tRoute 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. \n\t\t\tFor more information on our privacy practices, see \n\t\t\thttps://aws.amazon.com/privacy/.

\n
" + "smithy.api#documentation": "

This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, \n\t\t\tcontact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org \n\t\t\tdomains) or with contact information for our registrar associate, Gandi.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
\n\t\t

This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). \n\t\t\tIf the request succeeds, Amazon Route 53 returns an operation ID that you can use with \n\t\t\tGetOperationDetail\n\t\t\tto track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.

\n\t\t \n

By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain \n\t\t\tvia the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. \n\t\t\tYou may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the \n\t\t\tRoute 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. \n\t\t\tFor more information on our privacy practices, see \n\t\t\thttps://aws.amazon.com/privacy/.

\n
" } }, "com.amazonaws.route53domains#UpdateDomainContactPrivacyRequest": { @@ -3674,19 +4141,19 @@ "AdminPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
" } }, "RegistrantPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
" } }, "TechPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.

\n\t\t \n\t\t\t

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

\n\t\t
" } } }, @@ -3878,6 +4345,27 @@ "type": "structure", "members": {} }, + "com.amazonaws.route53domains#Value": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.route53domains#Values": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#Value" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.route53domains#ViewBilling": { "type": "operation", "input": { @@ -3892,7 +4380,13 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all the domain-related billing records for the current AWS account for a specified period

" + "smithy.api#documentation": "

Returns all the domain-related billing records for the current Amazon Web Services account for a specified period

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextPageMarker", + "items": "BillingRecords", + "pageSize": "MaxItems" + } } }, "com.amazonaws.route53domains#ViewBillingRequest": { @@ -3913,7 +4407,7 @@ "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "

For an initial request for a list of billing records, omit this element. If the number of billing records \n\t\t\tthat are associated with the current AWS account during the specified period is greater than the value that \n\t\t\tyou specified for MaxItems, you can use Marker to return additional billing records. \n\t\t\tGet the value of NextPageMarker from the previous response, and submit another request that includes \n\t\t\tthe value of NextPageMarker in the Marker element.\n\t\t

\n\t\t

Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.

" + "smithy.api#documentation": "

For an initial request for a list of billing records, omit this element. If the number of billing records \n\t\t\tthat are associated with the current Amazon Web Services account during the specified period is greater than the value that \n\t\t\tyou specified for MaxItems, you can use Marker to return additional billing records. \n\t\t\tGet the value of NextPageMarker from the previous response, and submit another request that includes \n\t\t\tthe value of NextPageMarker in the Marker element.\n\t\t

\n\t\t

Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.

" } }, "MaxItems": { diff --git a/aws/sdk/aws-models/s3.json b/aws/sdk/aws-models/s3.json index 0cf4f2945f..5c306b3a61 100644 --- a/aws/sdk/aws-models/s3.json +++ b/aws/sdk/aws-models/s3.json @@ -1877,7 +1877,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.

\n

Not every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.

\n

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

\n

By default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.

\n \n

If you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.

\n
\n

\n Access control lists (ACLs)\n

\n

When creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or\n groups that should be granted specific permissions on the bucket.

\n \n

If your CreateBucket request includes the BucketOwnerEnforced value for\n the x-amz-object-ownership header, your request can either not specify\n an ACL or specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent ACL expressed in the XML format. For\n more information, see Controlling object\n ownership in the Amazon S3 User Guide.

\n
\n

There are two ways to grant the appropriate permissions using the request headers.

\n
    \n
  • \n

    Specify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.

    \n
  • \n
  • \n

    Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an Amazon Web Services account

      \n
    • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
    • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
      • \n
      • \n

        US West (N. California)

        \n
      • \n
      • \n

        US West (Oregon)

        \n
      • \n
      • \n

        Asia Pacific (Singapore)

        \n
      • \n
      • \n

        Asia Pacific (Sydney)

        \n
      • \n
      • \n

        Asia Pacific (Tokyo)

        \n
      • \n
      • \n

        Europe (Ireland)

        \n
      • \n
      • \n

        South America (SΓ£o Paulo)

        \n
      • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n
      \n
    • \n
    \n

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

    \n
  • \n
\n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.

\n
\n\n

\n Permissions\n

\n

In addition to s3:CreateBucket, the following permissions are required when your CreateBucket includes specific headers:

\n
    \n
  • \n

    \n ACLs - If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, \n authenticated-read, or if you specify access permissions explicitly through any other ACL, both \n s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the \n CreateBucket request is private or doesn't specify any ACLs, only s3:CreateBucket permission is needed.

    \n
  • \n
  • \n

    \n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.

    \n
  • \n
  • \n

    \n S3 Object Ownership - If your CreateBucket\n request includes the the x-amz-object-ownership header,\n s3:PutBucketOwnershipControls permission is required.

    \n
  • \n
\n

The following operations are related to CreateBucket:

\n ", + "smithy.api#documentation": "

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.

\n

Not every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.

\n

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

\n

By default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.

\n \n

If you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.

\n
\n

\n Access control lists (ACLs)\n

\n

When creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or\n groups that should be granted specific permissions on the bucket.

\n \n

If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and\n specifies a bucket ACL that provides access to an external Amazon Web Services account, your request\n fails with a 400 error and returns the\n InvalidBucketAclWithObjectOwnership error code. For more information,\n see Controlling object\n ownership in the Amazon S3 User Guide.

\n
\n

There are two ways to grant the appropriate permissions using the request headers.

\n
    \n
  • \n

    Specify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.

    \n
  • \n
  • \n

    Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an Amazon Web Services account

      \n
    • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
    • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
      • \n
      • \n

        US West (N. California)

        \n
      • \n
      • \n

        US West (Oregon)

        \n
      • \n
      • \n

        Asia Pacific (Singapore)

        \n
      • \n
      • \n

        Asia Pacific (Sydney)

        \n
      • \n
      • \n

        Asia Pacific (Tokyo)

        \n
      • \n
      • \n

        Europe (Ireland)

        \n
      • \n
      • \n

        South America (SΓ£o Paulo)

        \n
      • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n
      \n
    • \n
    \n

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

    \n
  • \n
\n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.

\n
\n\n

\n Permissions\n

\n

In addition to s3:CreateBucket, the following permissions are required when your CreateBucket includes specific headers:

\n
    \n
  • \n

    \n ACLs - If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, \n authenticated-read, or if you specify access permissions explicitly through any other ACL, both \n s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the \n CreateBucket request is private or doesn't specify any ACLs, only s3:CreateBucket permission is needed.

    \n
  • \n
  • \n

    \n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.

    \n
  • \n
  • \n

    \n S3 Object Ownership - If your CreateBucket\n request includes the the x-amz-object-ownership header,\n s3:PutBucketOwnershipControls permission is required.

    \n
  • \n
\n

The following operations are related to CreateBucket:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}", @@ -6097,7 +6097,7 @@ "Range": { "target": "com.amazonaws.s3#Range", "traits": { - "smithy.api#documentation": "

Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

\n \n

Amazon S3 doesn't support retrieving multiple ranges of data per GET\n request.

\n
", + "smithy.api#documentation": "

Because HeadObject returns only the metadata for an object, this parameter\n has no effect.

", "smithy.api#httpHeader": "Range" } }, @@ -11952,7 +11952,7 @@ "target": "com.amazonaws.s3#SelectObjectContentOutput" }, "traits": { - "smithy.api#documentation": "

This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This action is not supported by Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select,\n see Selecting Content from\n Objects in the Amazon S3 User Guide.

\n

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon S3 User Guide.

\n

\n

\n Permissions\n

\n

You must have s3:GetObject permission for this operation.Β Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon S3 User Guide.

\n

\n

\n Object Data Formats\n

\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n
    \n
  • \n

    \n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.

    \n
  • \n
  • \n

    \n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.

    \n
  • \n
  • \n

    \n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.

    \n
  • \n
  • \n

    \n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.

    \n

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

    \n

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS),\n server-side encryption is handled transparently, so you don't need to specify\n anything. For more information about server-side encryption, including SSE-S3 and\n SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.

    \n
  • \n
\n\n

\n Working with the Response Body\n

\n

Given the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.

\n\n

\n

\n GetObject Support\n

\n

The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.

\n
    \n
  • \n

    \n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.

    \n
  • \n
  • \n

    GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage Classes\n in the Amazon S3 User Guide.

    \n
  • \n
\n

\n

\n Special Errors\n

\n\n

For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n

\n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This action is not supported by Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select,\n see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.

\n

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon S3 User Guide.

\n

\n

\n Permissions\n

\n

You must have s3:GetObject permission for this operation.Β Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon S3 User Guide.

\n

\n

\n Object Data Formats\n

\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n
    \n
  • \n

    \n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.

    \n
  • \n
  • \n

    \n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.

    \n
  • \n
  • \n

    \n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.

    \n
  • \n
  • \n

    \n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.

    \n

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

    \n

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS),\n server-side encryption is handled transparently, so you don't need to specify\n anything. For more information about server-side encryption, including SSE-S3 and\n SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.

    \n
  • \n
\n\n

\n Working with the Response Body\n

\n

Given the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.

\n\n

\n

\n GetObject Support\n

\n

The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.

\n
    \n
  • \n

    \n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.

    \n
  • \n
  • \n

    GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage Classes\n in the Amazon S3 User Guide.

    \n
  • \n
\n

\n

\n Special Errors\n

\n\n

For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n

\n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?select&select-type=2&x-id=SelectObjectContent", @@ -12167,12 +12167,12 @@ "KMSMasterKeyID": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.

\n

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you\n are using encryption with cross-account operations, you must use a fully qualified KMS key ARN.\n For more information, see Using encryption for cross-account operations.

\n

\n For example:\n

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
\n \n

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see\n Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

\n
" + "smithy.api#documentation": "

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.

\n

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if\n you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS\n key ARN. For more information, see Using encryption for cross-account operations.

\n

\n For example:\n

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
  • \n
\n \n

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see\n Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

\n
" } } }, "traits": { - "smithy.api#documentation": "

Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more information, see PUT Bucket encryption in\n the Amazon S3 API Reference.

" + "smithy.api#documentation": "

Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates \n an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with\n SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see PUT Bucket encryption in\n the Amazon S3 API Reference.

" } }, "com.amazonaws.s3#ServerSideEncryptionConfiguration": { diff --git a/aws/sdk/aws-models/s3control.json b/aws/sdk/aws-models/s3control.json index bce826ade4..177ff3b8a3 100644 --- a/aws/sdk/aws-models/s3control.json +++ b/aws/sdk/aws-models/s3control.json @@ -6186,7 +6186,7 @@ "target": "com.amazonaws.s3control#S3ExpirationInDays", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

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 ExpirationInDays set to 1\n or greater.

\n

Conversely, do not set ExpirationInDays 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 ExpirationInDays results in restore request failure.

\n

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 must create separate Batch Operations jobs.

" + "smithy.api#documentation": "

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 ExpirationInDays set to 1\n or greater.

\n

Conversely, do not set ExpirationInDays 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 ExpirationInDays results in restore request failure.

\n

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 must create separate Batch Operations jobs.

" } }, "GlacierJobTier": { diff --git a/aws/sdk/aws-models/sagemaker.json b/aws/sdk/aws-models/sagemaker.json index 97ebbc2737..5c323ace03 100644 --- a/aws/sdk/aws-models/sagemaker.json +++ b/aws/sdk/aws-models/sagemaker.json @@ -1899,6 +1899,12 @@ "smithy.api#documentation": "

The name of the target variable in supervised learning, usually represented by\n 'y'.

", "smithy.api#required": {} } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "

The content type of the data from the input source. You can use\n text/csv;header=present or x-application/vnd.amazon+parquet.\n The default value is text/csv;header=present.

" + } } }, "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": "

This member is deprecated and replaced with KmsKeyId.

" + "smithy.api#documentation": "

Use KmsKeyId.

" } }, "KmsKeyId": { @@ -6894,8 +6910,13 @@ "PipelineDefinition": { "target": "com.amazonaws.sagemaker#PipelineDefinition", "traits": { - "smithy.api#documentation": "

The JSON pipeline definition of the pipeline.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The JSON pipeline definition of the pipeline.

" + } + }, + "PipelineDefinitionS3Location": { + "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", + "traits": { + "smithy.api#documentation": "

The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.

" } }, "PipelineDescription": { @@ -6924,6 +6945,12 @@ "traits": { "smithy.api#documentation": "

A list of tags to apply to the created pipeline.

" } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

This is the configuration that controls the parallelism of the pipeline. \n If specified, it applies to all runs of this pipeline by default.

" + } } } }, @@ -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": "

This member is deprecated and replaced with KmsKeyId.

" + "smithy.api#documentation": "

Use KmsKeyId.

" } }, "SubnetIds": { @@ -13963,6 +13990,12 @@ }, "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

The parallelism configuration applied to the pipeline.

" + } } } }, @@ -14046,6 +14079,12 @@ }, "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

Lists the parallelism configuration applied to the pipeline.

" + } } } }, @@ -16110,6 +16149,38 @@ "smithy.api#documentation": "

Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.

" } }, + "com.amazonaws.sagemaker#EMRStepMetadata": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The identifier of the EMR cluster.

" + } + }, + "StepId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The identifier of the EMR cluster step.

" + } + }, + "StepName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "

The name of the EMR cluster step.

" + } + }, + "LogFilePath": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The path to the log file where the cluster step's failure root cause \n is recorded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configurations and outcomes of an Amazon EMR step execution.

" + } + }, "com.amazonaws.sagemaker#Edge": { "type": "structure", "members": { @@ -20061,7 +20132,7 @@ "FrameworkVersion": { "target": "com.amazonaws.sagemaker#FrameworkVersion", "traits": { - "smithy.api#documentation": "

Specifies the framework version to use.

\n

This API field is only supported for PyTorch framework versions 1.4, \n 1.5, and 1.6 for \n cloud instance target devices: ml_c4, ml_c5, ml_m4, \n ml_m5, ml_p2, ml_p3, and ml_g4dn.

" + "smithy.api#documentation": "

Specifies the framework version to use. This API field is only supported for the PyTorch and TensorFlow frameworks.

\n

For information about framework versions supported for cloud targets and edge devices, see \n Cloud Supported Instance Types and Frameworks and \n Edge Supported Frameworks.

" } } }, @@ -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": "

The max number of steps that can be executed in parallel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

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.

" + } + }, "com.amazonaws.sagemaker#Parameter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.sagemaker#PipelineParameterName", "traits": { - "smithy.api#documentation": "

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

", + "smithy.api#documentation": "

The name of the parameter to assign a value to. This \n parameter name must match a named parameter in the \n pipeline definition.

", "smithy.api#required": {} } }, @@ -30537,6 +30644,12 @@ "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext" }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

The parallelism configuration applied to the pipeline.

" + } + }, "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": "

Name of the S3 bucket.

", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.sagemaker#Key", + "traits": { + "smithy.api#documentation": "

The object key (or key name) uniquely identifies the \n object in an S3 bucket.

", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.sagemaker#VersionId", + "traits": { + "smithy.api#documentation": "

Version Id of the pipeline definition file. If not specified, Amazon SageMaker \n will retrieve the latest version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location of the pipeline definition stored in Amazon S3.

" + } + }, "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": "

The parallelism configuration applied to the pipeline execution.

" + } + }, "PipelineParameters": { "target": "com.amazonaws.sagemaker#ParameterList", "traits": { @@ -30725,6 +30872,18 @@ "smithy.api#documentation": "

The name of the step that is executed.

" } }, + "StepDisplayName": { + "target": "com.amazonaws.sagemaker#StepDisplayName", + "traits": { + "smithy.api#documentation": "

The display name of the step.

" + } + }, + "StepDescription": { + "target": "com.amazonaws.sagemaker#StepDescription", + "traits": { + "smithy.api#documentation": "

The description of the step.

" + } + }, "StartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { @@ -30749,6 +30908,12 @@ "smithy.api#documentation": "

If this pipeline execution step was cached, details on the cache hit.

" } }, + "AttemptCount": { + "target": "com.amazonaws.sagemaker#IntegerValue", + "traits": { + "smithy.api#documentation": "

The current attempt of the execution step. For more information, see Retry Policy for Amazon SageMaker Pipelines steps.

" + } + }, "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", "traits": { @@ -30846,6 +31011,12 @@ "traits": { "smithy.api#documentation": "

Container for the metadata for a Clarify check step. The configurations \n and outcomes of the check step execution. This includes:

\n
    \n
  • \n

    The type of the check conducted,

    \n
  • \n
  • \n

    The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.

    \n
  • \n
  • \n

    The Amazon S3 URIs of newly calculated baseline constraints and statistics.

    \n
  • \n
  • \n

    The model package group name provided.

    \n
  • \n
  • \n

    The Amazon S3 URI of the violation report if violations detected.

    \n
  • \n
  • \n

    The Amazon Resource Name (ARN) of check processing job initiated by the step execution.

    \n
  • \n
  • \n

    The boolean flags indicating if the drift check is skipped.

    \n
  • \n
  • \n

    If step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.

    \n
  • \n
" } + }, + "EMR": { + "target": "com.amazonaws.sagemaker#EMRStepMetadata", + "traits": { + "smithy.api#documentation": "

The configurations and outcomes of an EMR step execution.

" + } } }, "traits": { @@ -34324,6 +34495,12 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline.

" + } } } }, @@ -36427,6 +36604,12 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.

" + } } } }, @@ -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": "

Stops a pipeline execution.

\n\n

\n Callback Step\n

\n

A pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".

\n

You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.

\n

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

\n\n

\n Lambda Step\n

\n

A pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.

" + "smithy.api#documentation": "

Stops a pipeline execution.

\n\n

\n Callback Step\n

\n

A pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, 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\".

\n

You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.

\n

Only when Amazon SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

\n\n

\n Lambda Step\n

\n

A pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.

" } }, "com.amazonaws.sagemaker#StopPipelineExecutionRequest": { @@ -36804,7 +37007,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a transform job.

\n

When Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

" + "smithy.api#documentation": "

Stops a batch transform job.

\n

When Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

" } }, "com.amazonaws.sagemaker#StopTransformJobRequest": { @@ -36813,7 +37016,7 @@ "TransformJobName": { "target": "com.amazonaws.sagemaker#TransformJobName", "traits": { - "smithy.api#documentation": "

The name of the transform job to stop.

", + "smithy.api#documentation": "

The name of the batch transform job to stop.

", "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": "

The display name of the pipeline execution.

" } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.

" + } } } }, @@ -40896,6 +41141,12 @@ "smithy.api#documentation": "

The JSON pipeline definition.

" } }, + "PipelineDefinitionS3Location": { + "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", + "traits": { + "smithy.api#documentation": "

The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.

" + } + }, "PipelineDescription": { "target": "com.amazonaws.sagemaker#PipelineDescription", "traits": { @@ -40907,6 +41158,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that the pipeline uses to execute.

" } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "

If specified, it applies to all executions of this pipeline by default.

" + } } } }, @@ -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": { diff --git a/aws/sdk/aws-models/savingsplans.json b/aws/sdk/aws-models/savingsplans.json index 616add24fd..3ffaef2ae5 100644 --- a/aws/sdk/aws-models/savingsplans.json +++ b/aws/sdk/aws-models/savingsplans.json @@ -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": "

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 AWS Savings Plans User Guide.

", + "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": "

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 AWS Savings Plans User Guide.

", - "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": "

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.

", + "smithy.api#documentation": "

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.

", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/secretsmanager.json b/aws/sdk/aws-models/secretsmanager.json index 0172190a2c..db6095628e 100644 --- a/aws/sdk/aws-models/secretsmanager.json +++ b/aws/sdk/aws-models/secretsmanager.json @@ -75,7 +75,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables automatic scheduled rotation and cancels the rotation of a secret if currently in\n progress.

\n

To re-enable scheduled rotation, call RotateSecret with\n AutomaticallyRotateAfterDays set to a value greater than 0. This immediately\n rotates your secret and then enables the automatic schedule.

\n \n

If you cancel a rotation while in progress, it can leave the VersionStage\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label AWSPENDING from the partially created version, specified\n by the VersionId response value. You should also evaluate the partially rotated\n new version to see if it should be deleted, which you can do by removing all staging labels\n from the new version VersionStage field.

\n
\n

To successfully start a rotation, the staging label AWSPENDING must be in one of the\n following states:

\n
    \n
  • \n

    Not attached to any version at all

    \n
  • \n
  • \n

    Attached to the same version as the staging label AWSCURRENT\n

    \n
  • \n
\n

If the staging label AWSPENDING attached to a different version than the version with\n AWSCURRENT then the attempt to rotate fails.

\n\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:CancelRotateSecret

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.

    \n
  • \n
  • \n

    To get the rotation configuration details for a secret, use DescribeSecret.

    \n
  • \n
  • \n

    To list all of the currently available secrets, use ListSecrets.

    \n
  • \n
  • \n

    To list all of the versions currently associated with a secret, use ListSecretVersionIds.

    \n
  • \n
" + "smithy.api#documentation": "

Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.

\n

To turn on automatic rotation again, call RotateSecret.

\n \n

If you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label AWSPENDING from the partially created version, specified\n by the VersionId response value. We recommend you also evaluate the partially rotated\n new version to see if it should be deleted. You can delete a version by removing all staging labels\n from it.

\n
" } }, "com.amazonaws.secretsmanager#CancelRotateSecretRequest": { @@ -84,7 +84,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret to cancel a rotation request. You can specify either the Amazon\n Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } } @@ -96,19 +96,19 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The ARN of the secret for which rotation was canceled.

" + "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret for which rotation was canceled.

" + "smithy.api#documentation": "

The name of the secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

The unique identifier of the version of the secret created during the rotation. This\n version might not be complete, and should be evaluated for possible deletion. At the very\n least, you should remove the VersionStage value AWSPENDING to enable this\n version to be deleted. Failing to clean up a cancelled rotation can block you from\n successfully starting future rotations.

" + "smithy.api#documentation": "

The unique identifier of the version of the secret created during the rotation. This\n version might not be complete, and should be evaluated for possible deletion. We recommend \n that you remove the VersionStage value AWSPENDING from this version so that \n Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from\n starting future rotations.

" } } } @@ -160,7 +160,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.

\n

Secrets Manager stores the encrypted secret data in one of a collection of \"versions\"\n associated with the secret. Each version contains a copy of the encrypted secret data. Each\n version is associated with one or more \"staging labels\" that identify where the version is in\n the rotation cycle. The SecretVersionsToStages field of the secret contains the\n mapping of staging labels to the active versions of the secret. Versions without a staging\n label are considered deprecated and not included in the list.

\n

You provide the secret data to be encrypted by putting text in either the\n SecretString parameter or binary data in the SecretBinary\n parameter, but not both. If you include SecretString or SecretBinary\n then Secrets Manager also creates an initial secret version and automatically attaches the staging\n label AWSCURRENT to the new version.

\n \n
    \n
  • \n

    If you call an operation to encrypt or decrypt the SecretString \n or SecretBinary for a secret in the same account as the calling user and that \n secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default \n Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager. If this key \n doesn't already exist in your account then Secrets Manager creates it for you automatically. All\n users and roles in the same Amazon Web Services account automatically have access to use the default CMK. \n Note that if an Secrets Manager API call results in Amazon Web Services creating the account's \n Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the \n result.

    \n
  • \n
  • \n

    If the secret resides in a different Amazon Web Services account from the credentials calling an API that \n requires encryption or decryption of the secret value then you must create and use a custom \n Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials \n from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the \n secret or when you update it by including it in the KMSKeyId. If you call an \n API that must encrypt or decrypt SecretString or SecretBinary \n using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account\n access to that other account's user or role for both the kms:GenerateDataKey and \n kms:Decrypt operations.

    \n
  • \n
\n
\n

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:CreateSecret

    \n
  • \n
  • \n

    kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt\n the secret. You do not need this permission to use the account default Amazon Web Services managed CMK\n for Secrets Manager.

    \n
  • \n
  • \n

    kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the\n secret. You do not need this permission to use the account default Amazon Web Services managed CMK for\n Secrets Manager.

    \n
  • \n
  • \n

    secretsmanager:TagResource - needed only if you include the Tags\n parameter.

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To delete a secret, use DeleteSecret.

    \n
  • \n
  • \n

    To modify an existing secret, use UpdateSecret.

    \n
  • \n
  • \n

    To create a new version of a secret, use PutSecretValue.

    \n
  • \n
  • \n

    To retrieve the encrypted secure string and secure binary values, use GetSecretValue.

    \n
  • \n
  • \n

    To retrieve all other details for a secret, use DescribeSecret. This\n does not include the encrypted secure string and secure binary values.

    \n
  • \n
  • \n

    To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response\n value.

    \n
  • \n
" + "smithy.api#documentation": "

Creates a new secret. A secret is a set of credentials, such as a \n user name and password, that you store in an encrypted form in Secrets Manager. The secret also \n includes the connection information to access a database or other service, which Secrets Manager \n doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.

\n

For information about creating a secret in the console, see Create a secret.

\n

To create a secret, you can provide the secret value to be encrypted in either the\n SecretString parameter or the SecretBinary parameter, but not both. \n If you include SecretString or SecretBinary\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label AWSCURRENT to it.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key \n doesn't already exist in your account, then Secrets Manager creates it for you automatically. All\n users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. \n Creating aws/secretsmanager can result in a one-time significant delay in returning the \n result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.

" } }, "com.amazonaws.secretsmanager#CreateSecretRequest": { @@ -169,57 +169,57 @@ "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { - "smithy.api#documentation": "

Specifies the friendly name of the new secret.

\n

The secret name must be ASCII letters, digits, or the following characters :\n /_+=.@-

\n \n

Do not end your secret name with a hyphen followed by six characters. If you do so, you\n risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager\n automatically adds a hyphen and six random characters at the end of the ARN.

\n
", + "smithy.api#documentation": "

The name of the new secret.

\n

The secret name can contain ASCII letters, numbers, and the following characters:\n /_+=.@-

\n \n

Do not end your secret name with a hyphen followed by six characters. If you do so, you\n risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager\n automatically adds a hyphen and six random characters after the secret name at the end of the ARN.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { - "smithy.api#documentation": "

(Optional) If you include SecretString or SecretBinary, then an\n initial version is created as part of the secret, and this parameter specifies a unique\n identifier for the new version.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it\n as the value for this parameter in the request. If you don't use the SDK and instead\n generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for the new version and include the value in the\n request.

\n
\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during a rotation. We\n recommend that you generate a UUID-type value to\n ensure uniqueness of your versions within the specified secret.

\n
    \n
  • \n

    If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

    \n
  • \n
  • \n

    If a version with this value already exists and the version SecretString\n and SecretBinary values are the same as those in the request, then the\n request is ignored.

    \n
  • \n
  • \n

    If a version with this value already exists and that version's\n SecretString and SecretBinary values are different from those\n in the request, then the request fails because you cannot modify an existing version.\n Instead, use PutSecretValue to create a new version.

    \n
  • \n
\n

This value becomes the VersionId of the new version.

", + "smithy.api#documentation": "

If you include SecretString or SecretBinary, then \n Secrets Manager creates an initial version for the secret, and this parameter specifies the unique\n identifier for the new version.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it\n as the value for this parameter in the request. If you don't use the SDK and instead\n generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for the new version and include the value in the\n request.

\n
\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during a rotation. We\n recommend that you generate a UUID-type value to\n ensure uniqueness of your versions within the specified secret.

\n
    \n
  • \n

    If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

    \n
  • \n
  • \n

    If a version with this value already exists and the version SecretString\n and SecretBinary values are the same as those in the request, then the\n request is ignored.

    \n
  • \n
  • \n

    If a version with this value already exists and that version's\n SecretString and SecretBinary values are different from those\n in the request, then the request fails because you cannot modify an existing version.\n Instead, use PutSecretValue to create a new version.

    \n
  • \n
\n

This value becomes the VersionId of the new version.

", "smithy.api#idempotencyToken": {} } }, "Description": { "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies a user-provided description of the secret.

" + "smithy.api#documentation": "

The description of the secret.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to\n be used to encrypt the SecretString or SecretBinary values in the\n versions stored in this secret.

\n

You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to\n reference a CMK in a different account, you can use only the key ARN or the alias ARN.

\n

If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's\n default CMK (the one named aws/secretsmanager). If a Amazon Web Services KMS CMK with that name doesn't yet\n exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a\n version's SecretString or SecretBinary fields.

\n \n

You can use the account default CMK to encrypt and decrypt only if you call this\n operation using credentials from the same account that owns the secret. If the secret\n resides in a different account, then you must create a custom CMK and specify the ARN in\n this field.

\n
" + "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to\n encrypt the secret value in the secret.

\n

To use a KMS key in a different account, use the key ARN or the alias ARN.

\n

If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. \n If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it \n encrypts the secret value.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.

" } }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies binary data that you want to encrypt and store in the new version of\n the secret. To use this parameter in the command-line tools, we recommend that you store your\n binary data in a file and then use the appropriate technique for your tool to pass the\n contents of the file as a parameter.

\n

Either SecretString or SecretBinary must have a value, but not\n both. They cannot both be empty.

\n

This parameter is not available using the Secrets Manager console. It can be accessed only by\n using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.

" + "smithy.api#documentation": "

The binary data to encrypt and store in the new version of\n the secret. We recommend that you store your binary data in a file and then pass the\n contents of the file as a parameter.

\n

Either SecretString or SecretBinary must have a value, but not\n both.

\n

This parameter is not available in the Secrets Manager console.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies text data that you want to encrypt and store in this new version of\n the secret.

\n

Either SecretString or SecretBinary must have a value, but not\n both. They cannot both be empty.

\n

If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected\n secret text in only the SecretString parameter. The Secrets Manager console stores the\n information as a JSON structure of key/value pairs that the Lambda rotation function knows how\n to parse.

\n

For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

" + "smithy.api#documentation": "

The text data to encrypt and store in this new version of\n the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

\n

Either SecretString or SecretBinary must have a value, but not\n both.

\n

If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected\n secret text in only the SecretString parameter. The Secrets Manager console stores the\n information as a JSON structure of key/value pairs that a Lambda rotation function can parse.

" } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag\n is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list\n of tags. To remove tags, you must use UntagResource.

\n \n
    \n
  • \n

    Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag\n from one with key \"abc\".

    \n
  • \n
  • \n

    If you check tags in IAM policy Condition elements as part of your\n security strategy, then adding or removing a tag can change permissions. If the\n successful completion of this operation would result in you losing your permissions for\n this secret, then this operation is blocked and returns an Access Denied\n error.

    \n
  • \n
\n
\n

This parameter requires a JSON text string argument. For information on how to format a\n JSON parameter for the various command line tool environments, see Using JSON for\n Parameters in the CLI User Guide. For example:

\n

\n [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]\n

\n

If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per secretβ€”50

    \n
  • \n
  • \n

    Maximum key lengthβ€”127 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Maximum value lengthβ€”255 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.

    \n
  • \n
  • \n

    If you use your tagging schema across multiple services and resources,\n remember other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.

    \n
  • \n
" + "smithy.api#documentation": "

A list of tags to attach to the secret. Each tag\n is a key and value pair of strings in a JSON text string, for example:

\n

\n [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]\n

\n

Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag\n from one with key \"abc\".

\n

If you check tags in permissions policies as part of your\n security strategy, then adding or removing a tag can change permissions. If the\n completion of this operation would result in you losing your permissions for\n this secret, then Secrets Manager blocks the operation and returns an Access Denied\n error. For more information, see Control \n access to secrets using tags and Limit access to identities with tags that match secrets' tags.

\n

For information about how to format a\n JSON parameter for the various command line tool environments, see Using JSON for\n Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.

\n

The following restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per secret: 50

    \n
  • \n
  • \n

    Maximum key length: 127 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Maximum value length: 255 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.

    \n
  • \n
  • \n

    If you use your tagging schema across multiple services and resources,\n other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.

    \n
  • \n
" } }, "AddReplicaRegions": { "target": "com.amazonaws.secretsmanager#AddReplicaRegionListType", "traits": { - "smithy.api#documentation": "

(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in\n the parameter.

" + "smithy.api#documentation": "

A list of Regions and KMS keys to replicate secrets.

" } }, "ForceOverwriteReplicaSecret": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { - "smithy.api#documentation": "

(Optional) If set, the replication overwrites a secret with the same name in the\n destination region.

" + "smithy.api#documentation": "

Specifies whether to overwrite a secret with the same name in the\n destination Region.

" } } } @@ -230,25 +230,25 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret that you just created.

\n \n

Secrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.

\n
" + "smithy.api#documentation": "

The ARN of the new secret. The ARN includes the name of the secret followed by six random \n characters. This ensures that if you create a new secret with the same name as a deleted secret, \n then users with access to the old secret don't get access to the new secret because the ARNs \n are different.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret that you just created.

" + "smithy.api#documentation": "

The name of the new secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

The unique identifier associated with the version of the secret you just created.

" + "smithy.api#documentation": "

The unique identifier associated with the version of the new secret.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { - "smithy.api#documentation": "

Describes a list of replication status objects as InProgress, Failed or InSync.

" + "smithy.api#documentation": "

A list of the replicas of this secret and their status:

\n
    \n
  • \n

    \n Failed, which indicates that the replica was not created.

    \n
  • \n
  • \n

    \n InProgress, which indicates that Secrets Manager is in the process of creating the replica.

    \n
  • \n
  • \n

    \n InSync, which indicates that the replica was created.

    \n
  • \n
" } } } @@ -291,7 +291,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the resource-based permission policy attached to the secret.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:DeleteResourcePolicy

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To attach a resource policy to a secret, use PutResourcePolicy.

    \n
  • \n
  • \n

    To retrieve the current resource-based policy attached to a secret, use GetResourcePolicy.

    \n
  • \n
  • \n

    To list all of the currently available secrets, use ListSecrets.

    \n
  • \n
" + "smithy.api#documentation": "

Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use PutResourcePolicy.

" } }, "com.amazonaws.secretsmanager#DeleteResourcePolicyRequest": { @@ -300,7 +300,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret that you want to delete the attached resource-based policy for. You\n can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to delete the attached resource-based policy for.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } } @@ -318,7 +318,7 @@ "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret that the resource-based policy was deleted for.

" + "smithy.api#documentation": "

The name of the secret that the resource-based policy was deleted for.

" } } } @@ -346,7 +346,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an entire secret and all of the versions. You can optionally include a recovery\n window during which you can restore the secret. If you don't specify a recovery window value,\n the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.

\n

At any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.

\n

You cannot access the encrypted secret information in any secret scheduled for deletion.\n If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.

\n \n
    \n
  • \n

    There is no explicit operation to delete a version of a secret. Instead, remove all\n staging labels from the VersionStage field of a version. That marks the\n version as deprecated and allows Secrets Manager to delete it as needed. Versions without any\n staging labels do not show up in ListSecretVersionIds unless you\n specify IncludeDeprecated.

    \n
  • \n
  • \n

    The permanent secret deletion at the end of the waiting period is performed as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the actual delete operation to occur.

    \n
  • \n
\n
\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:DeleteSecret

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To create a secret, use CreateSecret.

    \n
  • \n
  • \n

    To cancel deletion of a version of a secret before the recovery window has expired,\n use RestoreSecret.

    \n
  • \n
" + "smithy.api#documentation": "

Deletes a secret and all of its versions. You can specify a recovery\n window during which you can restore the secret. The minimum recovery window is 7 days. \n The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.

\n

For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.

\n

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.

\n

At any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.

\n

In a secret scheduled for deletion, you cannot access the encrypted secret value.\n To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.

" } }, "com.amazonaws.secretsmanager#DeleteSecretRequest": { @@ -355,7 +355,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or\n the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to delete.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, @@ -363,14 +363,14 @@ "target": "com.amazonaws.secretsmanager#RecoveryWindowInDaysType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the\n secret. You can't use both this parameter and the ForceDeleteWithoutRecovery\n parameter in the same API call.

\n

This value can range from 7 to 30 days with a default value of 30.

" + "smithy.api#documentation": "

The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the\n secret. You can't use both this parameter and ForceDeleteWithoutRecovery\n in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.

" } }, "ForceDeleteWithoutRecovery": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

(Optional) Specifies that the secret is to be deleted without any recovery window. You\n can't use both this parameter and the RecoveryWindowInDays parameter in the same\n API call.

\n

An asynchronous background process performs the actual deletion, so there can be a short\n delay before the operation completes. If you write code to delete and then immediately\n recreate a secret with the same name, ensure that your code includes appropriate back off and\n retry logic.

\n \n

Use this parameter with caution. This parameter causes the operation to skip the normal\n waiting period before the permanent deletion that Amazon Web Services would normally impose with the\n RecoveryWindowInDays parameter. If you delete a secret with the\n ForceDeleteWithouRecovery parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.

\n
\n \n

If you use this parameter and include a previously deleted or nonexistent secret, the\n operation does not return the error ResourceNotFoundException in order to\n correctly handle retries.

\n
" + "smithy.api#documentation": "

Specifies whether to delete the secret without any recovery window. You\n can't use both this parameter and RecoveryWindowInDays in the same\n call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.

\n

Secrets Manager performs the actual deletion with an asynchronous background process, so there might \n be a short delay before the secret is permanently deleted. If you delete a secret and then \n immediately create a secret with the same name, use appropriate back off and retry logic.

\n \n

Use this parameter with caution. This parameter causes the operation to skip the normal\n recovery window before the permanent deletion that Secrets Manager would normally impose with the\n RecoveryWindowInDays parameter. If you delete a secret with the\n ForceDeleteWithouRecovery parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.

\n
" } } } @@ -381,19 +381,19 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The ARN of the secret that is now scheduled for deletion.

" + "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret currently scheduled for deletion.

" + "smithy.api#documentation": "

The name of the secret.

" } }, "DeletionDate": { "target": "com.amazonaws.secretsmanager#DeletionDateType", "traits": { - "smithy.api#documentation": "

The date and time after which this secret can be deleted by Secrets Manager and can no longer be\n restored. This value is the date and time of the delete request plus the number of days\n specified in RecoveryWindowInDays.

" + "smithy.api#documentation": "

The date and time after which this secret Secrets Manager can permanently delete this secret, \n and it can no longer be restored. This value is the date and time of the delete request \n plus the number of days in RecoveryWindowInDays.

" } } } @@ -424,7 +424,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details of a secret. It does not include the encrypted fields. Secrets\n Manager only returns fields populated with a value in the response.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:DescribeSecret

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To create a secret, use CreateSecret.

    \n
  • \n
  • \n

    To modify a secret, use UpdateSecret.

    \n
  • \n
  • \n

    To retrieve the encrypted secret information in a version of the secret, use GetSecretValue.

    \n
  • \n
  • \n

    To list all of the secrets in the Amazon Web Services account, use ListSecrets.

    \n
  • \n
" + "smithy.api#documentation": "

Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response.

" } }, "com.amazonaws.secretsmanager#DescribeSecretRequest": { @@ -433,7 +433,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The identifier of the secret whose details you want to retrieve. You can specify either\n the Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } } @@ -451,44 +451,44 @@ "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The user-provided friendly name of the secret.

" + "smithy.api#documentation": "

The name of the secret.

" } }, "Description": { "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { - "smithy.api#documentation": "

The user-provided description of the secret.

" + "smithy.api#documentation": "

The description of the secret.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the\n SecretString or SecretBinary fields in each version of the secret.\n If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the\n default Amazon Web Services KMS CMK (the one named awssecretsmanager) for this account.

" + "smithy.api#documentation": "

The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with \n the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

" } }, "RotationEnabled": { "target": "com.amazonaws.secretsmanager#RotationEnabledType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies whether automatic rotation is enabled for this secret.

\n

To enable rotation, use RotateSecret with\n AutomaticallyRotateAfterDays set to a value greater than 0. To disable\n rotation, use CancelRotateSecret.

" + "smithy.api#documentation": "

Specifies whether automatic rotation is turned on for this secret.

\n

To turn on rotation, use RotateSecret. To turn off\n rotation, use CancelRotateSecret.

" } }, "RotationLambdaARN": { "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { - "smithy.api#documentation": "

The ARN of a Lambda function that's invoked by Secrets Manager to rotate the\n secret either automatically per the schedule or manually by a call to\n RotateSecret.

" + "smithy.api#documentation": "

The ARN of the Lambda function that Secrets Manager invokes to rotate the\n secret.

" } }, "RotationRules": { "target": "com.amazonaws.secretsmanager#RotationRulesType", "traits": { - "smithy.api#documentation": "

A structure with the rotation configuration for this secret. This field is only populated \n if rotation is configured.

" + "smithy.api#documentation": "

The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but \n it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had \n rotation turned on, this field is omitted.

" } }, "LastRotatedDate": { "target": "com.amazonaws.secretsmanager#LastRotatedDateType", "traits": { - "smithy.api#documentation": "

The last date and time that the rotation process for this secret was invoked.

\n

The most recent date and time that the Secrets Manager rotation process successfully\n completed. If the secret doesn't rotate, Secrets Manager returns a null value.

" + "smithy.api#documentation": "

The last date and time that Secrets Manager rotated the secret. \n If the secret isn't configured for rotation, Secrets Manager returns null.

" } }, "LastChangedDate": { @@ -500,49 +500,49 @@ "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { - "smithy.api#documentation": "

The last date that this secret was accessed. This value is truncated to midnight of the\n date and therefore shows only the date, not the time.

" + "smithy.api#documentation": "

The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.

" } }, "DeletedDate": { "target": "com.amazonaws.secretsmanager#DeletedDateType", "traits": { - "smithy.api#documentation": "

This value exists if the secret is scheduled for deletion. Some time after the specified\n date and time, Secrets Manager deletes the secret and all of its versions.

\n

If a secret is scheduled for deletion, then its details, including the encrypted secret\n information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.

" + "smithy.api#documentation": "

The date the secret is scheduled for deletion. If it is not scheduled for deletion, this \n field is omitted. When you delete a secret, Secrets Manager requires a \n recovery window of at least 7 days before deleting the secret. Some time after the deleted date, \n Secrets Manager deletes the secret, including all of its versions.

\n

If a secret is scheduled for deletion, then its details, including the encrypted secret\n value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.

" } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { - "smithy.api#documentation": "

The list of user-defined tags that are associated with the secret. To add tags to a\n secret, use TagResource. To remove tags, use UntagResource.

" + "smithy.api#documentation": "

The list of tags attached to the secret. To add tags to a\n secret, use TagResource. To remove tags, use UntagResource.

" } }, "VersionIdsToStages": { "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", "traits": { - "smithy.api#documentation": "

A list of all of the currently assigned VersionStage staging labels and the\n VersionId that each is attached to. Staging labels are used to keep track of\n the different versions during the rotation process.

\n \n

A version that does not have any staging labels attached is considered deprecated and\n subject to deletion. Such versions are not included in this list.

\n
" + "smithy.api#documentation": "

A list of the versions of the secret that have staging labels attached.\n Versions that don't have staging labels are considered deprecated and Secrets Manager \n can delete them.

\n

Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three \n staging labels for rotation are:

\n
    \n
  • \n

    \n AWSCURRENT, which indicates the current version of the secret.

    \n
  • \n
  • \n

    \n AWSPENDING, which indicates the version of the secret that contains new \n secret information that will become the next current version when rotation finishes.

    \n

    During \n rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. \n To check if a secret version exists, call GetSecretValue.

    \n
  • \n
  • \n

    \n AWSPREVIOUS, which indicates the previous current version of the secret. \n You can use this as the last known good version.

    \n
  • \n
\n

For more information about rotation and staging labels, see How rotation works.

" } }, "OwningService": { "target": "com.amazonaws.secretsmanager#OwningServiceType", "traits": { - "smithy.api#documentation": "

Returns the name of the service that created this secret.

" + "smithy.api#documentation": "

The name of the service that created this secret.

" } }, "CreatedDate": { "target": "com.amazonaws.secretsmanager#TimestampType", "traits": { - "smithy.api#documentation": "

The date you created the secret.

" + "smithy.api#documentation": "

The date the secret was created.

" } }, "PrimaryRegion": { "target": "com.amazonaws.secretsmanager#RegionType", "traits": { - "smithy.api#documentation": "

Specifies the primary region for secret replication.

" + "smithy.api#documentation": "

The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { - "smithy.api#documentation": "

Describes a list of replication status objects as InProgress, Failed or InSync.P\n

" + "smithy.api#documentation": "

A list of the replicas of this secret and their status:

\n
    \n
  • \n

    \n Failed, which indicates that the replica was not created.

    \n
  • \n
  • \n

    \n InProgress, which indicates that Secrets Manager is in the process of creating the replica.

    \n
  • \n
  • \n

    \n InSync, which indicates that the replica was created.

    \n
  • \n
" } } } @@ -564,7 +564,7 @@ } }, "traits": { - "smithy.api#documentation": "

Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the\n customer master key (CMK) is available, enabled, and not in an invalid state. For more\n information, see How Key State Affects Use of a\n Customer Master Key.

", + "smithy.api#documentation": "

Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the\n KMS key is available, enabled, and not in an invalid state. For more\n information, see Key state: Effect on your KMS key.

", "smithy.api#error": "client" } }, @@ -598,18 +598,18 @@ "Key": { "target": "com.amazonaws.secretsmanager#FilterNameStringType", "traits": { - "smithy.api#documentation": "

Filters your list of secrets by a specific key.

" + "smithy.api#documentation": "

The following are keys you can use:

\n
    \n
  • \n

    \n description: Prefix match, not case-sensitive.

    \n
  • \n
  • \n

    \n name: Prefix match, case-sensitive.

    \n
  • \n
  • \n

    \n tag-key: Prefix match, case-sensitive.

    \n
  • \n
  • \n

    \n tag-value: Prefix match, case-sensitive.

    \n
  • \n
  • \n

    \n primary-region: Prefix match, case-sensitive.

    \n
  • \n
  • \n

    \n all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.

    \n
  • \n
" } }, "Values": { "target": "com.amazonaws.secretsmanager#FilterValuesStringList", "traits": { - "smithy.api#documentation": "

Filters your list of secrets by a specific value.

\n

You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

" + "smithy.api#documentation": "

The keyword to filter for.

\n

You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

" } } }, "traits": { - "smithy.api#documentation": "

Allows you to add filters when you use the search function in Secrets Manager.

" + "smithy.api#documentation": "

Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#FilterNameStringType": { @@ -697,7 +697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a random password of the specified complexity. This operation is intended for\n use in the Lambda rotation function. Per best practice, we recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:GetRandomPassword

    \n
  • \n
" + "smithy.api#documentation": "

Generates a random password. We recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support.

" } }, "com.amazonaws.secretsmanager#GetRandomPasswordRequest": { @@ -707,55 +707,55 @@ "target": "com.amazonaws.secretsmanager#PasswordLengthType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The desired length of the generated password. The default value if you do not include this\n parameter is 32 characters.

" + "smithy.api#documentation": "

The length of the password. If you don't include this parameter, the \n default length is 32 characters.

" } }, "ExcludeCharacters": { "target": "com.amazonaws.secretsmanager#ExcludeCharactersType", "traits": { - "smithy.api#documentation": "

A string that includes characters that should not be included in the generated password.\n The default is that all characters from the included sets can be used.

" + "smithy.api#documentation": "

A string of the characters that you don't want in the password.

" } }, "ExcludeNumbers": { "target": "com.amazonaws.secretsmanager#ExcludeNumbersType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies that the generated password should not include digits. The default if you do not\n include this switch parameter is that digits can be included.

" + "smithy.api#documentation": "

Specifies whether to exclude numbers from the password. If you don't \n include this switch, the password can contain numbers.

" } }, "ExcludePunctuation": { "target": "com.amazonaws.secretsmanager#ExcludePunctuationType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies that the generated password should not include punctuation characters. The\n default if you do not include this switch parameter is that punctuation characters can be\n included.

\n

The following are the punctuation characters that can be included in\n the generated password if you don't explicitly exclude them with\n ExcludeCharacters or ExcludePunctuation:

\n

\n ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | }\n ~\n

" + "smithy.api#documentation": "

Specifies whether to exclude the following punctuation characters from the password: \n ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~. \n If you don't include this switch, the password can contain punctuation.

" } }, "ExcludeUppercase": { "target": "com.amazonaws.secretsmanager#ExcludeUppercaseType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies that the generated password should not include uppercase letters. The default if\n you do not include this switch parameter is that uppercase letters can be included.

" + "smithy.api#documentation": "

Specifies whether to exclude uppercase letters from the password. If you \n don't include this switch, the password can contain uppercase letters.

" } }, "ExcludeLowercase": { "target": "com.amazonaws.secretsmanager#ExcludeLowercaseType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies that the generated password should not include lowercase letters. The default if\n you do not include this switch parameter is that lowercase letters can be included.

" + "smithy.api#documentation": "

Specifies whether to exclude lowercase letters from the password. If\n you don't include this switch, the password can contain lowercase letters.

" } }, "IncludeSpace": { "target": "com.amazonaws.secretsmanager#IncludeSpaceType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies that the generated password can include the space character. The default if you\n do not include this switch parameter is that the space character is not included.

" + "smithy.api#documentation": "

Specifies whether to include the space character. If you \n include this switch, the password can contain space characters.

" } }, "RequireEachIncludedType": { "target": "com.amazonaws.secretsmanager#RequireEachIncludedTypeType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

A boolean value that specifies whether the generated password must include at least one of\n every allowed character type. The default value is True and the operation\n requires at least one of every character type.

" + "smithy.api#documentation": "

Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. \n If you don't include this switch, the password contains at least one of every character type.

" } } } @@ -766,7 +766,7 @@ "RandomPassword": { "target": "com.amazonaws.secretsmanager#RandomPasswordType", "traits": { - "smithy.api#documentation": "

A string with the generated password.

" + "smithy.api#documentation": "

A string with the password.

" } } } @@ -794,7 +794,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the JSON text of the resource-based policy document attached to the specified\n secret. The JSON request string input and response output displays formatted code\n with white space and line breaks for better readability. Submit your input as a single line \n JSON string.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:GetResourcePolicy

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To attach a resource policy to a secret, use PutResourcePolicy.

    \n
  • \n
  • \n

    To delete the resource-based policy attached to a secret, use DeleteResourcePolicy.

    \n
  • \n
  • \n

    To list all of the currently available secrets, use ListSecrets.

    \n
  • \n
" + "smithy.api#documentation": "

Retrieves the JSON text of the resource-based policy document attached to the\n secret. For more information about permissions policies attached to a secret, see \n Permissions \n policies attached to a secret.

" } }, "com.amazonaws.secretsmanager#GetResourcePolicyRequest": { @@ -803,7 +803,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret that you want to retrieve the attached resource-based policy for. You\n can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to retrieve the attached resource-based policy for.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } } @@ -821,13 +821,13 @@ "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret that the resource-based policy was retrieved for.

" + "smithy.api#documentation": "

The name of the secret that the resource-based policy was retrieved for.

" } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { - "smithy.api#documentation": "

A JSON-formatted string that describes the permissions that are associated with the\n attached secret. These permissions are combined with any permissions that are associated with\n the user or role that attempts to access this secret. The combined permissions specify who can\n access the secret and what actions they can perform. For more information, see Authentication and Access Control for\n Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.

" + "smithy.api#documentation": "

A JSON-formatted string that contains the permissions policy \n attached to the secret. For more information about permissions policies, see Authentication and access control for\n Secrets Manager.

" } } } @@ -858,7 +858,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:GetSecretValue

    \n
  • \n
  • \n

    kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the\n secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for\n Secrets Manager.

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To create a new version of the secret with different encrypted information, use PutSecretValue.

    \n
  • \n
  • \n

    To retrieve the non-encrypted details for the secret, use DescribeSecret.

    \n
  • \n
" + "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.

\n

For information about retrieving the secret value in the console, see Retrieve secrets.

\n

To run this command, you must have secretsmanager:GetSecretValue permissions. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n aws/secretsmanager, then you also need kms:Decrypt permissions for that key.

" } }, "com.amazonaws.secretsmanager#GetSecretValueRequest": { @@ -867,20 +867,20 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret containing the version that you want to retrieve. You can specify\n either the Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to retrieve.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

Specifies the unique identifier of the version of the secret that you want to retrieve. If\n you specify both this parameter and VersionStage, the two parameters must refer\n to the same secret version. If you don't specify either a VersionStage or\n VersionId then the default is to perform the operation on the version with the\n VersionStage value of AWSCURRENT.

\n

This value is typically a UUID-type value with\n 32 hexadecimal digits.

" + "smithy.api#documentation": "

The unique identifier of the version of the secret to retrieve. If\n you include both this parameter and VersionStage, the two parameters must refer\n to the same secret version. If you don't specify either a VersionStage or\n VersionId, then Secrets Manager returns the AWSCURRENT version.

\n

This value is typically a UUID-type value with\n 32 hexadecimal digits.

" } }, "VersionStage": { "target": "com.amazonaws.secretsmanager#SecretVersionStageType", "traits": { - "smithy.api#documentation": "

Specifies the secret version that you want to retrieve by the staging label attached to\n the version.

\n

Staging labels are used to keep track of different versions during the rotation process.\n If you specify both this parameter and VersionId, the two parameters must refer\n to the same secret version . If you don't specify either a VersionStage or\n VersionId, then the default is to perform the operation on the version with the\n VersionStage value of AWSCURRENT.

" + "smithy.api#documentation": "

The staging label of the version of the secret to retrieve.

\n

Secrets Manager uses staging labels to keep track of different versions during the rotation process.\n If you include both this parameter and VersionId, the two parameters must refer\n to the same secret version. If you don't specify either a VersionStage or\n VersionId, Secrets Manager returns the AWSCURRENT version.

" } } } @@ -909,13 +909,13 @@ "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { - "smithy.api#documentation": "

The decrypted part of the protected secret information that was originally provided as\n binary data in the form of a byte array. The response parameter represents the binary data as\n a base64-encoded\n string.

\n

This parameter is not used if the secret is created by the Secrets Manager console.

\n

If you store custom information in this field of the secret, then you must code your\n Lambda rotation function to parse and interpret whatever you store in the\n SecretString or SecretBinary fields.

" + "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as\n binary data in the form of a byte array. The response parameter represents the binary data as\n a base64-encoded\n string.

\n

If the secret was created by using the Secrets Manager console, or if the secret value was \n originally provided as a string, then this field is omitted. The secret value appears in \n SecretString instead.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { - "smithy.api#documentation": "

The decrypted part of the protected secret information that was originally provided as a\n string.

\n

If you create this secret by using the Secrets Manager console then only the\n SecretString parameter contains data. Secrets Manager stores the information as a\n JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

\n

If you store custom information in the secret by using the CreateSecret,\n UpdateSecret, or PutSecretValue API operations instead\n of the Secrets Manager console, or by using the Other secret type in\n the console, then you must code your Lambda rotation function to parse and interpret those\n values.

" + "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as a string or \n through the Secrets Manager console.

\n

If this secret was created by using the console, then Secrets Manager stores the information as a\n JSON structure of key/value pairs.

" } }, "VersionStages": { @@ -927,7 +927,7 @@ "CreatedDate": { "target": "com.amazonaws.secretsmanager#CreatedDateType", "traits": { - "smithy.api#documentation": "

The date and time that this version of the secret was created.

" + "smithy.api#documentation": "

The date and time that this version of the secret was created. If you don't specify \n which version in VersionId or VersionStage, then Secrets Manager uses the \n AWSCURRENT version.

" } } } @@ -955,7 +955,7 @@ } }, "traits": { - "smithy.api#documentation": "

You provided an invalid NextToken value.

", + "smithy.api#documentation": "

The NextToken value is invalid.

", "smithy.api#error": "client" } }, @@ -967,7 +967,7 @@ } }, "traits": { - "smithy.api#documentation": "

You provided an invalid value for a parameter.

", + "smithy.api#documentation": "

The parameter name is invalid value.

", "smithy.api#error": "client" } }, @@ -979,7 +979,7 @@ } }, "traits": { - "smithy.api#documentation": "

You provided a parameter value that is not valid for the current state of the\n resource.

\n

Possible causes:

\n
    \n
  • \n

    You tried to perform the operation on a secret that's currently marked deleted.

    \n
  • \n
  • \n

    You tried to enable rotation on a secret that doesn't already have a Lambda function\n ARN configured and you didn't include such an ARN as a parameter in this call.

    \n
  • \n
", + "smithy.api#documentation": "

A parameter value is not valid for the current state of the\n resource.

\n

Possible causes:

\n
    \n
  • \n

    The secret is scheduled for deletion.

    \n
  • \n
  • \n

    You tried to enable rotation on a secret that doesn't already have a Lambda function\n ARN configured and you didn't include such an ARN as a parameter in this call.

    \n
  • \n
", "smithy.api#error": "client" } }, @@ -1015,7 +1015,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request failed because it would exceed one of the Secrets Manager internal limits.

", + "smithy.api#documentation": "

The request failed because it would exceed one of the Secrets Manager quotas.

", "smithy.api#error": "client" } }, @@ -1042,7 +1042,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all of the versions attached to the specified secret. The output does not include\n the SecretString or SecretBinary fields. By default, the list\n includes only versions that have at least one staging label in VersionStage\n attached.

\n \n

Always check the NextToken response parameter \n when calling any of the List* operations. These operations can occasionally return \n an empty or shorter than expected list of results even when there more results become available. \n When this happens, the NextToken response parameter contains a value to pass to the \n next call to the same API to request the next part of the list.

\n
\n

\n Minimum\n permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:ListSecretVersionIds

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To list the secrets in an account, use ListSecrets.

    \n
  • \n
", + "smithy.api#documentation": "

Lists the versions for a secret.

\n

To list the secrets in the account, use ListSecrets.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n \n

\n Minimum\n permissions\n

\n

To run this command, you must have secretsmanager:ListSecretVersionIds permissions.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1056,7 +1056,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The identifier for the secret containing the versions you want to list. You can specify\n either the Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret whose versions you want to list.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, @@ -1064,20 +1064,20 @@ "target": "com.amazonaws.secretsmanager#MaxResultsType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

(Optional) Limits the number of results you want to include in \n the response. If you don't include this parameter, it defaults to a value that's \n specific to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (isn't null). Include\n that value as the NextToken request parameter in the next call to the operation to \n get the next part of the results. Note that Secrets Manager might return fewer results than the maximum \n even when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" + "smithy.api#documentation": "

The number of results to include in the response.

\n

If there are more results available, in the response, Secrets Manager includes NextToken. \n To get the next results, call ListSecretVersionIds again with the value from NextToken.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a \n NextToken response in a previous request indicating there's more\n output available. In a subsequent call, set it to the value of the previous call \n NextToken response to indicate where the output should continue from.

" + "smithy.api#documentation": "

A token that indicates where the output should continue from, if a previous call \n did not show all results. To get the next results, call ListSecretVersionIds again with \n this value.

" } }, "IncludeDeprecated": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

(Optional) Specifies that you want the results to include versions that do not have any\n staging labels attached to them. Such versions are considered deprecated and are subject to\n deletion by Secrets Manager as needed.

" + "smithy.api#documentation": "

Specifies whether to include versions of secrets that don't have any\n staging labels attached to them. Versions without staging labels are considered deprecated and are subject to\n deletion by Secrets Manager.

" } } } @@ -1088,25 +1088,25 @@ "Versions": { "target": "com.amazonaws.secretsmanager#SecretVersionsListType", "traits": { - "smithy.api#documentation": "

The list of the currently available versions of the specified secret.

" + "smithy.api#documentation": "

A list of the versions of the secret.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { - "smithy.api#documentation": "

If present in the response, this value indicates that \n there's more output available than included in the current response. This can \n occur even when the response includes no values at all, such as when you ask for a filtered view \n of a very long list. Use this value in the NextToken request parameter in a \n subsequent call to the operation to continue processing and get the next part of the output. You \n should repeat this until the NextToken response element comes back empty (as \n null).

" + "smithy.api#documentation": "

Secrets Manager includes this value if there's more output available than what is included \n in the current response. This can occur even when the response includes no values at all, \n such as when you ask for a filtered view of a long list. To get the next results, \n call ListSecretVersionIds again with this value.

" } }, "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the secret.

\n \n

Secrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.

\n
" + "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret.

" + "smithy.api#documentation": "

The name of the secret.

" } } } @@ -1131,7 +1131,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the\n versions currently stored for a specific secret, use ListSecretVersionIds.\n The encrypted fields SecretString and SecretBinary are not included\n in the output. To get that information, call the GetSecretValue\n operation.

\n \n

Always check the NextToken response parameter \n when calling any of the List* operations. These operations can occasionally return \n an empty or shorter than expected list of results even when there more results become available. \n When this happens, the NextToken response parameter contains a value to pass to the \n next call to the same API to request the next part of the list.

\n
\n

\n Minimum\n permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:ListSecrets

    \n
  • \n
\n

\n Related operations\n

\n ", + "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.

\n

\n Minimum\n permissions\n

\n

To run this command, you must have secretsmanager:ListSecrets permissions.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1146,19 +1146,19 @@ "target": "com.amazonaws.secretsmanager#MaxResultsType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

(Optional) Limits the number of results you want to include in \n the response. If you don't include this parameter, it defaults to a value that's \n specific to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (isn't null). Include\n that value as the NextToken request parameter in the next call to the operation to \n get the next part of the results. Note that Secrets Manager might return fewer results than the maximum \n even when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.

" + "smithy.api#documentation": "

The number of results to include in the response.

\n

If there are more results available, in the response, Secrets Manager includes NextToken. \n To get the next results, call ListSecrets again with the value from \n NextToken.

" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { - "smithy.api#documentation": "

(Optional) Use this parameter in a request if you receive a \n NextToken response in a previous request indicating there's more\n output available. In a subsequent call, set it to the value of the previous call \n NextToken response to indicate where the output should continue from.

" + "smithy.api#documentation": "

A token that indicates where the output should continue from, if a \n previous call did not show all results. To get the next results, call ListSecrets again \n with this value.

" } }, "Filters": { "target": "com.amazonaws.secretsmanager#FiltersListType", "traits": { - "smithy.api#documentation": "

Lists the secret request filters.

" + "smithy.api#documentation": "

The filters to apply to the list of secrets.

" } }, "SortOrder": { @@ -1181,7 +1181,7 @@ "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { - "smithy.api#documentation": "

If present in the response, this value indicates that \n there's more output available than included in the current response. This can \n occur even when the response includes no values at all, such as when you ask for a filtered view \n of a very long list. Use this value in the NextToken request parameter in a \n subsequent call to the operation to continue processing and get the next part of the output. You \n should repeat this until the NextToken response element comes back empty (as \n null).

" + "smithy.api#documentation": "

Secrets Manager includes this value if \n there's more output available than what is included in the current response. This can \n occur even when the response includes no values at all, such as when you ask for a filtered view \n of a long list. To get the next results, call ListSecrets again \n with this value.

" } } } @@ -1194,7 +1194,7 @@ } }, "traits": { - "smithy.api#documentation": "

You provided a resource-based policy with syntax errors.

", + "smithy.api#documentation": "

The resource policy has syntax errors.

", "smithy.api#error": "client" } }, @@ -1272,7 +1272,7 @@ } }, "traits": { - "smithy.api#documentation": "

The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.

", + "smithy.api#documentation": "

The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.

", "smithy.api#error": "client" } }, @@ -1305,7 +1305,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches the contents of the specified resource-based permission policy to a secret. A\n resource-based policy is optional. Alternatively, you can use IAM identity-based policies\n that specify the secret's Amazon Resource Name (ARN) in the policy statement's\n Resources element. You can also use a combination of both identity-based and\n resource-based policies. The affected users and roles receive the permissions that are\n permitted by all of the relevant policies. For more information, see Using Resource-Based\n Policies for Amazon Web Services Secrets Manager. For the complete description of the Amazon Web Services policy syntax and\n grammar, see IAM JSON\n Policy Reference in the IAM User Guide.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:PutResourcePolicy

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To retrieve the resource policy attached to a secret, use GetResourcePolicy.

    \n
  • \n
  • \n

    To delete the resource-based policy attached to a secret, use DeleteResourcePolicy.

    \n
  • \n
  • \n

    To list all of the currently available secrets, use ListSecrets.

    \n
  • \n
" + "smithy.api#documentation": "

Attaches a resource-based permission policy to a secret. A resource-based policy is \n optional. For more information, see Authentication and access control for Secrets Manager\n

\n

For information about attaching a policy in the console, see Attach a \n permissions policy to a secret.

" } }, "com.amazonaws.secretsmanager#PutResourcePolicyRequest": { @@ -1314,14 +1314,14 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret that you want to attach the resource-based policy. You can specify\n either the ARN or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to attach the resource-based policy.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { - "smithy.api#documentation": "

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services\n resource-based policy. The policy in the string identifies who can access or manage this\n secret and its versions. For information on how to format a JSON parameter for the various\n command line tool environments, see Using\n JSON for Parameters in the CLI User Guide.

", + "smithy.api#documentation": "

A JSON-formatted string for an Amazon Web Services\n resource-based policy. For example policies, see Permissions \n policy examples.

", "smithy.api#required": {} } }, @@ -1329,7 +1329,7 @@ "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

(Optional) If you set the parameter, BlockPublicPolicy to true, then you\n block resource-based policies that allow broad access to the secret.

" + "smithy.api#documentation": "

Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.

" } } } @@ -1340,13 +1340,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The ARN of the secret retrieved by the resource-based policy.

" + "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret retrieved by the resource-based policy.

" + "smithy.api#documentation": "

The name of the secret.

" } } } @@ -1383,7 +1383,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stores a new encrypted secret value in the specified secret. To do this, the operation\n creates a new version and attaches it to the secret. The version can contain a new\n SecretString value or a new SecretBinary value. You can also\n specify the staging labels that are initially attached to the new version.

\n

We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n
    \n
  • \n

    If this operation creates the first version for the secret then Secrets Manager\n automatically attaches the staging label AWSCURRENT to the new version.

    \n
  • \n
  • \n

    If you do not specify a value for VersionStages then Secrets Manager automatically\n moves the staging label AWSCURRENT to this new version.

    \n
  • \n
  • \n

    If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.

    \n
  • \n
  • \n

    This operation is idempotent. If a version with a VersionId with the same\n value as the ClientRequestToken parameter already exists and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you cannot modify an existing version; you can\n only create new ones.

    \n
  • \n
\n \n
    \n
  • \n

    If you call an operation to encrypt or decrypt the SecretString \n or SecretBinary for a secret in the same account as the calling user and that \n secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default \n Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager. If this key \n doesn't already exist in your account then Secrets Manager creates it for you automatically. All\n users and roles in the same Amazon Web Services account automatically have access to use the default CMK. \n Note that if an Secrets Manager API call results in Amazon Web Services creating the account's \n Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the \n result.

    \n
  • \n
  • \n

    If the secret resides in a different Amazon Web Services account from the credentials calling an API that \n requires encryption or decryption of the secret value then you must create and use a custom \n Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials \n from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the \n secret or when you update it by including it in the KMSKeyId. If you call an \n API that must encrypt or decrypt SecretString or SecretBinary \n using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account\n access to that other account's user or role for both the kms:GenerateDataKey and \n kms:Decrypt operations.

    \n
  • \n
\n
\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:PutSecretValue

    \n
  • \n
  • \n

    kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt\n the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK\n for Secrets Manager.

    \n
  • \n
\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString value or a new SecretBinary value.

\n

We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

You can specify the staging labels to attach to the new version in VersionStages. \n If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT to it .

\n

If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.

\n

This operation is idempotent. If a version with a VersionId with the same\n value as the ClientRequestToken parameter already exists, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.

" } }, "com.amazonaws.secretsmanager#PutSecretValueRequest": { @@ -1392,33 +1392,33 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret to which you want to add a new version. You can specify either the\n Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already\n exist.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to add a new version to.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

\n

If the secret doesn't already exist, use CreateSecret instead.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies a unique identifier for the new version of the secret.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request. If you don't use the SDK and instead generate a raw HTTP request to the\n Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself\n for new versions and include that value in the request.

\n
\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during the Lambda rotation\n function's processing. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.

\n
    \n
  • \n

    If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

    \n
  • \n
  • \n

    If a version with this value already exists and that version's\n SecretString or SecretBinary values are the same as those in\n the request then the request is ignored (the operation is idempotent).

    \n
  • \n
  • \n

    If a version with this value already exists and the version of the\n SecretString and SecretBinary values are different from those\n in the request then the request fails because you cannot modify an existing secret\n version. You can only create new versions to store new secret values.

    \n
  • \n
\n

This value becomes the VersionId of the new version.

", + "smithy.api#documentation": "

A unique identifier for the new version of the secret.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can\n leave this parameter empty because they generate a random UUID for you. If you don't \n use the SDK and instead generate a raw HTTP request to the\n Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself\n for new versions and include that value in the request.

\n
\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during the Lambda rotation\n function processing. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.

\n
    \n
  • \n

    If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

    \n
  • \n
  • \n

    If a version with this value already exists and that version's\n SecretString or SecretBinary values are the same as those in\n the request then the request is ignored. The operation is idempotent.

    \n
  • \n
  • \n

    If a version with this value already exists and the version of the\n SecretString and SecretBinary values are different from those\n in the request, then the request fails because you can't modify a secret \n version. You can only create new versions to store new secret values.

    \n
  • \n
\n

This value becomes the VersionId of the new version.

", "smithy.api#idempotencyToken": {} } }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies binary data that you want to encrypt and store in the new version of\n the secret. To use this parameter in the command-line tools, we recommend that you store your\n binary data in a file and then use the appropriate technique for your tool to pass the\n contents of the file as a parameter. Either SecretBinary or\n SecretString must have a value, but not both. They cannot both be empty.

\n \n

This parameter is not accessible if the secret using the Secrets Manager console.

\n

" + "smithy.api#documentation": "

The binary data to encrypt and store in the new version of\n the secret. To use this parameter in the command-line tools, we recommend that you store your\n binary data in a file and then pass the\n contents of the file as a parameter.

\n

You must include SecretBinary or SecretString, but not both.

\n

You can't access this value from the Secrets Manager console.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies text data that you want to encrypt and store in this new version of\n the secret. Either SecretString or SecretBinary must have a value,\n but not both. They cannot both be empty.

\n \n

If you create this secret by using the Secrets Manager console then Secrets Manager puts the\n protected secret text in only the SecretString parameter. The Secrets Manager console\n stores the information as a JSON structure of key/value pairs that the default Lambda rotation\n function knows how to parse.

\n

For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

" + "smithy.api#documentation": "

The text to encrypt and store in the new version of the secret.

\n

You must include SecretBinary or SecretString, but not both.

\n

We recommend you create the secret string as JSON key/value pairs, as shown in the example.

" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies a list of staging labels that are attached to this version of the\n secret. These staging labels are used to track the versions through the rotation process by\n the Lambda rotation function.

\n

A staging label must be unique to a single version of the secret. If you specify a staging\n label that's already associated with a different version of the same secret then that staging\n label is automatically removed from the other version and attached to this version.

\n

If you do not specify a value for VersionStages then Secrets Manager automatically\n moves the staging label AWSCURRENT to this new version.

" + "smithy.api#documentation": "

A list of staging labels to attach to this version of the\n secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

\n

If you specify a staging\n label that's already associated with a different version of the same secret, then Secrets Manager \n removes the label from the other version and attaches it to this version. \n If you specify \n AWSCURRENT, and it is already attached to another version, then Secrets Manager also \n moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

\n

If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version.

" } } } @@ -1429,25 +1429,25 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the secret for which you just created a version.

" + "smithy.api#documentation": "

The ARN of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret for which you just created or updated a version.

" + "smithy.api#documentation": "

The name of the secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

The unique identifier of the version of the secret you just created or updated.

" + "smithy.api#documentation": "

The unique identifier of the version of the secret.

" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { - "smithy.api#documentation": "

The list of staging labels that are currently attached to this version of the secret.\n Staging labels are used to track a version as it progresses through the secret rotation\n process.

" + "smithy.api#documentation": "

The list of staging labels that are currently attached to this version of the secret.\n Secrets Manager uses staging labels to track a version as it progresses through the secret rotation\n process.

" } } } @@ -1498,7 +1498,7 @@ } ], "traits": { - "smithy.api#documentation": "

Remove regions from replication.

" + "smithy.api#documentation": "

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

" } }, "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest": { @@ -1507,14 +1507,14 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Remove a secret by SecretId from replica Regions.

", + "smithy.api#documentation": "

The ARN or name of the secret.

", "smithy.api#required": {} } }, "RemoveReplicaRegions": { "target": "com.amazonaws.secretsmanager#RemoveReplicaRegionListType", "traits": { - "smithy.api#documentation": "

Remove replication from specific Regions.

", + "smithy.api#documentation": "

The Regions of the replicas to remove.

", "smithy.api#required": {} } } @@ -1526,13 +1526,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The secret ARN removed from replication regions.

" + "smithy.api#documentation": "

The ARN of the primary secret.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { - "smithy.api#documentation": "

Describes the remaining replication status after you remove regions from the replication list.

" + "smithy.api#documentation": "

The status of replicas for this secret after you remove Regions.

" } } } @@ -1554,18 +1554,18 @@ "Region": { "target": "com.amazonaws.secretsmanager#RegionType", "traits": { - "smithy.api#documentation": "

Describes a single instance of Region objects.

" + "smithy.api#documentation": "

A Region code. For a list of Region codes, see Name and code of Regions.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

Can be an ARN, Key ID, or Alias.

" + "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.

" } } }, "traits": { - "smithy.api#documentation": "

(Optional) Custom type consisting of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias.

" + "smithy.api#documentation": "

A custom type that specifies a Region and the KmsKeyId for a replica secret.

" } }, "com.amazonaws.secretsmanager#ReplicateSecretToRegions": { @@ -1591,7 +1591,7 @@ } ], "traits": { - "smithy.api#documentation": "

Converts an existing secret to a multi-Region secret and begins replication the secret to a\n list of new regions.

" + "smithy.api#documentation": "

Replicates the secret to a new Regions. See Multi-Region secrets.

" } }, "com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest": { @@ -1600,21 +1600,21 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Use the Secret Id to replicate a secret to regions.

", + "smithy.api#documentation": "

The ARN or name of the secret to replicate.

", "smithy.api#required": {} } }, "AddReplicaRegions": { "target": "com.amazonaws.secretsmanager#AddReplicaRegionListType", "traits": { - "smithy.api#documentation": "

Add Regions to replicate the secret.

", + "smithy.api#documentation": "

A list of Regions in which to replicate the secret.

", "smithy.api#required": {} } }, "ForceOverwriteReplicaSecret": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { - "smithy.api#documentation": "

(Optional) If set, Secrets Manager replication overwrites a secret with the same name in the\n destination region.

" + "smithy.api#documentation": "

Specifies whether to overwrite a secret with the same name in the destination Region.

" } } } @@ -1625,13 +1625,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

Replicate a secret based on the ReplicaRegionType> consisting of a\n Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.

" + "smithy.api#documentation": "

The ARN of the primary secret.

" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { - "smithy.api#documentation": "

Describes the secret replication status as PENDING, SUCCESS or FAIL.

" + "smithy.api#documentation": "

The status of replication.

" } } } @@ -1666,7 +1666,7 @@ "StatusMessage": { "target": "com.amazonaws.secretsmanager#StatusMessageType", "traits": { - "smithy.api#documentation": "

Status message such as \"Secret with this name already exists in this\n region\".

" + "smithy.api#documentation": "

Status message such as \"Secret with this name already exists in this\n region\".

" } }, "LastAccessedDate": { @@ -1703,7 +1703,7 @@ } }, "traits": { - "smithy.api#documentation": "

We can't find the resource that you asked for.

", + "smithy.api#documentation": "

Secrets Manager can't find the resource that you asked for.

", "smithy.api#error": "client" } }, @@ -1730,7 +1730,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the scheduled deletion of a secret by removing the DeletedDate time\n stamp. This makes the secret accessible to query once again.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:RestoreSecret

    \n
  • \n
\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Cancels the scheduled deletion of a secret by removing the DeletedDate time\n stamp. You can access a secret again after it has been restored.

" } }, "com.amazonaws.secretsmanager#RestoreSecretRequest": { @@ -1739,7 +1739,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret that you want to restore from a previously scheduled deletion. You\n can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to restore.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } } @@ -1757,7 +1757,7 @@ "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret that was restored.

" + "smithy.api#documentation": "

The name of the secret that was restored.

" } } } @@ -1785,7 +1785,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures and starts the asynchronous process of rotating this secret. If you include the\n configuration parameters, the operation sets those values for the secret and then immediately\n starts a rotation. If you do not include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret. After the rotation completes, the\n protected service and its clients all use the new version of the secret.

\n

This required configuration information includes the ARN of an Amazon Web Services Lambda function and\n optionally, the time between scheduled rotations. The Lambda rotation function creates a new\n version of the secret and creates or updates the credentials on the protected service to\n match. After testing the new credentials, the function marks the new secret with the staging\n label AWSCURRENT so that your clients all immediately begin to use the new version. For more\n information about rotating secrets and how to configure a Lambda function to rotate the\n secrets for your protected service, see Rotating Secrets in Amazon Web Services Secrets Manager in the\n Amazon Web Services Secrets Manager User Guide.

\n

Secrets Manager schedules the next rotation when the previous \n one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the \n actual date of the last rotation. The service chooses the hour within that 24-hour date window \n randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour \n and influenced by a variety of factors that help distribute load.

\n

The\n rotation function must end with the versions of the secret in one of two states:

\n
    \n
  • \n

    The AWSPENDING and AWSCURRENT staging labels are attached to the same version of\n the secret, or

    \n
  • \n
  • \n

    The AWSPENDING staging label is not attached to any version of the secret.

    \n
  • \n
\n

If the AWSPENDING staging label is present but not attached to the same version as\n AWSCURRENT then any later invocation of RotateSecret assumes that a previous\n rotation request is still in progress and returns an error.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:RotateSecret

    \n
  • \n
  • \n

    lambda:InvokeFunction (on the function specified in the secret's metadata)

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To list the secrets in your account, use ListSecrets.

    \n
  • \n
  • \n

    To get the details for a version of a secret, use DescribeSecret.

    \n
  • \n
  • \n

    To create a new version of a secret, use CreateSecret.

    \n
  • \n
  • \n

    To attach staging labels to or remove staging labels from a version of a secret, use\n UpdateSecretVersionStage.

    \n
  • \n
" + "smithy.api#documentation": "

Configures and starts the asynchronous process of rotating the secret.

\n

If you include the\n configuration parameters, the operation sets the values for the secret and then immediately\n starts a rotation. If you don't include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret. For more information about rotation, \n see Rotate secrets.

\n

To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule \n for the rotation. The Lambda rotation function creates a new\n version of the secret and creates or updates the credentials on the database or service to\n match. After testing the new credentials, the function marks the new secret version with the staging\n label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more\n information, see How rotation works.

\n

When rotation is successful, the AWSPENDING staging label might be attached to the same \n version as the AWSCURRENT version, or it might not be attached to any version.

\n

If the AWSPENDING staging label is present but not attached to the same version as\n AWSCURRENT, then any later invocation of RotateSecret assumes that a previous\n rotation request is still in progress and returns an error.

\n

To run this command, you must have secretsmanager:RotateSecret permissions and \n lambda:InvokeFunction permissions on the function specified in the secret's metadata.

" } }, "com.amazonaws.secretsmanager#RotateSecretRequest": { @@ -1794,21 +1794,21 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret that you want to rotate. You can specify either the Amazon Resource\n Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret to rotate.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies a unique identifier for the new version of the secret that helps\n ensure idempotency.

\n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP\n request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for new versions and include that value in the\n request.

\n

You only need to specify your own value if you implement your own retry logic and want to\n ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.

\n

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if\n there are failures and retries during the function's processing. This value becomes the\n VersionId of the new version.

", + "smithy.api#documentation": "

A unique identifier for the new version of the secret that helps\n ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if\n there are failures and retries during rotation. This value becomes the\n VersionId of the new version.

\n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP\n request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for new versions and include that value in the\n request.

\n

You only need to specify this value if you implement your own retry logic and you want to\n ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.

", "smithy.api#idempotencyToken": {} } }, "RotationLambdaARN": { "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

" + "smithy.api#documentation": "

The ARN of the Lambda rotation function that can rotate the secret.

" } }, "RotationRules": { @@ -1831,13 +1831,13 @@ "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret.

" + "smithy.api#documentation": "

The name of the secret.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

The ID of the new version of the secret created by the rotation started by this\n request.

" + "smithy.api#documentation": "

The ID of the new version of the secret.

" } } } @@ -1861,7 +1861,7 @@ "target": "com.amazonaws.secretsmanager#AutomaticallyRotateAfterDaysType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Specifies the number of days between automatic scheduled rotations of the secret.

\n

Secrets Manager schedules the next rotation when the previous \n one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the \n actual date of the last rotation. The service chooses the hour within that 24-hour date window \n randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour \n and influenced by a variety of factors that help distribute load.

" + "smithy.api#documentation": "

Specifies the number of days between automatic scheduled rotations of the secret.

\n

Secrets Manager schedules the next rotation when the previous \n one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the \n actual date of the last rotation. The service chooses the hour within that 24-hour date window \n randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour \n and influenced by a variety of factors that help distribute load.

" } } }, @@ -1903,13 +1903,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

\n

For more information about ARNs in Secrets Manager, see Policy Resources in the\n Amazon Web Services Secrets Manager User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret. You can use forward slashes in the name to represent a\n path hierarchy. For example, /prod/databases/dbserver1 could represent the secret\n for a server named dbserver1 in the folder databases in the folder\n prod.

" + "smithy.api#documentation": "

The friendly name of the secret. You can use forward slashes in the name to represent a\n path hierarchy. For example, /prod/databases/dbserver1 could represent the secret\n for a server named dbserver1 in the folder databases in the folder\n prod.

" } }, "Description": { @@ -1921,7 +1921,7 @@ "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the\n SecretString and SecretBinary fields in each version of the\n secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with\n the default KMS CMK, the key named awssecretsmanager, for this account.

" + "smithy.api#documentation": "

The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with \n the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

" } }, "RotationEnabled": { @@ -2176,7 +2176,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the secret from replication and promotes the secret to a regional secret in the replica Region.

" + "smithy.api#documentation": "

Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.

\n

You must call this operation from the Region in which you want to promote the replica to a primary secret.

" } }, "com.amazonaws.secretsmanager#StopReplicationToReplicaRequest": { @@ -2185,7 +2185,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Response to StopReplicationToReplica of a secret, based on the SecretId.

", + "smithy.api#documentation": "

The ARN of the primary secret.

", "smithy.api#required": {} } } @@ -2197,7 +2197,7 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

Response StopReplicationToReplica of a secret, based on the ARN,.

" + "smithy.api#documentation": "

The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.

" } } } @@ -2263,7 +2263,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches one or more tags, each consisting of a key name and a value, to the specified\n secret. Tags are part of the secret's overall metadata, and are not associated with any\n specific version of the secret. This operation only appends tags to the existing list of tags.\n To remove tags, you must use UntagResource.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per secretβ€”50

    \n
  • \n
  • \n

    Maximum key lengthβ€”127 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Maximum value lengthβ€”255 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.

    \n
  • \n
  • \n

    If you use your tagging schema across multiple services and resources,\n remember other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.

    \n
  • \n
\n \n

If you use tags as part of your security strategy, then adding or removing a tag can\n change permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an Access Denied\n error.

\n
\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:TagResource

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To remove one or more tags from the collection attached to a secret, use UntagResource.

    \n
  • \n
  • \n

    To view the list of tags attached to a secret, use DescribeSecret.

    \n
  • \n
" + "smithy.api#documentation": "

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the \n secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.

\n

The following restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per secret: 50

    \n
  • \n
  • \n

    Maximum key length: 127 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Maximum value length: 255 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Tag keys and values are case sensitive.

    \n
  • \n
  • \n

    Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.

    \n
  • \n
  • \n

    If you use your tagging schema across multiple services and resources,\n other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.

    \n
  • \n
\n \n \n

If you use tags as part of your security strategy, then adding or removing a tag can\n change permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an Access Denied\n error.

\n
" } }, "com.amazonaws.secretsmanager#TagResourceRequest": { @@ -2272,14 +2272,14 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The identifier for the secret that you want to attach tags to. You can specify either the\n Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The identifier for the secret to attach tags to. You can specify either the\n Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { - "smithy.api#documentation": "

The tags to attach to the secret. Each element in the list consists of a Key\n and a Value.

\n

This parameter to the API requires a JSON text string argument.

\n

For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

", + "smithy.api#documentation": "

The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key\n and a Value.

\n\n

For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

", "smithy.api#required": {} } } @@ -2317,7 +2317,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more tags from the specified secret.

\n

This operation is idempotent. If a requested tag is not attached to the secret, no error\n is returned and the secret metadata is unchanged.

\n \n

If you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing your\n permissions for this secret, then the operation is blocked and returns an Access Denied\n error.

\n
\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:UntagResource

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To add one or more tags to the collection attached to a secret, use TagResource.

    \n
  • \n
  • \n

    To view the list of tags attached to a secret, use DescribeSecret.

    \n
  • \n
" + "smithy.api#documentation": "

Removes specific tags from a secret.

\n

This operation is idempotent. If a requested tag is not attached to the secret, no error\n is returned and the secret metadata is unchanged.

\n \n

If you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing your\n permissions for this secret, then the operation is blocked and returns an Access Denied\n error.

\n
" } }, "com.amazonaws.secretsmanager#UntagResourceRequest": { @@ -2326,14 +2326,14 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

The identifier for the secret that you want to remove tags from. You can specify either\n the Amazon Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.secretsmanager#TagKeyListType", "traits": { - "smithy.api#documentation": "

A list of tag key names to remove from the secret. You don't specify the value. Both the\n key and its associated value are removed.

\n

This parameter to the API requires a JSON text string argument.

\n

For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

", + "smithy.api#documentation": "

A list of tag key names to remove from the secret. You don't specify the value. Both the\n key and its associated value are removed.

\n

This parameter requires a JSON text string argument.

\n

For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

", "smithy.api#required": {} } } @@ -2377,7 +2377,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies many of the details of the specified secret.

\n

To change the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret\n instead.

\n \n

We recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n \n

The Secrets Manager console uses only the SecretString parameter and therefore limits\n you to encrypting and storing only a text string. To encrypt and store binary data as part\n of the version of a secret, you must use either the Amazon Web Services CLI or one of the Amazon Web Services\n SDKs.

\n
\n
    \n
  • \n

    If a version with a VersionId with the same value as the\n ClientRequestToken parameter already exists, the operation results in an\n error. You cannot modify an existing version, you can only create a new version.

    \n
  • \n
  • \n

    If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.

    \n
  • \n
\n \n
    \n
  • \n

    If you call an operation to encrypt or decrypt the SecretString \n or SecretBinary for a secret in the same account as the calling user and that \n secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default \n Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager. If this key \n doesn't already exist in your account then Secrets Manager creates it for you automatically. All\n users and roles in the same Amazon Web Services account automatically have access to use the default CMK. \n Note that if an Secrets Manager API call results in Amazon Web Services creating the account's \n Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the \n result.

    \n
  • \n
  • \n

    If the secret resides in a different Amazon Web Services account from the credentials calling an API that \n requires encryption or decryption of the secret value then you must create and use a custom \n Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials \n from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the \n secret or when you update it by including it in the KMSKeyId. If you call an \n API that must encrypt or decrypt SecretString or SecretBinary \n using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account\n access to that other account's user or role for both the kms:GenerateDataKey and \n kms:Decrypt operations.

    \n
  • \n
\n
\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:UpdateSecret

    \n
  • \n
  • \n

    kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret.\n You do not need this permission to use the account's Amazon Web Services managed CMK for\n Secrets Manager.

    \n
  • \n
  • \n

    kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do\n not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager.

    \n
  • \n
\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret instead.

\n \n

We recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.

\n

If you call this operation with a VersionId that matches an existing version's \n ClientRequestToken, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time \n significant delay in returning the result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key.

\n \n

To run this command, you must have secretsmanager:UpdateSecret permissions. If you use a \n customer managed key, you must also have kms:GenerateDataKey and kms:Decrypt permissions .

" } }, "com.amazonaws.secretsmanager#UpdateSecretRequest": { @@ -2386,39 +2386,39 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret that you want to modify or to which you want to add a new version.\n You can specify either the Amazon Resource Name (ARN) or the friendly name of the\n secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { - "smithy.api#documentation": "

(Optional) If you want to add a new version to the secret, this parameter specifies a\n unique identifier for the new version that helps ensure idempotency.

\n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager\n service endpoint, then you must generate a ClientRequestToken yourself for new\n versions and include that value in the request.

\n

You typically only need to interact with this value if you implement your own retry logic\n and want to ensure that a given secret is not created twice. We recommend that you generate a\n UUID-type\n value to ensure uniqueness within the specified secret.

\n

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if\n there are failures and retries during the Lambda rotation function's processing.

\n
    \n
  • \n

    If the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.

    \n
  • \n
  • \n

    If a version with this value already exists and that version's\n SecretString and SecretBinary values are the same as those in\n the request then the request is ignored (the operation is idempotent).

    \n
  • \n
  • \n

    If a version with this value already exists and that version's\n SecretString and SecretBinary values are different from the\n request then an error occurs because you cannot modify an existing secret value.

    \n
  • \n
\n

This value becomes the VersionId of the new version.

", + "smithy.api#documentation": "

If you include SecretString or SecretBinary, then Secrets Manager creates \n a new version for the secret, and this parameter specifies the unique identifier for the new \n version.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it\n as the value for this parameter in the request. If you don't use the SDK and instead\n generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for the new version and include the value in the\n request.

\n
\n

This value becomes the VersionId of the new version.

", "smithy.api#idempotencyToken": {} } }, "Description": { "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies an updated user-provided description of the secret.

" + "smithy.api#documentation": "

The description of the secret.

" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager \n uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging\n Labels in the Amazon Web Services Secrets Manager User Guide.

\n \n

You can only use the account's default CMK to encrypt and decrypt if you call this\n operation using credentials from the same account that owns the secret. If the secret is in\n a different account, then you must create a custom CMK and provide the ARN of that CMK in\n this field. The user making the call must have permissions to both the secret and the CMK in\n their respective accounts.

\n
" + "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager \n uses to encrypt new secret versions as well as any existing versions the staging labels \n AWSCURRENT, AWSPENDING, or AWSPREVIOUS. \n For more information about versions and staging labels, see Concepts: Version.

\n \n

You can only use the Amazon Web Services managed key aws/secretsmanager if you call this\n operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in\n a different account, then you must use a customer managed key and provide the ARN of that KMS key in\n this field. The user making the call must have permissions to both the secret and the KMS key in\n their respective accounts.

\n
" } }, "SecretBinary": { "target": "com.amazonaws.secretsmanager#SecretBinaryType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies updated binary data that you want to encrypt and store in the new\n version of the secret. To use this parameter in the command-line tools, we recommend that you\n store your binary data in a file and then use the appropriate technique for your tool to pass\n the contents of the file as a parameter. Either SecretBinary or\n SecretString must have a value, but not both. They cannot both be empty.

\n

This parameter is not accessible using the Secrets Manager console.

" + "smithy.api#documentation": "

The binary data to encrypt and store in the new\n version of the secret. We recommend that you\n store your binary data in a file and then pass\n the contents of the file as a parameter.

\n

Either SecretBinary or\n SecretString must have a value, but not both.

\n

You can't access this parameter in the Secrets Manager console.

" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { - "smithy.api#documentation": "

(Optional) Specifies updated text data that you want to encrypt and store in this new\n version of the secret. Either SecretBinary or SecretString must have\n a value, but not both. They cannot both be empty.

\n

If you create this secret by using the Secrets Manager console then Secrets Manager puts the\n protected secret text in only the SecretString parameter. The Secrets Manager console\n stores the information as a JSON structure of key/value pairs that the default Lambda rotation\n function knows how to parse.

\n

For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

" + "smithy.api#documentation": "

The text data to encrypt and store in the new\n version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

\n

Either SecretBinary or SecretString must have\n a value, but not both.

" } } } @@ -2429,19 +2429,19 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The ARN of the secret that was updated.

\n \n

Secrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.

\n
" + "smithy.api#documentation": "

The ARN of the secret that was updated.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret that was updated.

" + "smithy.api#documentation": "

The name of the secret that was updated.

" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

If a new version of the secret was created by this operation, then VersionId\n contains the unique identifier of the new version.

" + "smithy.api#documentation": "

If Secrets Manager created a new version of the secret during this operation, then VersionId\n contains the unique identifier of the new version.

" } } } @@ -2472,7 +2472,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the staging labels attached to a version of a secret. Staging labels are used to\n track a version as it progresses through the secret rotation process. You can attach a staging\n label to only one version of a secret at a time. If a staging label to be added is already\n attached to another version, then it is moved--removed from the other version first and\n then attached to this one. For more information about staging labels, see Staging\n Labels in the Amazon Web Services Secrets Manager User Guide.

\n

The staging labels that you specify in the VersionStage parameter are added\n to the existing list of staging labels--they don't replace it.

\n

You can move the AWSCURRENT staging label to this version by including it in this\n call.

\n \n

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.

\n
\n

If this action results in the last label being removed from a version, then the version is\n considered to be 'deprecated' and can be deleted by Secrets Manager.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    secretsmanager:UpdateSecretVersionStage

    \n
  • \n
\n

\n Related operations\n

\n
    \n
  • \n

    To get the list of staging labels that are currently associated with a version of a\n secret, use \n DescribeSecret\n and examine the\n SecretVersionsToStages response value.

    \n
  • \n
" + "smithy.api#documentation": "

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to\n track a version as it progresses through the secret rotation process. Each staging label can be \n attached to only one version at a time. To add a staging label to a version when it is already \n attached to another version, Secrets Manager first removes it from the other version first and\n then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

\n

The staging labels that you specify in the VersionStage parameter are added\n to the existing list of staging labels for the version.

\n

You can move the AWSCURRENT staging label to this version by including it in this\n call.

\n \n

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.

\n
\n

If this action results in the last label being removed from a version, then the version is\n considered to be 'deprecated' and can be deleted by Secrets Manager.

" } }, "com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest": { @@ -2481,7 +2481,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret with the version with the list of staging labels you want to modify.\n You can specify either the Amazon Resource Name (ARN) or the friendly name of the\n secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", + "smithy.api#documentation": "

The ARN or the name of the secret with the version and staging labelsto modify.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

", "smithy.api#required": {} } }, @@ -2495,13 +2495,13 @@ "RemoveFromVersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

Specifies the secret version ID of the version that the staging label is to be removed\n from. If the staging label you are trying to attach to one version is already attached to a\n different version, then you must include this parameter and specify the version that the label\n is to be removed from. If the label is attached and you either do not specify this parameter,\n or the version ID does not match, then the operation fails.

" + "smithy.api#documentation": "

The ID of the version that the staging label is to be removed\n from. If the staging label you are trying to attach to one version is already attached to a\n different version, then you must include this parameter and specify the version that the label\n is to be removed from. If the label is attached and you either do not specify this parameter,\n or the version ID does not match, then the operation fails.

" } }, "MoveToVersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "

(Optional) The secret version ID that you want to add the staging label. If you want to\n remove a label from a version, then do not specify this parameter.

\n

If the staging label is already attached to a different version of the secret, then you\n must also specify the RemoveFromVersionId parameter.

" + "smithy.api#documentation": "

The ID of the version to add the staging label to. To\n remove a label from a version, then do not specify this parameter.

\n

If the staging label is already attached to a different version of the secret, then you\n must also specify the RemoveFromVersionId parameter.

" } } } @@ -2512,13 +2512,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "

The ARN of the secret with the modified staging label.

" + "smithy.api#documentation": "

The ARN of the secret that was updated.

" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "

The friendly name of the secret with the modified staging label.

" + "smithy.api#documentation": "

The name of the secret that was updated.

" } } } @@ -2549,7 +2549,7 @@ } ], "traits": { - "smithy.api#documentation": "

Validates that the resource policy does not grant a wide range of IAM principals access to\n your secret. The JSON request string input and response output displays formatted code\n with white space and line breaks for better readability. Submit your input as a single line \n JSON string. A resource-based policy is optional for secrets.

\n

The API performs three checks when validating the secret:

\n
    \n
  • \n

    Sends a call to Zelkova, an automated reasoning engine, to ensure your Resource Policy does not\n allow broad access to your secret.

    \n
  • \n
  • \n

    Checks for correct syntax in a policy.

    \n
  • \n
  • \n

    Verifies the policy does not lock out a caller.

    \n
  • \n
\n\n\n

\n Minimum Permissions\n

\n

You must have the permissions required to access the following APIs:

\n
    \n
  • \n

    \n secretsmanager:PutResourcePolicy\n

    \n
  • \n
  • \n

    \n secretsmanager:ValidateResourcePolicy\n

    \n
  • \n
" + "smithy.api#documentation": "

Validates that a resource policy does not grant a wide range of principals access to\n your secret. A resource-based policy is optional for secrets.

\n

The API performs three checks when validating the policy:

\n
    \n
  • \n

    Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not\n allow broad access to your secret, for example policies that use a wildcard for the principal.

    \n
  • \n
  • \n

    Checks for correct syntax in a policy.

    \n
  • \n
  • \n

    Verifies the policy does not lock out a caller.

    \n
  • \n
" } }, "com.amazonaws.secretsmanager#ValidateResourcePolicyRequest": { @@ -2558,13 +2558,13 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "

(Optional) The identifier of the secret with the resource-based policy you want to\n validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the\n secret.

\n

For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.

" + "smithy.api#documentation": "

This field is reserved for internal use.

" } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { - "smithy.api#documentation": "

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services\n resource-based policy. The policy in the string identifies who can access or manage this\n secret and its versions. For information on how to format a JSON parameter for the various\n command line tool environments, see Using\n JSON for Parameters in the CLI User Guide.publi

", + "smithy.api#documentation": "

A JSON-formatted string that contains an Amazon Web Services\n resource-based policy. The policy in the string identifies who can access or manage this\n secret and its versions. For example policies, see Permissions policy examples.

", "smithy.api#required": {} } } @@ -2576,13 +2576,13 @@ "PolicyValidationPassed": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { - "smithy.api#documentation": "

Returns a message stating that your Reource Policy passed validation.

" + "smithy.api#documentation": "

True if your policy passes validation, otherwise false.

" } }, "ValidationErrors": { "target": "com.amazonaws.secretsmanager#ValidationErrorsType", "traits": { - "smithy.api#documentation": "

Returns an error message if your policy doesn't pass validatation.

" + "smithy.api#documentation": "

Validation errors if your policy didn't pass validation.

" } } } @@ -2615,6 +2615,21 @@ }, "com.amazonaws.secretsmanager#secretsmanager": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Secrets Manager", + "arnNamespace": "secretsmanager", + "cloudFormationName": "SecretsManager", + "cloudTrailEventSource": "secretsmanager.amazonaws.com", + "endpointPrefix": "secretsmanager" + }, + "aws.auth#sigv4": { + "name": "secretsmanager" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Web Services Secrets Manager\n

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

\n \n

This guide provides descriptions of the Secrets Manager API. For more information about using this\n service, see the Amazon Web Services Secrets Manager User Guide.

\n \n

\n API Version\n

\n \n

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

\n \n

As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of\n libraries and sample code for various programming languages and platforms such as Java,\n Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic\n access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the Amazon Web Services\n SDKs, including downloading and installing them, see Tools for Amazon Web Services.

\n
\n

We recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you\n also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn\n more about the Secrets Manager HTTP Query API, see Making Query Requests in the\n Amazon Web Services Secrets Manager User Guide.

\n

Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use\n GET for some actions and POST for others. However, GET requests are subject to the limitation\n size of a URL. Therefore, for operations that require larger sizes, use a POST request.

\n \n \n \n \n \n \n \n

\n Support and Feedback for Amazon Web Services Secrets Manager\n

\n \n

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more\n information about the Amazon Web Services Discussion Forums, see Forums\n Help.

\n \n

\n How examples are presented\n

\n \n

The JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a\n response to HTTP query requests contain single, long strings without line breaks or white\n space formatting. The JSON shown in the examples displays the code formatted with both line\n breaks and white space to improve readability. When example input parameters can also cause\n long strings extending beyond the screen, you can insert line breaks to enhance readability.\n You should always submit the input as a single JSON text string.

\n \n \n

\n Logging API Requests\n

\n

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services\n account and delivers log files to an Amazon S3 bucket. By using information that's collected\n by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the\n request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services\n CloudTrail, see Logging\n Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide.\n To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

", + "smithy.api#title": "AWS Secrets Manager" + }, "version": "2017-10-17", "operations": [ { @@ -2683,22 +2698,7 @@ { "target": "com.amazonaws.secretsmanager#ValidateResourcePolicy" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Secrets Manager", - "arnNamespace": "secretsmanager", - "cloudFormationName": "SecretsManager", - "cloudTrailEventSource": "secretsmanager.amazonaws.com", - "endpointPrefix": "secretsmanager" - }, - "aws.auth#sigv4": { - "name": "secretsmanager" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Secrets Manager\n

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

\n \n

This guide provides descriptions of the Secrets Manager API. For more information about using this\n service, see the Amazon Web Services Secrets Manager User Guide.

\n \n

\n API Version\n

\n \n

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

\n \n

As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of\n libraries and sample code for various programming languages and platforms such as Java,\n Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic\n access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the Amazon Web Services\n SDKs, including downloading and installing them, see Tools for Amazon Web Services.

\n
\n

We recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you\n also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn\n more about the Secrets Manager HTTP Query API, see Making Query Requests in the\n Amazon Web Services Secrets Manager User Guide.

\n

Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use\n GET for some actions and POST for others. However, GET requests are subject to the limitation\n size of a URL. Therefore, for operations that require larger sizes, use a POST request.

\n \n \n \n \n \n \n \n

\n Support and Feedback for Amazon Web Services Secrets Manager\n

\n \n

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more\n information about the Amazon Web Services Discussion Forums, see Forums\n Help.

\n \n

\n How examples are presented\n

\n \n

The JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a\n response to HTTP query requests contain single, long strings without line breaks or white\n space formatting. The JSON shown in the examples displays the code formatted with both line\n breaks and white space to improve readability. When example input parameters can also cause\n long strings extending beyond the screen, you can insert line breaks to enhance readability.\n You should always submit the input as a single JSON text string.

\n \n \n

\n Logging API Requests\n

\n

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services\n account and delivers log files to an Amazon S3 bucket. By using information that's collected\n by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the\n request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services\n CloudTrail, see Logging\n Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide.\n To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

", - "smithy.api#title": "AWS Secrets Manager" - } + ] } } } diff --git a/aws/sdk/aws-models/securityhub.json b/aws/sdk/aws-models/securityhub.json index 8b8a344b64..4ce4744a5f 100644 --- a/aws/sdk/aws-models/securityhub.json +++ b/aws/sdk/aws-models/securityhub.json @@ -1051,6 +1051,26 @@ "smithy.api#documentation": "

Contains information about a version 2 stage for Amazon API Gateway.

" } }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Availability Zone for the automatic scaling group.

" + } + }, "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails": { "type": "structure", "members": { @@ -1083,12 +1103,160 @@ "traits": { "smithy.api#documentation": "

Indicates when the auto scaling group was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" } + }, + "MixedInstancesPolicy": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails", + "traits": { + "smithy.api#documentation": "

The mixed instances policy for the automatic scaling group.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesList", + "traits": { + "smithy.api#documentation": "

The list of Availability Zones for the automatic scaling group.

" + } } }, "traits": { "smithy.api#documentation": "

Provides details about an auto scaling group.

" } }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails": { + "type": "structure", + "members": { + "InstancesDistribution": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails", + "traits": { + "smithy.api#documentation": "

The instances distribution. The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails", + "traits": { + "smithy.api#documentation": "

The launch template to use and the instance types (overrides) to use to provision EC2 instances to fulfill On-Demand and Spot capacities.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The mixed instances policy for the automatic scaling group.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails": { + "type": "structure", + "members": { + "OnDemandAllocationStrategy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

How to allocate instance types to fulfill On-Demand capacity.

" + } + }, + "OnDemandBaseCapacity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.

" + } + }, + "OnDemandPercentageAboveBaseCapacity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The percentage of On-Demand Instances and Spot Instances for additional capacity beyond OnDemandBaseCapacity.

" + } + }, + "SpotAllocationStrategy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

How to allocate instances across Spot Instance pools.

" + } + }, + "SpotInstancePools": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of Spot Instance pools across which to allocate your Spot Instances.

" + } + }, + "SpotMaxPrice": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the instances distribution.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template to use.

" + } + }, + "Overrides": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList", + "traits": { + "smithy.api#documentation": "

Property values to use to override the values in the launch template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch template and overrides for a mixed instances policy.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the launch template to use.

" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type. For example, m3.xlarge.

" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Property values to use to override the values in the launch template.

" + } + }, "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails": { "type": "structure", "members": { @@ -1281,6 +1449,12 @@ "traits": { "smithy.api#documentation": "

The user data to make available to the launched EC2 instances. Must be base64-encoded\n text.

" } + }, + "MetadataOptions": { + "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationMetadataOptions", + "traits": { + "smithy.api#documentation": "

The metadata options for the instances.

" + } } }, "traits": { @@ -1301,6 +1475,32 @@ "smithy.api#documentation": "

Information about the type of monitoring for instances in the group.

" } }, + "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationMetadataOptions": { + "type": "structure", + "members": { + "HttpEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

" + } + }, + "HttpTokens": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether token usage is required or optional for metadata requests. By default, token usage is optional.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instances.

" + } + }, "com.amazonaws.securityhub#AwsCertificateManagerCertificateDetails": { "type": "structure", "members": { @@ -8306,149 +8506,325 @@ "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { "type": "long" }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails": { + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.securityhub#Integer", + "DeleteProtection": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

The number of data nodes to use in the OpenSearch domain.

" + "smithy.api#documentation": "

Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.

" } }, - "WarmEnabled": { - "target": "com.amazonaws.securityhub#Boolean", + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Whether UltraWarm is enabled.

" + "smithy.api#documentation": "

A description of the firewall.

" } }, - "WarmCount": { - "target": "com.amazonaws.securityhub#Integer", + "FirewallArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The number of UltraWarm instances.

" + "smithy.api#documentation": "

The ARN of the firewall.

" } }, - "DedicatedMasterEnabled": { + "FirewallId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the firewall.

" + } + }, + "FirewallName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name of the firewall.

" + } + }, + "FirewallPolicyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the firewall policy.

" + } + }, + "FirewallPolicyChangeProtection": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.

" + "smithy.api#documentation": "

Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot associate a different policy with the firewall.

" } }, - "ZoneAwarenessConfig": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails", + "SubnetChangeProtection": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

" + "smithy.api#documentation": "

Whether the firewall is protected from a change to the subnet associations. If set to true, you cannot map different subnets to the firewall.

" } }, - "DedicatedMasterCount": { - "target": "com.amazonaws.securityhub#Integer", + "SubnetMappings": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsList", "traits": { - "smithy.api#documentation": "

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

" + "smithy.api#documentation": "

The public subnets that Network Firewall uses for the firewall. Each subnet must belong to a different Availability Zone.

" } }, - "InstanceType": { + "VpcId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The instance type for your data nodes.

" + "smithy.api#documentation": "

The identifier of the VPC where the firewall is used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall firewall.

" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallPolicyDetails": { + "type": "structure", + "members": { + "FirewallPolicy": { + "target": "com.amazonaws.securityhub#FirewallPolicyDetails", + "traits": { + "smithy.api#documentation": "

The firewall policy configuration.

" } }, - "WarmType": { + "FirewallPolicyArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of UltraWarm instance.

" + "smithy.api#documentation": "

The ARN of the firewall policy.

" } }, - "ZoneAwarenessEnabled": { - "target": "com.amazonaws.securityhub#Boolean", + "FirewallPolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

" + "smithy.api#documentation": "

The identifier of the firewall policy.

" } }, - "DedicatedMasterType": { + "FirewallPolicyName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The hardware configuration of the computer that hosts the dedicated master node.

\n

If this attribute is specified, then DedicatedMasterEnabled must be true.\n

" + "smithy.api#documentation": "

The name of the firewall policy.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the firewall policy.

" } } }, "traits": { - "smithy.api#documentation": "

Details about the configuration of an OpenSearch cluster.

" + "smithy.api#documentation": "

Details about a firewall policy. A firewall policy defines the behavior of a network firewall.

" } }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails": { + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsDetails": { "type": "structure", "members": { - "AvailabilityZoneCount": { - "target": "com.amazonaws.securityhub#Integer", + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.

" + "smithy.api#documentation": "

The identifier of the subnet

" } } }, "traits": { - "smithy.api#documentation": "

Configuration options for zone awareness.

" + "smithy.api#documentation": "

A public subnet that Network Firewall uses for the firewall.

" } }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDetails": { + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsDetails" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallRuleGroupDetails": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Capacity": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The ARN of the OpenSearch Service domain.

" + "smithy.api#documentation": "

The maximum number of operating resources that this rule group can use.

" } }, - "AccessPolicies": { + "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

IAM policy document that specifies the access policies for the OpenSearch Service domain.

" + "smithy.api#documentation": "

A description of the rule group.

" } }, - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "RuleGroup": { + "target": "com.amazonaws.securityhub#RuleGroupDetails", "traits": { - "smithy.api#documentation": "

The name of the endpoint.

" + "smithy.api#documentation": "

Details about the rule group.

" } }, - "Id": { + "RuleGroupArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The identifier of the domain.

" + "smithy.api#documentation": "

The ARN of the rule group.

" } }, - "DomainEndpoint": { + "RuleGroupId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The domain endpoint.

" + "smithy.api#documentation": "

The identifier of the rule group.

" } }, - "EngineVersion": { + "RuleGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The version of the domain engine.

" + "smithy.api#documentation": "

The descriptive name of the rule group.

" } }, - "EncryptionAtRestOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails", + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + "smithy.api#documentation": "

The type of rule group. A rule group can be stateful or stateless.

" } - }, - "NodeToNodeEncryptionOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails", + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall rule group. Rule groups are used to inspect and control network traffic. Stateless rule groups apply to individual packets. Stateful rule groups apply to packets in the context of their traffic flow.

\n

Rule groups are referenced in firewall policies.\n

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" + "smithy.api#documentation": "

The number of data nodes to use in the OpenSearch domain.

" } }, - "ServiceSoftwareOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails", + "WarmEnabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Information about the status of a domain relative to the latest service software.

" + "smithy.api#documentation": "

Whether UltraWarm is enabled.

" } }, - "ClusterConfig": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails", + "WarmCount": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Details about the configuration of an OpenSearch cluster.

" + "smithy.api#documentation": "

The number of UltraWarm instances.

" + } + }, + "DedicatedMasterEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.

" + } + }, + "ZoneAwarenessConfig": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails", + "traits": { + "smithy.api#documentation": "

Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.

" + } + }, + "DedicatedMasterCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type for your data nodes.

" + } + }, + "WarmType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of UltraWarm instance.

" + } + }, + "ZoneAwarenessEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.

" + } + }, + "DedicatedMasterType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hardware configuration of the computer that hosts the dedicated master node.

\n

If this attribute is specified, then DedicatedMasterEnabled must be true.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the configuration of an OpenSearch cluster.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails": { + "type": "structure", + "members": { + "AvailabilityZoneCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for zone awareness.

" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the OpenSearch Service domain.

" + } + }, + "AccessPolicies": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

IAM policy document that specifies the access policies for the OpenSearch Service domain.

" + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the endpoint.

" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the domain.

" + } + }, + "DomainEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The domain endpoint.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the domain engine.

" + } + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails", + "traits": { + "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + } + }, + "NodeToNodeEncryptionOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails", + "traits": { + "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" + } + }, + "ServiceSoftwareOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails", + "traits": { + "smithy.api#documentation": "

Information about the status of a domain relative to the latest service software.

" + } + }, + "ClusterConfig": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails", + "traits": { + "smithy.api#documentation": "

Details about the configuration of an OpenSearch cluster.

" } }, "DomainEndpointOptions": { @@ -11165,6 +11541,26 @@ "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails" } }, + "com.amazonaws.securityhub#AwsS3BucketBucketVersioningConfiguration": { + "type": "structure", + "members": { + "IsMfaDeleteEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The versioning status of the S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the versioning state of an S3 bucket.

" + } + }, "com.amazonaws.securityhub#AwsS3BucketDetails": { "type": "structure", "members": { @@ -11233,6 +11629,12 @@ "traits": { "smithy.api#documentation": "

The notification configuration for the S3 bucket.

" } + }, + "BucketVersioningConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketVersioningConfiguration", + "traits": { + "smithy.api#documentation": "

The versioning state of an S3 bucket.

" + } } }, "traits": { @@ -12431,7 +12833,7 @@ "WorkflowStatus": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

The status of the investigation into a finding. Allowed values are the following.

\n
    \n
  • \n

    \n NEW - The initial state of a finding, before it is reviewed.

    \n

    Security Hub also resets the workflow status from NOTIFIED or\n RESOLVED to NEW in the following cases:

    \n
      \n
    • \n

      The record state changes from ARCHIVED to ACTIVE.

      \n
    • \n
    • \n

      The compliance status changes from PASSED to either WARNING,\n FAILED, or NOT_AVAILABLE.

      \n
    • \n
    \n
  • \n
  • \n

    \n NOTIFIED - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.

    \n
  • \n
  • \n

    \n SUPPRESSED - The finding will not be reviewed again and will not be\n acted upon.

    \n
  • \n
  • \n

    \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

    \n
  • \n
" + "smithy.api#documentation": "

The status of the investigation into a finding. Allowed values are the following.

\n
    \n
  • \n

    \n NEW - The initial state of a finding, before it is reviewed.

    \n

    Security Hub also resets the workflow status from NOTIFIED or\n RESOLVED to NEW in the following cases:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to ACTIVE.

      \n
    • \n
    • \n

      \n Compliance.Status changes from PASSED to either WARNING,\n FAILED, or NOT_AVAILABLE.

      \n
    • \n
    \n
  • \n
  • \n

    \n NOTIFIED - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.

    \n

    If one of the following occurs, the workflow status is changed automatically from\n NOTIFIED to NEW:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to\n ACTIVE.

      \n
    • \n
    • \n

      \n Compliance.Status changes from PASSED to FAILED,\n WARNING, or NOT_AVAILABLE.

      \n
    • \n
    \n
  • \n
  • \n

    \n SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is\n needed.

    \n

    The workflow status of a SUPPRESSED finding does not change if\n RecordState changes from ARCHIVED to\n ACTIVE.

    \n
  • \n
  • \n

    \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

    \n

    The finding remains RESOLVED unless one of the following occurs:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to\n ACTIVE.

      \n
    • \n
    • \n

      \n Compliance.Status changes from PASSED to FAILED,\n WARNING, or NOT_AVAILABLE.

      \n
    • \n
    \n

    In those cases, the workflow status is automatically reset to NEW.

    \n

    For findings from controls, if Compliance.Status is PASSED,\n then Security Hub automatically sets the workflow status to RESOLVED.

    \n
  • \n
" } }, "RecordState": { @@ -13185,7 +13587,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports security findings generated from an integrated product into Security Hub.\n This action is requested by the integrated product to import its findings into\n Security Hub.

\n

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.

\n

After a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.

\n
    \n
  • \n

    \n Note\n

    \n
  • \n
  • \n

    \n UserDefinedFields\n

    \n
  • \n
  • \n

    \n VerificationState\n

    \n
  • \n
  • \n

    \n Workflow\n

    \n
  • \n
\n

Finding providers also should not use BatchImportFindings to update the following attributes.

\n
    \n
  • \n

    \n Confidence\n

    \n
  • \n
  • \n

    \n Criticality\n

    \n
  • \n
  • \n

    \n RelatedFindings\n

    \n
  • \n
  • \n

    \n Severity\n

    \n
  • \n
  • \n

    \n Types\n

    \n
  • \n
\n

Instead, finding providers use FindingProviderFields to provide values for these attributes.

", + "smithy.api#documentation": "

Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.

\n

\n BatchImportFindings must be called by one of the following:

\n
    \n
  • \n

    The account that is associated with the findings. The identifier of the associated\n account is the value of the AwsAccountId attribute for the finding.

    \n
  • \n
  • \n

    An account that is allow-listed for an official Security Hub partner integration.

    \n
  • \n
\n

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.

\n

After a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.

\n
    \n
  • \n

    \n Note\n

    \n
  • \n
  • \n

    \n UserDefinedFields\n

    \n
  • \n
  • \n

    \n VerificationState\n

    \n
  • \n
  • \n

    \n Workflow\n

    \n
  • \n
\n

Finding providers also should not use BatchImportFindings to update the following attributes.

\n
    \n
  • \n

    \n Confidence\n

    \n
  • \n
  • \n

    \n Criticality\n

    \n
  • \n
  • \n

    \n RelatedFindings\n

    \n
  • \n
  • \n

    \n Severity\n

    \n
  • \n
  • \n

    \n Types\n

    \n
  • \n
\n

Instead, finding providers use FindingProviderFields to provide values for these attributes.

", "smithy.api#http": { "method": "POST", "uri": "/findings/import", @@ -13914,7 +14316,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.

\n

\n CreateMembers is always used to add accounts that are not organization\n members.

\n

For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:

\n
    \n
  • \n

    Security Hub is not configured to automatically add new organization accounts.

    \n
  • \n
  • \n

    The account was disassociated or deleted in Security Hub.

    \n
  • \n
\n

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.

\n

For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.

\n

Accounts that are managed using Organizations do not receive an invitation. They\n automatically become a member account in Security Hub.

\n
    \n
  • \n

    If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

    \n
  • \n
  • \n

    For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

    \n
  • \n
\n \n

A permissions policy is added that permits the administrator account to view the findings\n generated in the member account.

\n

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

", + "smithy.api#documentation": "

Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.

\n

\n CreateMembers is always used to add accounts that are not organization\n members.

\n

For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:

\n
    \n
  • \n

    Security Hub is not configured to automatically add new organization accounts.

    \n
  • \n
  • \n

    The account was disassociated or deleted in Security Hub.

    \n
  • \n
\n

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.

\n

For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.

\n

Accounts that are managed using Organizations do not receive an invitation. They\n automatically become a member account in Security Hub.

\n
    \n
  • \n

    If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

    \n
  • \n
  • \n

    For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

    \n
  • \n
\n

A permissions policy is added that permits the administrator account to view the findings\n generated in the member account.

\n

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

", "smithy.api#http": { "method": "POST", "uri": "/members", @@ -15452,6 +15854,116 @@ "smithy.api#documentation": "

The severity assigned to the finding by the finding provider.

" } }, + "com.amazonaws.securityhub#FirewallPolicyDetails": { + "type": "structure", + "members": { + "StatefulRuleGroupReferences": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesList", + "traits": { + "smithy.api#documentation": "

The stateful rule groups that are used in the firewall policy.

" + } + }, + "StatelessCustomActions": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsList", + "traits": { + "smithy.api#documentation": "

The custom action definitions that are available to use in the firewall policy's StatelessDefaultActions setting.

" + } + }, + "StatelessDefaultActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The actions to take on a packet if it doesn't match any of the stateless rules in the policy.

\n

You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.\n

" + } + }, + "StatelessFragmentDefaultActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.

\n

You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.\n

" + } + }, + "StatelessRuleGroupReferences": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesList", + "traits": { + "smithy.api#documentation": "

The stateless rule groups that are used in the firewall policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the behavior of the firewall.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesDetails": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the stateful rule group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A stateful rule group that is used by the firewall policy.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesDetails" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsDetails": { + "type": "structure", + "members": { + "ActionDefinition": { + "target": "com.amazonaws.securityhub#StatelessCustomActionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the custom action.

" + } + }, + "ActionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the custom action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom action that can be used for stateless packet handling.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsDetails" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The order in which to run the stateless rule group.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the stateless rule group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A stateless rule group that is used by the firewall policy.

" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails" + } + }, "com.amazonaws.securityhub#GeoLocation": { "type": "structure", "members": { @@ -18477,6 +18989,24 @@ "traits": { "smithy.api#documentation": "

Details about an Amazon EKS cluster.

" } + }, + "AwsNetworkFirewallFirewallPolicy": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallPolicyDetails", + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall firewall policy.

" + } + }, + "AwsNetworkFirewallFirewall": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails", + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall firewall.

" + } + }, + "AwsNetworkFirewallRuleGroup": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallRuleGroupDetails", + "traits": { + "smithy.api#documentation": "

Details about an Network Firewall rule group.

" + } } }, "traits": { @@ -18531,21 +19061,530 @@ "target": "com.amazonaws.securityhub#Result" } }, - "com.amazonaws.securityhub#SecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" + "com.amazonaws.securityhub#RuleGroupDetails": { + "type": "structure", + "members": { + "RuleVariables": { + "target": "com.amazonaws.securityhub#RuleGroupVariables", + "traits": { + "smithy.api#documentation": "

Additional settings to use in the specified rules.

" + } + }, + "RulesSource": { + "target": "com.amazonaws.securityhub#RuleGroupSource", + "traits": { + "smithy.api#documentation": "

The rules and actions for the rule group.

\n

For stateful rule groups, can contain RulesString, RulesSourceList, or StatefulRules.

\n

For stateless rule groups, contains StatelessRulesAndCustomActions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the rule group.

" } }, - "com.amazonaws.securityhub#SecurityHubAPIService": { - "type": "service", - "version": "2018-10-26", - "operations": [ - { - "target": "com.amazonaws.securityhub#AcceptAdministratorInvitation" + "com.amazonaws.securityhub#RuleGroupSource": { + "type": "structure", + "members": { + "RulesSourceList": { + "target": "com.amazonaws.securityhub#RuleGroupSourceListDetails", + "traits": { + "smithy.api#documentation": "

Stateful inspection criteria for a domain list rule group. A domain list rule group determines access by specific protocols to specific domains.

" + } }, - { - "target": "com.amazonaws.securityhub#AcceptInvitation" + "RulesString": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.

" + } + }, + "StatefulRules": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesList", + "traits": { + "smithy.api#documentation": "

Suricata rule specifications.

" + } + }, + "StatelessRulesAndCustomActions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesAndCustomActionsDetails", + "traits": { + "smithy.api#documentation": "

The stateless rules and custom actions used by a stateless rule group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The rules and actions for the rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceCustomActionsDetails": { + "type": "structure", + "members": { + "ActionDefinition": { + "target": "com.amazonaws.securityhub#StatelessCustomActionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a custom action.

" + } + }, + "ActionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name of the custom action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom action definition. A custom action is an optional, non-standard action to use for stateless packet handling.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceCustomActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceCustomActionsDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceListDetails": { + "type": "structure", + "members": { + "GeneratedRulesType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether to allow or deny access to the domains listed in Targets.

" + } + }, + "TargetTypes": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The protocols that you want to inspect. Specify LS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.

" + } + }, + "Targets": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The domains that you want to inspect for in your traffic flows. You can provide full domain names, or use the '.' prefix as a wildcard. For example, .example.com matches all domains that end with example.com.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Stateful inspection criteria for a domain list rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.

" + } + }, + "Header": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesHeaderDetails", + "traits": { + "smithy.api#documentation": "

The stateful inspection criteria for the rule.

" + } + }, + "RuleOptions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsList", + "traits": { + "smithy.api#documentation": "

Additional options for the rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A Suricata rule specification.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesHeaderDetails": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

" + } + }, + "DestinationPort": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.

" + } + }, + "Direction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol to inspect for. To inspector for all protocols, use IP.

" + } + }, + "Source": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.

" + } + }, + "SourcePort": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The inspection criteria for a stateful rule.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsDetails": { + "type": "structure", + "members": { + "Keyword": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A keyword to look for.

" + } + }, + "Settings": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesRuleOptionsSettingsList", + "traits": { + "smithy.api#documentation": "

A list of settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule option for a stateful rule.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesRuleOptionsSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleDefinition": { + "type": "structure", + "members": { + "Actions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action (aws:pass, aws:drop, or aws:forward_to_sfe). You can then add custom actions.

" + } + }, + "MatchAttributes": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributes", + "traits": { + "smithy.api#documentation": "

The criteria for Network Firewall to use to inspect an individual packet in a stateless rule inspection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of the stateless rule.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributes": { + "type": "structure", + "members": { + "DestinationPorts": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList", + "traits": { + "smithy.api#documentation": "

A list of port ranges to specify the destination ports to inspect for.

" + } + }, + "Destinations": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationsList", + "traits": { + "smithy.api#documentation": "

The destination IP addresses and address ranges to inspect for, in CIDR notation.

" + } + }, + "Protocols": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesProtocolsList", + "traits": { + "smithy.api#documentation": "

The protocols to inspect for.

" + } + }, + "SourcePorts": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList", + "traits": { + "smithy.api#documentation": "

A list of port ranges to specify the source ports to inspect for.

" + } + }, + "Sources": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcesList", + "traits": { + "smithy.api#documentation": "

The source IP addresses and address ranges to inspect for, in CIDR notation.

" + } + }, + "TcpFlags": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList", + "traits": { + "smithy.api#documentation": "

The TCP flags and masks to inspect for.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Criteria for the stateless rule.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The starting port value for the port range.

" + } + }, + "ToPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The ending port value for the port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A port range to specify the destination ports to inspect for.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinations": { + "type": "structure", + "members": { + "AddressDefinition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An IP address or a block of IP addresses.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A destination IP address or range.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinations" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesProtocolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Integer" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePorts": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The starting port value for the port range.

" + } + }, + "ToPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The ending port value for the port range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A port range to specify the source ports to inspect for.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePorts" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSources": { + "type": "structure", + "members": { + "AddressDefinition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An IP address or a block of IP addresses.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A source IP addresses and address range to inspect for.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSources" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlags": { + "type": "structure", + "members": { + "Flags": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

Defines the flags from the Masks setting that must be set in order for the packet to match. Flags that are listed must be set. Flags that are not listed must not be set.

" + } + }, + "Masks": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The set of flags to consider in the inspection. If not specified, then all flags are inspected.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of TCP flags and masks to inspect for.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlags" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesAndCustomActionsDetails": { + "type": "structure", + "members": { + "CustomActions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceCustomActionsList", + "traits": { + "smithy.api#documentation": "

Custom actions for the rule group.

" + } + }, + "StatelessRules": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesList", + "traits": { + "smithy.api#documentation": "

Stateless rules for the rule group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Stateless rules and custom actions for a stateless rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesDetails": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.

" + } + }, + "RuleDefinition": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleDefinition", + "traits": { + "smithy.api#documentation": "

Provides the definition of the stateless rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A stateless rule in the rule group.

" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupVariables": { + "type": "structure", + "members": { + "IpSets": { + "target": "com.amazonaws.securityhub#RuleGroupVariablesIpSetsDetails", + "traits": { + "smithy.api#documentation": "

A list of IP addresses and address ranges, in CIDR notation.

" + } + }, + "PortSets": { + "target": "com.amazonaws.securityhub#RuleGroupVariablesPortSetsDetails", + "traits": { + "smithy.api#documentation": "

A list of port ranges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional settings to use in the specified rules.

" + } + }, + "com.amazonaws.securityhub#RuleGroupVariablesIpSetsDetails": { + "type": "structure", + "members": { + "Definition": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of IP addresses and ranges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of IP addresses and address ranges, in CIDR notation.

" + } + }, + "com.amazonaws.securityhub#RuleGroupVariablesPortSetsDetails": { + "type": "structure", + "members": { + "Definition": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of port ranges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of port ranges.

" + } + }, + "com.amazonaws.securityhub#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#SecurityHubAPIService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "SecurityHub", + "arnNamespace": "securityhub", + "cloudFormationName": "SecurityHub", + "cloudTrailEventSource": "securityhub.amazonaws.com", + "endpointPrefix": "securityhub" + }, + "aws.auth#sigv4": { + "name": "securityhub" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the Security HubUser\n Guide\n .

\n

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

\n

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

\n
    \n
  • \n

    \n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.

    \n
  • \n
  • \n

    \n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.

    \n
  • \n
  • \n

    \n UpdateFindings - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.

    \n
  • \n
  • \n

    \n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.

    \n
  • \n
  • \n

    All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
  • \n
", + "smithy.api#title": "AWS SecurityHub" + }, + "version": "2018-10-26", + "operations": [ + { + "target": "com.amazonaws.securityhub#AcceptAdministratorInvitation" + }, + { + "target": "com.amazonaws.securityhub#AcceptInvitation" }, { "target": "com.amazonaws.securityhub#BatchDisableStandards" @@ -18709,22 +19748,7 @@ { "target": "com.amazonaws.securityhub#UpdateStandardsControl" } - ], - "traits": { - "aws.api#service": { - "sdkId": "SecurityHub", - "arnNamespace": "securityhub", - "cloudFormationName": "SecurityHub", - "cloudTrailEventSource": "securityhub.amazonaws.com", - "endpointPrefix": "securityhub" - }, - "aws.auth#sigv4": { - "name": "securityhub" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the Security HubUser\n Guide\n .

\n

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

\n

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

\n
    \n
  • \n

    \n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.

    \n
  • \n
  • \n

    \n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.

    \n
  • \n
  • \n

    \n UpdateFindings - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.

    \n
  • \n
  • \n

    \n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.

    \n
  • \n
  • \n

    All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
  • \n
", - "smithy.api#title": "AWS SecurityHub" - } + ] }, "com.amazonaws.securityhub#SensitiveDataDetections": { "type": "structure", @@ -19146,6 +20170,21 @@ ] } }, + "com.amazonaws.securityhub#StandardsStatusReason": { + "type": "structure", + "members": { + "StatusReasonCode": { + "target": "com.amazonaws.securityhub#StatusReasonCode", + "traits": { + "smithy.api#documentation": "

The reason code that represents the reason for the current status of a standard subscription.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The reason for the current status of a standard subscription.

" + } + }, "com.amazonaws.securityhub#StandardsSubscription": { "type": "structure", "members": { @@ -19176,6 +20215,12 @@ "smithy.api#documentation": "

The status of the standard subscription.

\n

The status values are as follows:

\n
    \n
  • \n

    \n PENDING - Standard is in the process of being enabled.

    \n
  • \n
  • \n

    \n READY - Standard is enabled.

    \n
  • \n
  • \n

    \n INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.

    \n
  • \n
  • \n

    \n DELETING - Standard is in the process of being disabled.

    \n
  • \n
  • \n

    \n FAILED - Standard could not be disabled.

    \n
  • \n
", "smithy.api#required": {} } + }, + "StandardsStatusReason": { + "target": "com.amazonaws.securityhub#StandardsStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the current status.

" + } } }, "traits": { @@ -19233,6 +20278,54 @@ "target": "com.amazonaws.securityhub#StandardsSubscription" } }, + "com.amazonaws.securityhub#StatelessCustomActionDefinition": { + "type": "structure", + "members": { + "PublishMetricAction": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricAction", + "traits": { + "smithy.api#documentation": "

Information about metrics to publish to CloudWatch.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of a custom action that can be used for stateless packet handling.

" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricAction": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimensionsList", + "traits": { + "smithy.api#documentation": "

Defines CloudWatch dimension values to publish.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about metrics to publish to CloudWatch.

" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimension": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value to use for the custom metric dimension.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a CloudWatch dimension value to publish.

" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimensionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimension" + } + }, "com.amazonaws.securityhub#StatusReason": { "type": "structure", "members": { @@ -19254,6 +20347,21 @@ "smithy.api#documentation": "

Provides additional context for the value of Compliance.Status.

" } }, + "com.amazonaws.securityhub#StatusReasonCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NO_AVAILABLE_CONFIGURATION_RECORDER", + "name": "NO_AVAILABLE_CONFIGURATION_RECORDER" + }, + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + } + ] + } + }, "com.amazonaws.securityhub#StatusReasonsList": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/sms.json b/aws/sdk/aws-models/sms.json index b40f085eda..08398e2bb0 100644 --- a/aws/sdk/aws-models/sms.json +++ b/aws/sdk/aws-models/sms.json @@ -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": "\n

\n Product update\n

\n

As of March 31, 2022, Amazon Web Services will discontinue Server Migration Service (Amazon Web Services SMS).\n Going forward, we recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration\n service for lift-and-shift migrations.

\n

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 When\n to Choose AWS Application Migration Service.

\n
\n \n

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:

\n ", + "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": "AWS Server Migration Service\n

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:

\n ", - "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": "

The name of the service role in the customer's account used by AWS SMS.

" + "smithy.api#documentation": "

The name of the service role in the customer's account used by Server Migration Service.

" } }, "totalServerGroups": { @@ -789,7 +789,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

The name of the service role in the customer's account to be used by AWS SMS.

" + "smithy.api#documentation": "

The name of the service role in the customer's account to be used by Server Migration Service.

" } }, "clientToken": { @@ -873,7 +873,7 @@ } ], "traits": { - "smithy.api#documentation": "

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).

" + "smithy.api#documentation": "

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).

" } }, "com.amazonaws.sms#CreateReplicationJobRequest": { @@ -914,7 +914,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used by the AWS SMS.

" + "smithy.api#documentation": "

The name of the IAM role to be used by the Server Migration Service.

" } }, "description": { @@ -980,7 +980,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.sms#DeleteAppLaunchConfiguration": { @@ -1169,7 +1169,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified replication job.

\n

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.

" + "smithy.api#documentation": "

Deletes the specified replication job.

\n

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.

" } }, "com.amazonaws.sms#DeleteReplicationJobRequest": { @@ -1248,7 +1248,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates the specified connector from AWS SMS.

\n

After you disassociate a connector, it is no longer available to support\n replication jobs.

" + "smithy.api#documentation": "

Disassociates the specified connector from Server Migration Service.

\n

After you disassociate a connector, it is no longer available to support\n replication jobs.

" } }, "com.amazonaws.sms#DisassociateConnectorRequest": { @@ -1275,6 +1275,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DryRunOperationException", + "httpResponseCode": 412 + }, "smithy.api#documentation": "

The user has the required permissions, so the request would have succeeded, \n but a dry run was performed.

", "smithy.api#error": "client", "smithy.api#httpError": 412 @@ -1402,7 +1406,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.sms#GenerateTemplateRequest": { @@ -1411,13 +1415,13 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "

The ID of the application associated with the AWS CloudFormation template.

" + "smithy.api#documentation": "

The ID of the application associated with the CloudFormation template.

" } }, "templateFormat": { "target": "com.amazonaws.sms#OutputFormat", "traits": { - "smithy.api#documentation": "

The format for generating the AWS CloudFormation template.

" + "smithy.api#documentation": "

The format for generating the CloudFormation template.

" } } } @@ -1514,7 +1518,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

The name of the service role in the customer's account that AWS CloudFormation uses to launch the\n application.

" + "smithy.api#documentation": "

The name of the service role in the customer's account that CloudFormation uses to launch the\n application.

" } }, "autoLaunch": { @@ -1740,7 +1744,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the connectors registered with the AWS SMS.

", + "smithy.api#documentation": "

Describes the connectors registered with the Server Migration Service.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2038,7 +2042,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows application import from AWS Migration Hub.

" + "smithy.api#documentation": "

Allows application import from Migration Hub.

" } }, "com.amazonaws.sms#ImportAppCatalogRequest": { @@ -2047,7 +2051,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

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 policy\n and trust policy described in the AWS Migration Hub User Guide.

" + "smithy.api#documentation": "

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 policy\n and trust policy described in the Migration Hub User Guide.

" } } } @@ -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": "

An internal error occurred.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -2126,6 +2134,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameter", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A specified parameter is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2163,7 +2175,7 @@ } ], "traits": { - "smithy.api#documentation": "

Launches the specified application as a stack in AWS CloudFormation.

" + "smithy.api#documentation": "

Launches the specified application as a stack in CloudFormation.

" } }, "com.amazonaws.sms#LaunchAppRequest": { @@ -2317,6 +2329,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "MissingRequiredParameter", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A required parameter is missing.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2333,6 +2349,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NoConnectorsAvailable", + "httpResponseCode": 430 + }, "smithy.api#documentation": "

There are no connectors available.

", "smithy.api#error": "client", "smithy.api#httpError": 430 @@ -2400,7 +2420,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information to AWS SMS about whether application validation is successful.

" + "smithy.api#documentation": "

Provides information to Server Migration Service about whether application validation is successful.

" } }, "com.amazonaws.sms#NotifyAppValidationOutputRequest": { @@ -2439,6 +2459,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationNotPermitted", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

This operation is not allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -2500,7 +2524,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

The name of service role in the customer's account that AWS CloudFormation uses to launch the\n application.

" + "smithy.api#documentation": "

The name of service role in the customer's account that CloudFormation uses to launch the\n application.

" } }, "autoLaunch": { @@ -2688,7 +2712,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used by AWS SMS.

" + "smithy.api#documentation": "

The name of the IAM role to be used by Server Migration Service.

" } }, "latestAmiId": { @@ -2752,6 +2776,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationJobAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified replication job already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2777,6 +2805,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationJobNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified replication job does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2915,6 +2947,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationRunLimitExceeded", + "httpResponseCode": 429 + }, "smithy.api#documentation": "

You have exceeded the number of on-demand replication runs you can request in a\n 24-hour period.

", "smithy.api#error": "client", "smithy.api#httpError": 429 @@ -3090,7 +3126,7 @@ "command": { "target": "com.amazonaws.sms#Command", "traits": { - "smithy.api#documentation": "

The command to run the validation script

" + "smithy.api#documentation": "

The command to run the validation script.

" } }, "executionTimeoutSeconds": { @@ -3174,6 +3210,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ServerCannotBeReplicated", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified server cannot be replicated.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3343,7 +3383,7 @@ "logicalId": { "target": "com.amazonaws.sms#LogicalId", "traits": { - "smithy.api#documentation": "

The logical ID of the server in the AWS CloudFormation template.

" + "smithy.api#documentation": "

The logical ID of the server in the CloudFormation template.

" } }, "vpc": { @@ -3829,6 +3869,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "TemporarilyUnavailable", + "httpResponseCode": 503 + }, "smithy.api#documentation": "

The service is temporarily unavailable.

", "smithy.api#error": "server", "smithy.api#httpError": 503 @@ -3901,6 +3945,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnauthorizedOperation", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

You lack permissions needed to perform this operation. Check your IAM policies,\n and ensure that you are using the correct access keys.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -3959,7 +4007,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

The name of the service role in the customer's account used by AWS SMS.

" + "smithy.api#documentation": "

The name of the service role in the customer's account used by Server Migration Service.

" } }, "serverGroups": { @@ -4068,7 +4116,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used by AWS SMS.

" + "smithy.api#documentation": "

The name of the IAM role to be used by Server Migration Service.

" } }, "description": { diff --git a/aws/sdk/aws-models/snowball.json b/aws/sdk/aws-models/snowball.json index 1e6bb0902c..f5167b978c 100644 --- a/aws/sdk/aws-models/snowball.json +++ b/aws/sdk/aws-models/snowball.json @@ -539,7 +539,10 @@ "type": "structure", "members": { "ConflictResource": { - "target": "com.amazonaws.snowball#String" + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "

You get this resource when you call CreateReturnShippingLabel more than once when other requests are not completed. .

" + } }, "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": { diff --git a/aws/sdk/aws-models/support.json b/aws/sdk/aws-models/support.json index e7247112f4..00cd9b6fac 100644 --- a/aws/sdk/aws-models/support.json +++ b/aws/sdk/aws-models/support.json @@ -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": "Amazon Web Services Support\n

The Amazon Web Services Support API Reference 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.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
\n

The Amazon Web Services Support service also exposes a set of Trusted Advisor 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.

\n

The following list describes the Amazon Web Services Support case management operations:

\n \n

The following list describes the operations available from the Amazon Web Services Support service for\n Trusted Advisor:

\n \n

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing\n Process.

\n

See About the\n Amazon Web Services Support API in the Amazon Web Services Support User Guide 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.

", + "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": "AWS Support\n

The AWS Support API Reference 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.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
\n

The AWS Support service also exposes a set of AWS Trusted Advisor 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.

\n

The following list describes the AWS Support case management operations:

\n \n

The following list describes the operations available from the AWS Support service for\n Trusted Advisor:

\n \n

For authentication of requests, AWS Support uses Signature Version 4 Signing\n Process.

\n

See About the\n AWS Support API in the AWS Support User Guide 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.

", - "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": "

Adds one or more attachments to an attachment set.

\n

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 expiryTime returned in the response is when the set expires.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

Adds one or more attachments to an attachment set.

\n

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 expiryTime returned in the response is when the set expires.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#AddAttachmentsToSetRequest": { @@ -185,7 +185,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds additional customer communication to an AWS Support case. Use the caseId\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 ccEmailAddresses\n parameter. The communicationBody value contains the text of the\n communication.

\n \n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

Adds additional customer communication to an Amazon Web Services Support case. Use the caseId\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 ccEmailAddresses\n parameter. The communicationBody value contains the text of the\n communication.

\n \n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#AddCommunicationToCaseRequest": { @@ -401,13 +401,13 @@ "displayId": { "target": "com.amazonaws.support#DisplayId", "traits": { - "smithy.api#documentation": "

The ID displayed for the case in the AWS Support Center. This is a numeric\n string.

" + "smithy.api#documentation": "

The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric\n string.

" } }, "subject": { "target": "com.amazonaws.support#Subject", "traits": { - "smithy.api#documentation": "

The subject line for the case in the AWS Support Center.

" + "smithy.api#documentation": "

The subject line for the case in the Amazon Web Services Support Center.

" } }, "status": { @@ -419,7 +419,7 @@ "serviceCode": { "target": "com.amazonaws.support#ServiceCode", "traits": { - "smithy.api#documentation": "

The code for the AWS service. You can get a list of codes and the corresponding\n service names by calling DescribeServices.

" + "smithy.api#documentation": "

The code for the Amazon Web Services service. You can get a list of codes and the corresponding\n service names by calling DescribeServices.

" } }, "categoryCode": { @@ -443,13 +443,13 @@ "timeCreated": { "target": "com.amazonaws.support#TimeCreated", "traits": { - "smithy.api#documentation": "

The time that the case was created in the AWS Support Center.

" + "smithy.api#documentation": "

The time that the case was created in the Amazon Web Services Support Center.

" } }, "recentCommunications": { "target": "com.amazonaws.support#RecentCaseCommunications", "traits": { - "smithy.api#documentation": "

The five most recent communications between you and AWS Support Center, including the\n IDs of any attachments to the communications. Also includes a nextToken\n that you can use to retrieve earlier communications.

" + "smithy.api#documentation": "

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 nextToken\n that you can use to retrieve earlier communications.

" } }, "ccEmailAddresses": { @@ -461,12 +461,12 @@ "language": { "target": "com.amazonaws.support#Language", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } }, "traits": { - "smithy.api#documentation": "

A JSON-formatted object that contains the metadata for a support case. It is contained\n in the response from a DescribeCases request. CaseDetails contains the following fields:

\n
    \n
  • \n

    \n caseId - 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-12345678910-2013-c4c1d2bf33c5cf47.

    \n
  • \n
  • \n

    \n categoryCode - The category of problem for the\n support case. Corresponds to the CategoryCode values returned by a call to\n DescribeServices.

    \n
  • \n
  • \n

    \n displayId - The identifier for the case on pages\n in the AWS Support Center.

    \n
  • \n
  • \n

    \n language - 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.

    \n
  • \n
  • \n

    \n nextToken - A resumption point for\n pagination.

    \n
  • \n
  • \n

    \n recentCommunications - One or more Communication objects. Fields of these objects are\n attachments, body, caseId,\n submittedBy, and timeCreated.

    \n
  • \n
  • \n

    \n serviceCode - The identifier for the AWS service\n that corresponds to the service code defined in the call to DescribeServices.

    \n
  • \n
  • \n

    \n severityCode - The severity code assigned to the\n case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are:\n low, normal, high,\n urgent, and critical.

    \n
  • \n
  • \n

    \n status - The status of the case in the AWS Support Center. Valid values:

    \n
      \n
    • \n

      \n opened\n

      \n
    • \n
    • \n

      \n pending-customer-action\n

      \n
    • \n
    • \n

      \n reopened\n

      \n
    • \n
    • \n

      \n resolved\n

      \n
    • \n
    • \n

      \n unassigned\n

      \n
    • \n
    • \n

      \n work-in-progress\n

      \n
    • \n
    \n
  • \n
  • \n

    \n subject - The subject line of the case.

    \n
  • \n
  • \n

    \n submittedBy - The email address of the account\n that submitted the case.

    \n
  • \n
  • \n

    \n timeCreated - The time the case was created, in\n ISO-8601 format.

    \n
  • \n
" + "smithy.api#documentation": "

A JSON-formatted object that contains the metadata for a support case. It is contained\n in the response from a DescribeCases request. CaseDetails contains the following fields:

\n
    \n
  • \n

    \n caseId - 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-12345678910-2013-c4c1d2bf33c5cf47.

    \n
  • \n
  • \n

    \n categoryCode - The category of problem for the\n support case. Corresponds to the CategoryCode values returned by a call to\n DescribeServices.

    \n
  • \n
  • \n

    \n displayId - The identifier for the case on pages\n in the Amazon Web Services Support Center.

    \n
  • \n
  • \n

    \n language - 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.

    \n
  • \n
  • \n

    \n nextToken - A resumption point for\n pagination.

    \n
  • \n
  • \n

    \n recentCommunications - One or more Communication objects. Fields of these objects are\n attachments, body, caseId,\n submittedBy, and timeCreated.

    \n
  • \n
  • \n

    \n serviceCode - The identifier for the Amazon Web Services service\n that corresponds to the service code defined in the call to DescribeServices.

    \n
  • \n
  • \n

    \n severityCode - The severity code assigned to the\n case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are:\n low, normal, high,\n urgent, and critical.

    \n
  • \n
  • \n

    \n status - The status of the case in the Amazon Web Services Support Center. Valid values:

    \n
      \n
    • \n

      \n opened\n

      \n
    • \n
    • \n

      \n pending-customer-action\n

      \n
    • \n
    • \n

      \n reopened\n

      \n
    • \n
    • \n

      \n resolved\n

      \n
    • \n
    • \n

      \n unassigned\n

      \n
    • \n
    • \n

      \n work-in-progress\n

      \n
    • \n
    \n
  • \n
  • \n

    \n subject - The subject line of the case.

    \n
  • \n
  • \n

    \n submittedBy - The email address of the account\n that submitted the case.

    \n
  • \n
  • \n

    \n timeCreated - The time the case was created, in\n ISO-8601 format.

    \n
  • \n
" } }, "com.amazonaws.support#CaseId": { @@ -525,7 +525,7 @@ } }, "traits": { - "smithy.api#documentation": "

A JSON-formatted name/value pair that represents the category name and category code\n of the problem, selected from the DescribeServices response for each\n AWS service.

" + "smithy.api#documentation": "

A JSON-formatted name/value pair that represents the category name and category code\n of the problem, selected from the DescribeServices response for each\n Amazon Web Services service.

" } }, "com.amazonaws.support#CategoryCode": { @@ -561,13 +561,13 @@ "body": { "target": "com.amazonaws.support#CommunicationBody", "traits": { - "smithy.api#documentation": "

The text of the communication between the customer and AWS Support.

" + "smithy.api#documentation": "

The text of the communication between the customer and Amazon Web Services Support.

" } }, "submittedBy": { "target": "com.amazonaws.support#SubmittedBy", "traits": { - "smithy.api#documentation": "

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) . Entries from the AWS Support team display\n \"Amazon Web Services,\" and don't show an email address.\n

" + "smithy.api#documentation": "

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) . Entries from the Amazon Web Services Support team display\n \"Amazon Web Services,\" and don't show an email address.\n

" } }, "timeCreated": { @@ -619,7 +619,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a case in the AWS Support Center. This operation is similar to how you create a case\n in the AWS Support Center Create\n Case page.

\n

The AWS Support API doesn't support requesting service limit increases. You can submit a\n service limit increase in the following ways:

\n \n

A successful CreateCase request returns an AWS Support case number. You can use\n the DescribeCases operation and specify the case number to get\n existing AWS Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or\n attachments to an existing case.

\n

The caseId is separate from the displayId that appears in\n the AWS Support Center. Use the DescribeCases operation to get the displayId.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

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 Create\n Case page.

\n

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:

\n \n

A successful CreateCase request returns an Amazon Web Services Support case number. You can use\n the DescribeCases operation and specify the case number to get\n existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or\n attachments to an existing case.

\n

The caseId is separate from the displayId that appears in\n the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#CreateCaseRequest": { @@ -628,45 +628,45 @@ "subject": { "target": "com.amazonaws.support#Subject", "traits": { - "smithy.api#documentation": "

The title of the support case. The title appears in the Subject field on the AWS Support Center Create Case page.

", + "smithy.api#documentation": "

The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

", "smithy.api#required": {} } }, "serviceCode": { "target": "com.amazonaws.support#ServiceCode", "traits": { - "smithy.api#documentation": "

The code for the AWS service. You can use the DescribeServices\n operation to get the possible serviceCode values.

" + "smithy.api#documentation": "

The code for the Amazon Web Services service. You can use the DescribeServices\n operation to get the possible serviceCode values.

" } }, "severityCode": { "target": "com.amazonaws.support#SeverityCode", "traits": { - "smithy.api#documentation": "

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 DescribeSeverityLevels operation to get the possible values for\n severityCode.

\n

For more information, see SeverityLevel and Choosing a\n Severity in the AWS Support User Guide.

\n \n

The availability of severity levels depends on the support plan for the AWS\n account.

\n
" + "smithy.api#documentation": "

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 DescribeSeverityLevels operation to get the possible values for\n severityCode.

\n

For more information, see SeverityLevel and Choosing a\n Severity in the Amazon Web Services Support User Guide.

\n \n

The availability of severity levels depends on the support plan for the\n Amazon Web Services account.

\n
" } }, "categoryCode": { "target": "com.amazonaws.support#CategoryCode", "traits": { - "smithy.api#documentation": "

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each\n AWS service defines its own set of category codes.

" + "smithy.api#documentation": "

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each\n Amazon Web Services service defines its own set of category codes.

" } }, "communicationBody": { "target": "com.amazonaws.support#CommunicationBody", "traits": { - "smithy.api#documentation": "

The communication body text that describes the issue. This text appears in the\n Description field on the AWS Support Center Create Case page.

", + "smithy.api#documentation": "

The communication body text that describes the issue. This text appears in the\n Description field on the Amazon Web Services Support Center Create Case page.

", "smithy.api#required": {} } }, "ccEmailAddresses": { "target": "com.amazonaws.support#CcEmailAddressList", "traits": { - "smithy.api#documentation": "

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 AWS SDKs.\n

" + "smithy.api#documentation": "

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 Amazon Web Services SDKs.\n

" } }, "language": { "target": "com.amazonaws.support#Language", "traits": { - "smithy.api#documentation": "

The language in which AWS Support handles the case. You must specify the ISO 639-1\n code for the language parameter if you want support in that language.\n Currently, English (\"en\") and Japanese (\"ja\") are supported.

" + "smithy.api#documentation": "

The language in which Amazon Web Services Support handles the case. You must specify the ISO 639-1\n code for the language parameter if you want support in that language.\n Currently, English (\"en\") and Japanese (\"ja\") are supported.

" } }, "issueType": { @@ -720,7 +720,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 AttachmentDetails objects that are\n returned by the DescribeCommunications operation.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

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 AttachmentDetails objects that are\n returned by the DescribeCommunications operation.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#DescribeAttachmentLimitExceeded": { @@ -781,7 +781,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of cases that you specify by passing one or more case IDs. You can use\n the afterTime and beforeTime parameters to filter the cases by\n date. You can set values for the includeResolvedCases and\n includeCommunications parameters to specify how much information to\n return.

\n

The response returns the following in JSON format:

\n
    \n
  • \n

    One or more CaseDetails data types.

    \n
  • \n
  • \n

    One or more nextToken values, which specify where to paginate the\n returned records represented by the CaseDetails objects.

    \n
  • \n
\n

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.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
", + "smithy.api#documentation": "

Returns a list of cases that you specify by passing one or more case IDs. You can use\n the afterTime and beforeTime parameters to filter the cases by\n date. You can set values for the includeResolvedCases and\n includeCommunications parameters to specify how much information to\n return.

\n

The response returns the following in JSON format:

\n
    \n
  • \n

    One or more CaseDetails data types.

    \n
  • \n
  • \n

    One or more nextToken values, which specify where to paginate the\n returned records represented by the CaseDetails objects.

    \n
  • \n
\n

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.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -802,7 +802,7 @@ "displayId": { "target": "com.amazonaws.support#DisplayId", "traits": { - "smithy.api#documentation": "

The ID displayed for a case in the AWS Support Center user interface.

" + "smithy.api#documentation": "

The ID displayed for a case in the Amazon Web Services Support Center user interface.

" } }, "afterTime": { @@ -838,7 +838,7 @@ "language": { "target": "com.amazonaws.support#Language", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "includeCommunications": { @@ -886,7 +886,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns communications and attachments for one or more support cases. Use the\n afterTime and beforeTime parameters to filter by date. You\n can use the caseId parameter to restrict the results to a specific\n case.

\n

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.

\n

You can use the maxResults and nextToken parameters to\n control the pagination of the results. Set maxResults to the number of\n cases that you want to display on each page, and use nextToken to specify\n the resumption of pagination.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
", + "smithy.api#documentation": "

Returns communications and attachments for one or more support cases. Use the\n afterTime and beforeTime parameters to filter by date. You\n can use the caseId parameter to restrict the results to a specific\n case.

\n

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.

\n

You can use the maxResults and nextToken parameters to\n control the pagination of the results. Set maxResults to the number of\n cases that you want to display on each page, and use nextToken to specify\n the resumption of pagination.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -965,7 +965,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 CreateCase\n requests. Each AWS service has its own set of categories.

\n

The service codes and category codes correspond to the values that appear in the\n Service and Category lists on the AWS Support Center Create Case page. The values in those fields\n don't necessarily match the service codes and categories returned by the\n DescribeServices operation. Always use the service codes and categories\n that the DescribeServices operation returns, so that you have the most\n recent set of service and category codes.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

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 CreateCase\n requests. Each Amazon Web Services service has its own set of categories.

\n

The service codes and category codes correspond to the values that appear in the\n Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields\n don't necessarily match the service codes and categories returned by the\n DescribeServices operation. Always use the service codes and categories\n that the DescribeServices operation returns, so that you have the most\n recent set of service and category codes.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#DescribeServicesRequest": { @@ -974,13 +974,13 @@ "serviceCodeList": { "target": "com.amazonaws.support#ServiceCodeList", "traits": { - "smithy.api#documentation": "

A JSON-formatted list of service codes available for AWS services.

" + "smithy.api#documentation": "

A JSON-formatted list of service codes available for Amazon Web Services services.

" } }, "language": { "target": "com.amazonaws.support#Language", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } } @@ -991,12 +991,12 @@ "services": { "target": "com.amazonaws.support#ServiceList", "traits": { - "smithy.api#documentation": "

A JSON-formatted list of AWS services.

" + "smithy.api#documentation": "

A JSON-formatted list of Amazon Web Services services.

" } } }, "traits": { - "smithy.api#documentation": "

The list of AWS services returned by the DescribeServices\n operation.

" + "smithy.api#documentation": "

The list of Amazon Web Services services returned by the DescribeServices\n operation.

" } }, "com.amazonaws.support#DescribeSeverityLevels": { @@ -1013,7 +1013,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 CaseDetails data type that you\n include for a CreateCase request.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

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 CaseDetails data type that you\n include for a CreateCase request.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#DescribeSeverityLevelsRequest": { @@ -1022,7 +1022,7 @@ "language": { "target": "com.amazonaws.support#Language", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } } @@ -1033,7 +1033,7 @@ "severityLevels": { "target": "com.amazonaws.support#SeverityLevelsList", "traits": { - "smithy.api#documentation": "

The available severity levels for the support case. Available severity levels are\n defined by your service level agreement with AWS.

" + "smithy.api#documentation": "

The available severity levels for the support case. Available severity levels are\n defined by your service level agreement with Amazon Web Services.

" } } }, @@ -1055,7 +1055,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 DescribeTrustedAdvisorChecks operation.

\n

Some checks are refreshed automatically, and you can't return their refresh statuses\n by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you\n call this operation for these checks, you might see an\n InvalidParameterValue error.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

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 DescribeTrustedAdvisorChecks operation.

\n

Some checks are refreshed automatically, and you can't return their refresh statuses\n by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you\n call this operation for these checks, you might see an\n InvalidParameterValue error.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#DescribeTrustedAdvisorCheckRefreshStatusesRequest": { @@ -1099,7 +1099,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 DescribeTrustedAdvisorChecks\n operation.

\n

The response contains a TrustedAdvisorCheckResult object, which\n contains these three objects:

\n \n

In addition, the response contains these fields:

\n
    \n
  • \n

    \n status - The alert status of the check\n can be ok (green), warning (yellow),\n error (red), or not_available.

    \n
  • \n
  • \n

    \n timestamp - The time of the last refresh\n of the check.

    \n
  • \n
  • \n

    \n checkId - The unique identifier for the\n check.

    \n
  • \n
\n \n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

Returns the results of the Trusted Advisor check that has the specified check ID. You\n can get the check IDs by calling the DescribeTrustedAdvisorChecks\n operation.

\n

The response contains a TrustedAdvisorCheckResult object, which\n contains these three objects:

\n \n

In addition, the response contains these fields:

\n
    \n
  • \n

    \n status - The alert status of the check\n can be ok (green), warning (yellow),\n error (red), or not_available.

    \n
  • \n
  • \n

    \n timestamp - The time of the last refresh\n of the check.

    \n
  • \n
  • \n

    \n checkId - The unique identifier for the\n check.

    \n
  • \n
\n \n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#DescribeTrustedAdvisorCheckResultRequest": { @@ -1115,7 +1115,7 @@ "language": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } }, @@ -1151,7 +1151,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 DescribeTrustedAdvisorChecks operation.

\n

The response contains an array of TrustedAdvisorCheckSummary\n objects.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

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 DescribeTrustedAdvisorChecks operation.

\n

The response contains an array of TrustedAdvisorCheckSummary\n objects.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#DescribeTrustedAdvisorCheckSummariesRequest": { @@ -1195,7 +1195,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 TrustedAdvisorCheckDescription object for each check. You must set the\n AWS Region to us-east-1.

\n \n \n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
  • \n

    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.

    \n
  • \n
\n
" + "smithy.api#documentation": "

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 TrustedAdvisorCheckDescription object for each check. You must set the\n Amazon Web Services Region to us-east-1.

\n \n \n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
  • \n

    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.

    \n
  • \n
\n
" } }, "com.amazonaws.support#DescribeTrustedAdvisorChecksRequest": { @@ -1204,7 +1204,7 @@ "language": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } @@ -1320,7 +1320,7 @@ } ], "traits": { - "smithy.api#documentation": "

Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the\n check IDs by calling the DescribeTrustedAdvisorChecks\n operation.

\n \n

Some checks are refreshed automatically. If you call the\n RefreshTrustedAdvisorCheck operation to refresh them, you might see\n the InvalidParameterValue error.

\n
\n

The response contains a TrustedAdvisorCheckRefreshStatus\n object.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

Refreshes the Trusted Advisor check that you specify using the check ID. You can get the\n check IDs by calling the DescribeTrustedAdvisorChecks\n operation.

\n \n

Some checks are refreshed automatically. If you call the\n RefreshTrustedAdvisorCheck operation to refresh them, you might see\n the InvalidParameterValue error.

\n
\n

The response contains a TrustedAdvisorCheckRefreshStatus\n object.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#RefreshTrustedAdvisorCheckRequest": { @@ -1370,7 +1370,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resolves a support case. This operation takes a caseId and returns the\n initial and final state of the case.

\n \n
    \n
  • \n

    You must have a Business or Enterprise Support plan to use the AWS Support\n API.

    \n
  • \n
  • \n

    If you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.

    \n
  • \n
\n
" + "smithy.api#documentation": "

Resolves a support case. This operation takes a caseId and returns the\n initial and final state of the case.

\n \n
    \n
  • \n

    You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support\n API.

    \n
  • \n
  • \n

    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 SubscriptionRequiredException error message appears. For\n information about changing your support plan, see Amazon Web Services Support.

    \n
  • \n
\n
" } }, "com.amazonaws.support#ResolveCaseRequest": { @@ -1413,30 +1413,30 @@ "code": { "target": "com.amazonaws.support#ServiceCode", "traits": { - "smithy.api#documentation": "

The code for an AWS service returned by the DescribeServices\n response. The name element contains the corresponding friendly name.

" + "smithy.api#documentation": "

The code for an Amazon Web Services service returned by the DescribeServices\n response. The name element contains the corresponding friendly name.

" } }, "name": { "target": "com.amazonaws.support#ServiceName", "traits": { - "smithy.api#documentation": "

The friendly name for an AWS service. The code element contains the\n corresponding code.

" + "smithy.api#documentation": "

The friendly name for an Amazon Web Services service. The code element contains the\n corresponding code.

" } }, "categories": { "target": "com.amazonaws.support#CategoryList", "traits": { - "smithy.api#documentation": "

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 CreateCase.

" + "smithy.api#documentation": "

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 CreateCase.

" } } }, "traits": { - "smithy.api#documentation": "

Information about an AWS service returned by the DescribeServices\n operation.

" + "smithy.api#documentation": "

Information about an Amazon Web Services service returned by the DescribeServices\n operation.

" } }, "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": "

The name of the severity level that corresponds to the severity level code.

\n \n

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 low, but the name\n appears as General guidance in Support Center.

\n

The following are the API code names and how they appear in the console:

\n
    \n
  • \n

    \n low - General guidance

    \n
  • \n
  • \n

    \n normal - System impaired

    \n
  • \n
  • \n

    \n high - Production system impaired

    \n
  • \n
  • \n

    \n urgent - Production system down

    \n
  • \n
  • \n

    \n critical - Business-critical system down

    \n
  • \n
\n
\n

For more information, see Choosing a\n severity in the AWS Support User Guide.

" + "smithy.api#documentation": "

The name of the severity level that corresponds to the severity level code.

\n \n

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 low, but the name\n appears as General guidance in Support Center.

\n

The following are the API code names and how they appear in the console:

\n
    \n
  • \n

    \n low - General guidance

    \n
  • \n
  • \n

    \n normal - System impaired

    \n
  • \n
  • \n

    \n high - Production system impaired

    \n
  • \n
  • \n

    \n urgent - Production system down

    \n
  • \n
  • \n

    \n critical - Business-critical system down

    \n
  • \n
\n
\n

For more information, see Choosing a\n severity in the Amazon Web Services Support User Guide.

" } } }, "traits": { - "smithy.api#documentation": "

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 Choosing a\n severity in the AWS Support User Guide.

" + "smithy.api#documentation": "

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 Choosing a\n severity in the Amazon Web Services Support User Guide.

" } }, "com.amazonaws.support#SeverityLevelCode": { @@ -1752,7 +1752,7 @@ "region": { "target": "com.amazonaws.support#String", "traits": { - "smithy.api#documentation": "

The AWS Region in which the identified resource is located.

" + "smithy.api#documentation": "

The Amazon Web Services Region in which the identified resource is located.

" } }, "resourceId": { @@ -1765,7 +1765,7 @@ "isSuppressed": { "target": "com.amazonaws.support#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the AWS resource was ignored by Trusted Advisor because it was\n marked as suppressed by the user.

" + "smithy.api#documentation": "

Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was\n marked as suppressed by the user.

" } }, "metadata": { @@ -1792,34 +1792,34 @@ "resourcesProcessed": { "target": "com.amazonaws.support#Long", "traits": { - "smithy.api#documentation": "

The number of AWS resources that were analyzed by the Trusted Advisor check.

", + "smithy.api#documentation": "

The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.

", "smithy.api#required": {} } }, "resourcesFlagged": { "target": "com.amazonaws.support#Long", "traits": { - "smithy.api#documentation": "

The number of AWS resources that were flagged (listed) by the Trusted Advisor\n check.

", + "smithy.api#documentation": "

The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor\n check.

", "smithy.api#required": {} } }, "resourcesIgnored": { "target": "com.amazonaws.support#Long", "traits": { - "smithy.api#documentation": "

The number of AWS resources ignored by Trusted Advisor because information was\n unavailable.

", + "smithy.api#documentation": "

The number of Amazon Web Services resources ignored by Trusted Advisor because information was\n unavailable.

", "smithy.api#required": {} } }, "resourcesSuppressed": { "target": "com.amazonaws.support#Long", "traits": { - "smithy.api#documentation": "

The number of AWS resources ignored by Trusted Advisor because they were marked as\n suppressed by the user.

", + "smithy.api#documentation": "

The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as\n suppressed by the user.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

" + "smithy.api#documentation": "

Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

" } } } diff --git a/aws/sdk/aws-models/transfer.json b/aws/sdk/aws-models/transfer.json index 3fe954d1f9..68a4787dba 100644 --- a/aws/sdk/aws-models/transfer.json +++ b/aws/sdk/aws-models/transfer.json @@ -301,7 +301,7 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE 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 IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the LAMBDA 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 Function parameter for the IdentityProviderDetails data type.

" + "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE 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 IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the AWS_LAMBDA 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 Function parameter for the IdentityProviderDetails data type.

" } }, "LoggingRole": { @@ -316,6 +316,12 @@ "smithy.api#documentation": "

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:

\n\n
    \n
  • \n

    \n SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH

    \n
  • \n
  • \n

    \n FTPS (File Transfer Protocol Secure): File transfer with TLS\n encryption

    \n
  • \n
  • \n

    \n FTP (File Transfer Protocol): Unencrypted file transfer

    \n
  • \n
\n\n \n

If you select FTPS, 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.

\n\n

If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

\n\n

If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

\n\n

If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

\n
" } }, + "ProtocolDetails": { + "target": "com.amazonaws.transfer#ProtocolDetails", + "traits": { + "smithy.api#documentation": "

The protocol settings that are configured for your server.

\n

\n Use the PassiveIp 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

\n

Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.

" + } + }, "SecurityPolicyName": { "target": "com.amazonaws.transfer#SecurityPolicyName", "traits": { @@ -427,7 +433,7 @@ "SshPublicKeyBody": { "target": "com.amazonaws.transfer#SshPublicKeyBody", "traits": { - "smithy.api#documentation": "

The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.

" + "smithy.api#documentation": "

The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.

\n \n

\n Currently, Transfer Family does not accept elliptical curve keys (keys beginning with ecdsa).\n

\n
" } }, "Tags": { @@ -1370,7 +1376,7 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE 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 IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the LAMBDA 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 Function parameter for the IdentityProviderDetails data type.

" + "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE 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 IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the AWS_LAMBDA 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 Function parameter for the IdentityProviderDetails data type.

" } }, "LoggingRole": { @@ -1925,7 +1931,7 @@ "DirectoryId": { "target": "com.amazonaws.transfer#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.

" + "smithy.api#documentation": "

The identifier of the Amazon Web Services Directory Service directory that you want to stop sharing.

" } }, "Function": { @@ -2738,7 +2744,7 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE 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 IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the LAMBDA 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 Function parameter for the IdentityProviderDetails data type.

" + "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE 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 IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the AWS_LAMBDA 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 Function parameter for the IdentityProviderDetails data type.

" } }, "EndpointType": { @@ -3057,10 +3063,16 @@ "traits": { "smithy.api#documentation": "

\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

\n

\n \n aws transfer update-server --protocol-details PassiveIp=0.0.0.0\n \n

\n

Replace \n 0.0.0.0\n in the example above with the actual IP address you want to use.

\n \n

\n If you change the PassiveIp 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 Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family.\n

\n
" } + }, + "TlsSessionResumptionMode": { + "target": "com.amazonaws.transfer#TlsSessionResumptionMode", + "traits": { + "smithy.api#documentation": "

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. TlsSessionResumptionMode determines whether or not the server resumes recent,\n negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls.\n If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.

\n
    \n
  • \n

    \n DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.

    \n
  • \n
  • \n

    \n ENABLED: 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.

    \n
  • \n
  • \n

    \n ENFORCED: 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 ENFORCED, test your clients.

    \n \n

    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 ENFORCED value, you need to test your clients.

    \n
    \n
  • \n
" + } } }, "traits": { - "smithy.api#documentation": "

\n The protocol settings that are configured for your server.\n

\n \n

\n This type is only valid in the UpdateServer API.\n

\n
" + "smithy.api#documentation": "

\n The protocol settings that are configured for your server.\n

" } }, "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": "

\n The protocol settings that are configured for your server.\n

\n

\n Use the PassiveIp 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

" + "smithy.api#documentation": "

\n The protocol settings that are configured for your server.\n

\n

\n Use the PassiveIp 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

\n

Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.

" } }, "EndpointDetails": { diff --git a/aws/sdk/aws-models/workmail.json b/aws/sdk/aws-models/workmail.json index 95afd2ab4b..607f451dea 100644 --- a/aws/sdk/aws-models/workmail.json +++ b/aws/sdk/aws-models/workmail.json @@ -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": "

Deletes the email monitoring configuration for a specified organization.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DeleteEmailMonitoringConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The ID of the organization from which the email monitoring configuration is deleted.

", + "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": "

Describes the current email monitoring configuration for a specified organization.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DescribeEmailMonitoringConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The ID of the organization for which the email monitoring configuration is described.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DescribeEmailMonitoringConfigurationResponse": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.workmail#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.

" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.workmail#LogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.

" + } + } + } + }, "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": "

Creates or updates the email monitoring configuration for a specified organization.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#PutEmailMonitoringConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "

The ID of the organization for which the email monitoring configuration is set.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.workmail#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.

", + "smithy.api#required": {} + } + }, + "LogGroupArn": { + "target": "com.amazonaws.workmail#LogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.

", + "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": "

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.

\n

The WorkMail API is designed for the following scenarios:

\n
    \n
  • \n

    Listing and describing organizations

    \n
  • \n
\n
    \n
  • \n

    Managing users

    \n
  • \n
\n
    \n
  • \n

    Managing groups

    \n
  • \n
\n
    \n
  • \n

    Managing resources

    \n
  • \n
\n

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.

", + "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": "

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.

\n

The WorkMail API is designed for the following scenarios:

\n
    \n
  • \n

    Listing and describing organizations

    \n
  • \n
\n
    \n
  • \n

    Managing users

    \n
  • \n
\n
    \n
  • \n

    Managing groups

    \n
  • \n
\n
    \n
  • \n

    Managing resources

    \n
  • \n
\n

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.

", - "smithy.api#title": "Amazon WorkMail" - } + ] } } } diff --git a/gradle.properties b/gradle.properties index 19246507c3..25d0b6e5ab 100644 --- a/gradle.properties +++ b/gradle.properties @@ -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